Access Service | Equinix Product Documentation

List Resource Types

Request

Allows a user to page through the resource types defined for a given serviceId. This allows users to discover what resource types are available to be used when defining access policies. Access to this is operation is controlled by the project specified by projectId. When the service mask that applies to the project does not allow any access to the service an exception is thrown.

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

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

serviceIdstring(ServiceId)^service:[a-zA-Z][a-zA-Z0-9]{0,49}/[a-zA-Z][a...required

Fully qualified, universally unique id of a service.

Example:serviceId=service:equinix/sts

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

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(ResourceType)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="
}