Sign in
Roles

Retrieve project role

Retrieves a project role.

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

Path parameters

project_idstring required

The ID of the project.

role_idstring required

The ID of the role to retrieve.

Response

Project role retrieved successfully.

object'role' required

Always role.

idstring required

Identifier for the role.

namestring required

Unique name for the role.

descriptionstring nullable required

Optional description of the role.

permissionsstring[] required

Permissions granted by the role.

resource_typestring required

Resource type the role is bound to (for example api.organization or api.project).

predefined_roleboolean required

Whether the role is predefined and managed by OpenAI.

Changes

Changed in 1 of the 31 revisions of this API.1