Roles

Update organization role

Changed on

Updates an existing organization role.

post/organization/roles/{role_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/organization/roles/{role_id}
  • Auth
    HTTP bearer

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

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status