Sample - OpenAI API
GET/projects/{project_id}/users/{user_id}/roles/{role_id}

Retrieve a project user role

Retrieves a project role assigned to a specific user within a project. Supply project_id, user_id, and role_id to identify the role assignment to inspect.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 parameters
project_idstringrequired
The ID of the project to inspect.
user_idstringrequired
The ID of the user whose role assignment to inspect.
role_idstringrequired
The ID of the project role to retrieve for the user.

2 status codes
200Returns the project role assignment, including its identifier, name, permissions, resource type, predefined-role status, description, timestamps, creator information, metadata, and assignment sources.
idstringrequired
Identifier for the role.
namestringrequired
Name of the role.
permissionsarray<string>required
Permissions associated with the role.
resource_typestringrequired
Resource type the role applies to.
predefined_rolebooleanrequired
Whether the role is predefined by OpenAI.
descriptionstringrequired
Description of the role.
created_atintegerrequired
When the role was created.
updated_atintegerrequired
When the role was last updated.
created_bystringrequired
Identifier of the actor who created the role.
created_by_user_objobjectrequired
User details for the actor that created the role, when available.
metadataobjectrequired
Arbitrary metadata stored on the role.
assignment_sourcesarray<object>required
Principals from which the role assignment is inherited, when available.
429Returned when the request is rejected because the rate limit was exceeded.
errorobjectrequired

Error handling

A 429 is returned when the request exceeds the rate limit. Supply project_id, user_id, and role_id to identify the project, user, and assigned role.