Sign in

v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB
Permissions

Create a Permission

Create a new permission.

post/permissions

Query parameters

metastring

What metadata to return in the response.

Request body

collectionstring

What collection this permission applies to.

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

If the user can post comments.

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.

roleinteger

Unique identifier of the role this permission applies to.

read_field_blackliststring[]

Explicitly denies read access for specific fields.

statusstring

What status this permission applies to.

status_blackliststring[]

Explicitly denies specific statuses to be used.

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

If the user can update items.

write_field_blackliststring[]

Explicitly denies write access for specific fields.

Example request

{
  "collection": "customers",
  "role": 3,
  "read_field_blacklist": [
    "featured_image"
  ]
}

Response

Successful request

Example response

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