Added identity providers —
Check the API reference
LogoLogo
Other APIsChangelog
  • Welcome to Provisioning API
  • Getting started
    • API specification
    • Authorization
    • Applications
  • API reference
    • API credentials
      • The API credential object
      • Create an API credential
      • List all API credentials
      • Retrieve an API credential
      • Update an API credential
      • Delete an API credential
    • Application memberships
      • The application membership object
      • Create an application membership
      • List all application memberships
      • Retrieve an application membership
      • Update an application membership
      • Delete an application membership
    • Identity providers
      • The identity provider object
      • Create an identity provider
      • List all identity providers
      • Retrieve an identity provider
      • Update an identity provider
      • Delete an identity provider
    • Memberships
      • The membership object
      • Create a membership
      • List all memberships
      • Retrieve a membership
      • Update a membership
      • Delete a membership
    • Membership profiles
      • The membership profile object
      • Create a membership profile
      • List all membership profiles
      • Retrieve a membership profile
      • Update a membership profile
      • Delete a membership profile
    • Organizations
      • The organization object
      • Create an organization
      • List all organizations
      • Retrieve an organization
      • Update an organization
    • Permissions
      • The permission object
      • Create a permission
      • List all permissions
      • Retrieve a permission
      • Update a permission
    • Roles
      • The role object
      • Create a role
      • List all roles
      • Retrieve a role
      • Update a role
    • User
      • The user object
      • Retrieve the user
      • Update the user
    • Versions
      • The version object
      • List all versions
      • Retrieve a version
On this page
  • Request
  • Arguments
  • Example
  1. API reference
  2. Permissions

Update a permission

How to update an existing permission via API

To update an existing permission, send a PATCH request to the /api/permissions/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://provisioning.commercelayer.io/api/permissions/:id

Arguments

Body Parameter
Type
Required

type

string

Required

id

string

Required

attributes.can_create

boolean

Optional

attributes.can_read

boolean

Optional

attributes.can_update

boolean

Optional

attributes.can_destroy

boolean

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

Example

The following request updates the permission identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://provisioning.commercelayer.io/api/permissions/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "permissions",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    }
  }
}'

On success, the API responds with a 200 OK status code, returning the updated 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"
        }
      }
    }
  }
}
PreviousRetrieve a permissionNextRoles

Last updated 8 months ago