Organization
Role

Create a new role in the organization

Changed on

Create a new role and assign it to the organization.

post/v1/organizations/{organizationRef}/roles

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/organizations/{organizationRef}/roles
  • 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

keystring

Stable role template key.

namestring required

Name of the role.

descriptionstring

Description of the role.

actionsAction[]

Actions bundled by this role.

Example request

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

Response

Example response

idstring required

ID of the newly created resource.

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