organization_roles

Create a role in an organization

Creates a role with its permission list. The name must be unique within the organization (error 1205) and every permission must be a valid organization permission (error 1201).

Access: the caller needs either the client-level permission client_organization_roles:create or the organization-level permission organization_roles:create. Every endpoint under this organization also requires the client plan to allow at least 2 users (error 511 otherwise).

post/organizations/{id_organization}/roles

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/roles
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Request body

namestring required

Role name. Must be unique inside the organization.

permissionsstring[] required

Complete list of organization permissions granted by this role.

Response

Successful operation

Changes

No recorded changes to this operation across all 1 revision of this API.