Sign in

v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB
Permissions

Update a Permission

Update an existing permission

patch/permissions/{id}

Path parameters

idinteger required

Index

Query parameters

metastring

What metadata to return in the response.

Request body

collectionobject

What collection this permission applies to.

comment'none' | 'create' | 'update'

If the user can post comments. full.

create'none' | 'full'

If the user can create items.

delete'none' | 'mine' | 'role' | 'full'

If the user can update items.

explain'none' | 'create' | 'update' | 'always'

If the user is required to leave a comment explaining what was changed.

read'none' | 'mine' | 'role' | 'full'

If the user can read items.

read_field_blacklistobject

Explicitly denies read access for specific fields.

roleobject

Unique identifier of the role this permission applies to.

statusobject

What status this permission applies to.

status_blacklistobject

Explicitly denies specific statuses to be used.

update'none' | 'mine' | 'role' | 'full'

If the user can update items.

write_field_blacklistobject

Explicitly denies write access for specific fields.

Response

Successful request

Example response

{
  "data": {
    "id": 1,
    "collection": "customers",
    "action": "create"
  }
}