Get a Custom API Role Policy

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

Get a Custom API Role Policy

Request

Path Parameters

custom_api_role_policy_id stringrequired
The ID of the Custom API Role Policy.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

200

OK

application/json

Schema

Schema

data object

id uuid

The unique identifier for the Custom API Role Policy.

type string

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

create boolean

Specifies if the Built-in Role can create a Custom API Entry.

list boolean

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

read boolean

Specifies if the Built-in Role can get a Custom API Entry.

update boolean

Specifies if the Built-in Role can update a Custom API Entry.

delete boolean

Specifies if the Built-in Role can delete a Custom API Entry.

links object

self uri

Specifies the URI of the Built-In Role.

meta object

timestamps objectrequired

updated_at stringrequired

Specifies the date the entity is created.

created_at stringrequired

Specifies the date the entity is last updated.

relationships object

custom_api objectrequired

data objectrequired

id stringrequired

The unique identifier for the related Custom API.

type stringrequired

Specifies the type of the resource object.

role objectrequired

data objectrequired

id stringrequired

The unique identifier for the related Built-In Role.

type stringrequired

Specifies the type of the resource object.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "string",
    "create": true,
    "list": true,
    "read": true,
    "update": true,
    "delete": true,
    "links": {
      "self": "/v2/permissions/custom-api-role-policies/3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "meta": {
      "timestamps": {
        "updated_at": "2017-01-10T11:41:19.244Z",
        "created_at": "2017-01-10T11:41:19.244Z"
      }
    },
    "relationships": {
      "custom_api": {
        "data": {
          "id": "652e39d8-d613-493e-8c20-fef99ad6327a",
          "type": "string"
        }
      },
      "role": {
        "data": {
          "id": "f5f77dd6-71df-48a4-b4f4-d2605a79f3ca",
          "type": "string"
        }
      }
    }
  }
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

not-found

Requested entity not found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "Not found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...