Access Service | Equinix Product Documentation

List Policy Masks

Allows a user to list project-scoped policy masks with pagination. Authorization is checked against the project.

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

Security

bearerAuth

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

Globally unique identifier of a project. Callers may URL encode this value.

Example:project:abc-123

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

Payload

// No request payload

Success

Bodyapplication/json

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