Roles

Update organization role

Updates an existing organization role.

post/organization/roles/{role_id}

Path parameters

role_idstring required

The ID of the role to update.

Request body

permissionsstring[] nullable

Updated set of permissions for the role.

descriptionstring nullable

New description for the role.

role_namestring nullable

New name for the role.

Response

Role updated 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

Changed in 4 of the 163 revisions of this API.6

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog