younifyd
Menu

List Custom API Role Policies

List Custom API Role Policies

GET/v2/permissions/custom-api-role-policies

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Custom API Role Policies action (under Permissions).
  3. Fill in the fields below, then reference the result from later steps as {{listCustomApiRolePolicies.response.data}}.

Request

Query parameters

page[offset]integer (int64)

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.

page[limit]integer (int64)

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used.

filterstring (string)

Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.

sortstring

Specifies the order in which Custom API Role Policies will be returned.

One ofid-idcreated_at-created_atupdated_at-updated_at

Response

Returns 200 with an object. Read it in later steps with {{listCustomApiRolePolicies.response.data.<field>}}.

dataarray<object>
idstring (uuid)

The unique identifier for the Custom API Role Policy.

typestring

Specifies the type of the resource object, use `custom_api_role_policy` for Custom API Role Policies.

createboolean

Specifies if the Role can create a Custom API Entry.

listboolean

Specifies if the Role can retrieve a list of Custom API Entries.

readboolean

Specifies if the Role can get a Custom API Entry.

updateboolean

Specifies if the Role can update a Custom API Entry.

deleteboolean

Specifies if the Role can delete a Custom API Entry.

linksobject1 fields
metaobject1 fields
relationshipsobject2 fields
metaobject
resultsobject1 fields
pageobject4 fields
linksobject
currentstring | null
firststring | null
laststring | null
nextstring | null
prevstring | null
json
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "create": false,
      "list": false,
      "read": false,
      "update": false,
      "delete": false,
      "links": {
        "self": "string"
      },
      "meta": {
        "timestamps": {
          "created_at": "2017-01-10T11:41:19.244Z",
          "updated_at": "2017-01-10T11:41:19.244Z"
        }
      },
      "relationships": {
        "custom_api": {
          "data": {
            "id": "652e39d8-d613-493e-8c20-fef99ad6327a",
            "type": "string"
          }
        },
        "role": {
          "data": {
            "id": "it-developer",
            "type": "standard_user_role"
          }
        }
      }
    }
  ],
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.