Organization
Role

Update organization role

Changed on

Update the organization role by its ID.

patch/v1/organizations/{organizationRef}/roles/{role_id}

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/roles/{role_id}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: organization, role)

Request body

namestring

Name of the role.

descriptionstring nullable

Description of the role.

actionsAction[]

Actions bundled by this role. Empty array clears actions.

Example request

{
  "name": "Contributors",
  "description": "Users who can collaborate on the project."
}

Response

OK

idstring required

Unique identifier of the role.

keystring required

Stable role template key.

namestring required

Name of the role.

descriptionstring nullable

Description of the role.

member_countinteger nullable

Number of users assigned to the role when projected.

actionsAction[] required

Actions bundled by this role.

created_atstring date-time required

Date when the role was created.

updated_atstring date-time nullable required

Date when the role was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "key": "org-member",
  "name": "Collaborators",
  "description": "Users who can collaborate on the project.",
  "member_count": 4
}

Changes

  • 8a34c0b5508eRevision changes
    • info

      added the non-success 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 optional property to the response with the status

    • info

      added the optional property to the response with the status