Get a Custom API Role Policy

GET 
https://useast.api.elasticpath.com/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

iduuid

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 Built-in Role can create a Custom API Entry.

listboolean

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

readboolean

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

updateboolean

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

deleteboolean

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

links object

selfuri

Specifies the URI of the Built-In Role.

Example: /v2/permissions/custom-api-role-policies/3fa85f64-5717-4562-b3fc-2c963f66afa6

meta object

timestamps objectrequired

updated_atstringrequired

Specifies the date the entity is created.

Example: 2017-01-10T11:41:19.244Z

created_atstringrequired

Specifies the date the entity is last updated.

Example: 2017-01-10T11:41:19.244Z

relationships object

custom_api objectrequired

data objectrequired

idstringrequired

The unique identifier for the related Custom API.

Example: 652e39d8-d613-493e-8c20-fef99ad6327a

typestringrequired

Specifies the type of the resource object.

role objectrequired

data objectrequired

idstringrequired

The unique identifier for the related Built-In Role.

Example: f5f77dd6-71df-48a4-b4f4-d2605a79f3ca

typestringrequired

Specifies the type of the resource object.

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/permissions/custom-api-role-policies/:custom_api_role_policy_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

custom_api_role_policy_id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!