OpenAI API (unofficial showcase)
POST/organization/groups/{group_id}/roles

Assign organization role to group

Assigns an organization role to a group within the organization.

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

1 parameter · 1 body field
group_idstringrequired
The ID of the group that should receive the organization role.

Identifies the organization role to assign to the group.

role_idstringrequired
Identifier of the role to assign.

5 status codes
200Organization role assigned to the group successfully.
objectstringrequired
Always `group.role`.
Allowed:group.role
groupobjectrequired
Summary information about a group returned in role assignment responses.
roleobjectrequired
Details about a role that can be assigned through the public Roles API.
400The request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403The caller does not have permission to perform this operation.
errorobjectrequired
Details about the permission error.
404The endpoint is unavailable or a requested resource was not found in this organization or project.
errorobjectrequired
429The request was rejected because a rate limit was exceeded.
errorobjectrequired

Error handling

A 400 is returned: The request parameters are invalid or the requested operation cannot be performed. A 403 is returned: The caller does not have permission to perform this operation. A 404 is returned: The endpoint is unavailable or a requested resource was not found in this organization or project. A 429 is returned: The request was rejected because a rate limit was exceeded.