role

Create a role

post/v1/org/{orgId}/role

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/role
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Request body

orgIdstring

parent organization id (empty if global)

labelstring required

human-readable full name of role

descriptionstring

description of role

policyIdsstring[]

the policies that define the role

Example request

{
  "orgId": "588f7ee98f138b19220041a7",
  "label": "Engineering People Manager",
  "description": "This role is able to create and update new job data for the engineering department.",
  "policyIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

role created

idstring required

globally unique id

orgIdstring

parent organization id (empty if global)

labelstring required

human-readable full name of role

descriptionstring

description of role

policyIdsstring[]

the policies that define the role

userCountinteger

number of users the role is attached to; populated when expand=true on the list endpoint

createIdstring

created by user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateAtstring

last updated timestamp

deleteIdstring

deleted by user id

deleteAtstring

deleted timestamp

Changes

No recorded changes to this operation across all 20 revisions of this API.