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 attributes.reference_origin
Example
Request Response
The following request updates the permission identified by the ID "xYZkjABcde":
Copy 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:
Copy {
"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"
}
}
}
}
}
Last updated 4 months ago