younifyd
Menu

Get A Custom API Role Policy

Get a Custom API Role Policy

GET/v2/permissions/custom-api-role-policies/{custom-api-role-policy-id}

Use it in a workflow

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

Request

Path parameters

custom-api-role-policy-idstringrequired

The ID of the Custom API Role Policy.

Response

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

dataobject
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
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"
        }
      }
    }
  }
}

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