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
type	string	permissions
id	string	The permission unique identifier.
links.self	string	The permission endpoint URL.
attributes.can_create	boolean	Determines if the permission have access to create rights.
attributes.can_read	boolean	Determines if the permission have access to read rights.
attributes.can_update	boolean	Determines if the permission have access to update rights.
attributes.can_destroy	boolean	Determines if the permission have access to destroy rights.
attributes.subject	string	The resource where this permission is applied.
attributes.restrictions	object	An object that contains additional restrictions.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	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.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	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.organization	object	The organization associated to the permission.
relationships.role	object	The role associated to the permission.
relationships.versions	array	The associated changes.