Access Service | Equinix Product Documentation

Principal Policy

Operations for managing Principal Policies

Operations

List Principal Policies

Request

Allows an admin to list principal policies in a project with pagination. Access to this operation is controlled by the project. Includes disabled policies so admins can re-enable them.

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

Security

bearerAuth

Path

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

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

Payload

// No request payload

Responses

Success

Bodyapplication/json

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