Create a role

How to create a role via API

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

Request

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

Arguments

Body Parameter	Type	Required
type	string	Required
attributes.name	string	Required
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.organization	object	Required

Example

Request

The following request creates a new role:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/roles' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "roles",
    "attributes": {
      "name": "Custom role"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

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

{
  "data": {
    "id": "xYZkjABcde",
    "type": "roles",
    "links": {
      "self": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde"
    },
    "attributes": {
      "name": "Custom role",
      "kind": "custom",
      "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/roles/xYZkjABcde/relationships/organization",
          "related": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/organization"
        }
      },
      "permissions": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/relationships/permissions",
          "related": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/permissions"
        }
      },
      "memberships": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/relationships/memberships",
          "related": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/memberships"
        }
      },
      "api_credentials": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/relationships/api_credentials",
          "related": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/api_credentials"
        }
      },
      "versions": {
        "links": {
          "self": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/relationships/versions",
          "related": "https://provisioning.commercelayer.io/api/roles/xYZkjABcde/versions"
        }
      }
    }
  }
}