The permission object
A comprehensive list of the permission resource's attributes and relationships
A permission object is returned as part of the response body of each successful create, list, retrieve or update API call to the /api/permissions
endpoint.
Fields
Field | Type | Description |
---|---|---|
|
|
|
|
| The permission unique identifier. |
links. |
| The permission endpoint URL. |
attributes. |
| Determines if the permission have access to create rights. |
attributes. |
| Determines if the permission have access to read rights. |
attributes. |
| Determines if the permission have access to update rights. |
attributes. |
| Determines if the permission have access to destroy rights. |
attributes. |
| The resource where this permission is applied. |
attributes. |
| An object that contains additional restrictions. |
attributes. |
| Time at which the resource was created. |
attributes. |
| Time at which the resource was last updated. |
attributes. |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes. |
| Any identifier of the third party system that defines the reference code. |
attributes. |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
relationships. |
| The organization associated to the permission. |
relationships. |
| The role associated to the permission. |
relationships. |
| The associated changes. |
Last updated