Access Service | Equinix Product Documentation

List Roles

Request

Get a page of all the Roles visible. All System and Product roles are visibile, but visibility of Custom Roles depend on the claims in the token. For an Access Policy token, all Custom Roles usable by the project are visible (if given, otherwise the project that owns the Access Policy). For a Role Assignment token, all Custom Roles usable by the token's Organization are visible and the project args are unsupported.

The auth token's access policy must allow action:use/listRoles.

Security

bearerAuth

Query

pageTokenstring, [ 1 .. 4096 ] characters(PageToken)

Opaque token identifying the page of results to retrieve.

Example:pageToken=eyJwYWdlIjoyfQ==

pageSizeinteger, [ 1 .. 1000 ](PageSize)

Maximum number of results to return per page.

Default:100

Example:pageSize=20

projectIdstring(ProjectId)^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-...

Globally unique identifier of a project. Mutually exclusive with projectErn.

Example:projectId=project:abc-123

projectErnstring(Ern)^ern:(?<cloud>[^:]{1,50}):(?<service>[^:/]{1,...

Equinix Resource Name of a project. Mutually exclusive with projectId.

Example:projectErn=ern:eqix:equinix/sts:global:abc-123:SomeType:res-id

Payload

// No request payload

Responses

Success

Bodyapplication/json

listArray of objects(RoleDetails)required

nextPageTokenstring, [ 1 .. 4096 ] characters(NextPageToken)

When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous call.

Example:"eyJsYXN0S2V5IjoiYWJjMTIzIn0="

Response

{
  "list": [
    { … }
  ],
  "nextPageToken": "eyJsYXN0S2V5IjoiYWJjMTIzIn0="
}