Access Service | Equinix Product Documentation

List Grants

Request

Allows a user to page through the external grants of an access policy including a managed policy. Access to this operation is controlled by the access policy being accessed.

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

Security

bearerAuth

Path

projectIdProjectId (string) or * (string)required

One of:

Globally unique identifier of a project.

string(ProjectId)

accessPolicyId(AccessPolicyId (string) or ManagedPolicyId (string)) or Ern (string)required

One of:

Callers may URL encode this value. When passing an ERN, callers must URL encode this value.

One of:

Uniquely identifies an access policy within a project.

string(AccessPolicyId)

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:500

Example:pageSize=20

Payload

// No request payload

Responses

Success

Bodyapplication/json

listArray of objects(AccessPolicyGrant)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="
}