Project group role assignments

Retrieve project group role

Retrieves a project role assigned to a group.

get/projects/{project_id}/groups/{group_id}/roles/{role_id}

Request

Base URL
https://api.openai.com/v1
URL
https://api.openai.com/v1/projects/{project_id}/groups/{group_id}/roles/{role_id}
Auth
HTTP bearer

project_idstring required

The ID of the project to inspect.

group_idstring required

The ID of the group to inspect.

role_idstring required

The ID of the project role to retrieve for the group.

Project role retrieved for the group successfully.

idstring required

Identifier for the role.

namestring required

Name of the role.

permissionsstring[] required

Permissions associated with the role.

resource_typestring required

Resource type the role applies to.

predefined_roleboolean required

Whether the role is predefined by OpenAI.

descriptionstring nullable required

Description of the role.

created_atinteger nullable required

When the role was created.

updated_atinteger nullable required

When the role was last updated.

created_bystring nullable required

Identifier of the actor who created the role.

created_by_user_objobject nullable required

User details for the actor that created the role, when available.

metadataobject nullable required

Arbitrary metadata stored on the role.