Create a permission

How to create a permission via API

To create a new permission, send a POST request to the /api/permissions endpoint, passing the resource arguments in the request body.

Request

POST https://provisioning.commercelayer.io/api/permissions

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.can_create	boolean	Required
attributes.can_read	boolean	Required
attributes.can_update	boolean	Required
attributes.can_destroy	boolean	Required
attributes.subject	string	Required
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.role	object	Required

Example

Request

The following request creates a new permission:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/permissions' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "permissions",
    "attributes": {
      "can_create": false,
      "can_read": false,
      "can_update": false,
      "can_destroy": false,
      "subject": ""
    },
    "relationships": {
      "role": {
        "data": {
          "type": "roles",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 201 Created status code, returning the created resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "permissions",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde"
    },
    "attributes": {
      "can_create": false,
      "can_read": false,
      "can_update": false,
      "can_destroy": false,
      "subject": "",
      "restrictions": {
        "foo": "bar"
      },
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "organization": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde/relationships/organization",
          "related": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde/organization"
        }
      },
      "role": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde/relationships/role",
          "related": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde/role"
        }
      },
      "versions": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde/relationships/versions",
          "related": "https://provisioning.commercelayer.io/api/permissions/xYZkjABcde/versions"
        }
      }
    }
  }
}