Skip to main content

Get a role​

Get the named role

Path Parameters
  • role_name string required

    Possible values: <= 100 characters, Value must match regular expression ^[A-Za-z0-9]{1}[\w.\-:]*[A-Za-z0-9]$

    The name of a role. Role name should be URL encoded (so for example: 3b0a8f7e-f26e-4a08-8dae-4d5360a72003%2Frole_name).

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Response Headers
  • ETagHeader string

    An ETag header. Can be passed as an If-Match header in a subsequent request to avoid lost updates.

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • errors object[]
  • httpcode integer
  • message string
  • result object
  • name string

    Possible values: <= 100 characters, Value must match regular expression ^[A-Za-z0-9]{1}[\w.\-:]*[A-Za-z0-9]$

    The Role name must be unique within your organization; is case-sensitive; and must conform to the following:

    • must be at least 2 characters long
    • may be at most 100 characters long
    • may contain only the characters A-Z a-z 0-9 - _ . :
    • must start and end with an alphanumeric character (A-Z a-z 0-9)

    Roles needs to have their name prefixed with {org_id}/. Organization ID is not counted to the length limit.

  • description string
  • created date-time
  • permissions string[]

    Possible values: <= 1024 characters, Value must match regular expression ^[A-Za-z0-9]{1}[\w./\\\-:]*[A-Za-z0-9]$