OpenAI API (unofficial showcase)
GET/projects/{project_id}/groups/{group_id}/roles/{role_id}

Retrieve a project group role

Retrieves a role assigned to a group within a project. Use the project, group, and role identifiers to locate the assignment and inspect its permissions and assignment details.

3 parameters
project_idstringrequired
The ID of the project to inspect.
group_idstringrequired
The ID of the group to inspect.
role_idstringrequired
The ID of the project role to retrieve for the group.

5 status codes
200Returns details about the role assignment, including its identifier, name, permissions, resource type, predefined status, and available creation, update, metadata, and assignment-source details.
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.
400Returned when the request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403Returned when you do not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
404Returned when the endpoint is unavailable or a requested resource is not found in the organization or project.
errorobjectrequired
429Returned when the request is rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 400 is returned when the request parameters are invalid or the operation cannot be performed, and a 403 is returned when you lack permission. A 404 is returned when the endpoint is unavailable or a requested resource is not found; a 429 is returned when the rate limit is exceeded. The project_id path parameter, group_id path parameter, and role_id path parameter must identify the project, group, and role assignment to retrieve.