Sign in
roles

Get role by ID

Returns the requested role.

get/api/v1/roles/{id}

Path parameters

idId required— unresolved $ref

The unique identifier for the role.

Response

Request successfully completed.

idstring uid required

The unique identifier for the role.

namestring required

The name of the role.

type'default' | 'custom' required

The type of role.

level'admin' | 'user'

The level of access associated to the role.

canEditboolean

Indicate if role can be edited by tenant (Shown as Profile in MC)

fullUserboolean

DEPRECATED. Use userEntitlementType instead for impact of roles on user entitlements with a capacity-based subscription.

tenantIdstring uid required

The tenant unique identifier associated with the given Role.

canDeleteboolean

Indicate if role can be deleted

createdAtstring date-time required

The timestamp for when the role was created.

createdBystring

Id of user that created role

updatedBystring

Id of user that last updated this role

descriptionstring required

Descriptive text for the role.

permissionsstring[]

An array of permissions associated with the role.

lastUpdatedAtstring date-time required

The timestamp for when the role was last updated.

assignedScopesstring[]

Selection of scopes added to this Role

userEntitlementTypestring

Indicate whether this role will trigger promotion of a user from a basic to a full user on tenants with a capacity-based subscription. Does not apply to tenants with a user-based subscription. Returns fullUser if it will trigger promotion.

Example response

{
  "id": "507f191e810c19729de860ea",
  "name": "My Custom Role",
  "type": "custom",
  "level": "user",
  "links": {
    "self": {
      "href": "http://mytenant.us.qlikcloud.com/api/v1/roles/507f191e810c19729de860ea"
    }
  },
  "tenantId": "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f",
  "createdAt": "2021-03-21T17:32:28Z",
  "description": "Grants permission to edit resource 'foo'",
  "permissions": [
    "edit_foo"
  ],
  "lastUpdatedAt": "2021-03-22T10:01:02Z",
  "userEntitlementType": "fullUser"
}

Changes