Roles

Retrieve organization role

Changed on

Retrieves an organization role.

get/organization/roles/{role_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/organization/roles/{role_id}
  • Auth
    HTTP bearer

Path parameters

role_idstring required

The ID of the role to retrieve.

Response

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

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d86203de41aeRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status