Get Role

Fetch a single role.

GET /v1/roles/{role}

Get Role

cURL

curl --request GET \
  --url https://iam.eu.confidence.dev/v1/roles/{role} \
  --header 'Authorization: Bearer <token>'

200

{
  "displayName": "<string>",
  "permissions": [
    {}
  ],
  "creator": "<string>",
  "updater": "<string>",
  "createTime": {},
  "updateTime": {},
  "name": "<string>",
  "builtin": true,
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

role · string · required

Response

200 - application/json

OK

A role is a named set of permissions, like Admin or Flag Editor.

displayName · string · required

Human friendly name of the role.

permissions · object[] · required

List of permissions that this role has, needs to have at least one.

creator · string · required

Reference to the identity that created this OAuthApp.

updater · string · required

Reference to the identity that last updated this OAuthApp.

createTime · object · required

Time when the role was first created.

updateTime · object · required

Time when the role was last updated.

name · string

Name of the role on the form roles/{"<"}id{">"}.

builtin · boolean

If this role is automatically built in or not

labels · object[]

General labels for this resource.

Show child attributes

owner · string

The owner of the resource. If not set will default to the creator.