Role object representation

The role object representation and fields are described below.

role was introduced in API version V1

role has not been marked for deprecation

Usages

• Permission Role

Description

A role in role based access control context which can be associated with various actors

Example create representation

{
  "name" : "ADMINISTRATORS",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "identities" : [ {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1"
  } ],
  "clients" : [ {
    "urn" : "3d059a42-2095-4d19-aea9-3243787e1ccd"
  } ]
}

Example response representation

{
  "urn" : "c0e320d9-0598-4fa5-b242-72bf5553f230",
  "name" : "ADMINISTRATORS",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "identities" : [ {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  } ],
  "clients" : [ {
    "urn" : "3d059a42-2095-4d19-aea9-3243787e1ccd"
  } ]
}

Fields