OpenAI API (unofficial showcase)
POST/organization/projects/{project_id}/groups

Grant a group access to a project

Grants a group access to a project with a specified project role. Supply the group ID and role identifier to create the group’s project membership.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
project_idstringrequired
The unique identifier of the project to grant group access to.

Identifies the group and project role to assign.

group_idstringrequired
Identifier of the group to add to the project.
rolestringrequired
Identifier of the project role to grant to the group.

6 status codes
200Returns the project group membership, including the project and group IDs, group name and type, and creation timestamp.
objectstringrequired
Always `project.group`.
Allowed:project.group
project_idstringrequired
Identifier of the project.
group_idstringrequired
Identifier of the group that has access to the project.
group_namestringrequired
Display name of the group.
group_typestringrequired
The type of the group.
Allowed:grouptenant_group
created_atintegerrequired
Unix timestamp (in seconds) when the group was granted project access.
400Returned when request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403Returned when the authenticated user does not have permission to grant a group access to the project.
errorobjectrequired
Details about the permission error.
404Returned when the endpoint is unavailable or a requested group, user, or project is not found.
errorobjectrequired
429Returned when the request exceeds a rate limit.
errorobjectrequired
500Returned when a server error prevents the group operation from completing.
errorobjectrequired

Error handling

A 400 is returned when request parameters are invalid or the operation cannot be performed, and a 403 is returned when the authenticated user lacks permission. group_id and role are required. A 404 is returned when the endpoint is unavailable or a requested group, user, or project is not found; a 429 is returned when a rate limit is exceeded; and a 500 is returned when a server error prevents the operation. The project_id path parameter must identify the project to update.