role

Return a particular role by id

get/v1/org/{orgId}/role/{roleId}

Request

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

Path parameters

orgIdstring required

Org identifier (either id or slug)

roleIdstring required

Role id

Query parameters

expandboolean

(Optional) Expand the role's policies and full user list.

Response

successful operation

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 22 revisions of this API.