Create A Custom API Role Policy

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

Create A Custom API Role Policy

Request

application/json

Body

data CustomAPIRolePolicyAttributesrequired

type stringrequired

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

create booleanrequired

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

list booleanrequired

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

read booleanrequired

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

update booleanrequired

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

delete booleanrequired

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

relationships objectrequired

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.

Responses

201

Created

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

400

Bad request. The request failed validation.

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

missing-name

Required field missing

{
  "errors": [
    {
      "title": "Bad Request",
      "status": "400",
      "detail": "The field 'name' is required."
    }
  ]
}

409

Unable to perform the operation at this time.

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

duplicate-custom-api

Duplicate Custom API

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_api with the given api_type already exists"
    }
  ]
}

duplicate-custom-field

Duplicate Custom Field

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "custom_field with the given slug already exists"
    }
  ]
}

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...