Permissions ​

Permissions are assigned to Policies, and control data access throughout the platform. Learn more about Permissions.

The Permission Object ​

id uuid
Primary key of the permission rule.

policy many-to-one
Policy this permission applies to. Many-to-one to policies.

collection string
Collection this permission rule applies to.

action string
What CRUD operation this permission rule applies to. One of create, read, update, delete.

permissions object
What custom permission rules the item must pass before users with the policy are allowed to operate on it. Follows the Filter Rules spec.

validation object
What rules the provided values must pass before users with the policy are allowed to submit them for insertion/update. Follows the Filter Rules spec.

presets object
Additional default values for the item that are applied by users with the policy.

fields array
What fields the user is allowed to alter.

{
	"id": 34,
	"policy": "c86c2761-65d3-43c3-897f-6f74ad6a5bd7",
	"collection": "pages",
	"action": "create",
	"permissions": null,
	"validation": {
		"title": {
			"_contains": "Directus"
		}
	},
	"presets": {
		"published": false
	},
	"fields": ["title", "translations"]
}

{
	"id": 34,
	"policy": "c86c2761-65d3-43c3-897f-6f74ad6a5bd7",
	"collection": "pages",
	"action": "create",
	"permissions": null,
	"validation": {
		"title": {
			"_contains": "Directus"
		}
	},
	"presets": {
		"published": false
	},
	"fields": ["title", "translations"]
}

List Permissions ​

List all permissions that exist in Directus.

Request ​

Query Parameters ​

Supports all global query parameters.

Response ​

An array of up to limit permission objects. If no items are available, data will be an empty array.

Example ​

Retrieve a Permission ​

List an existing permission by primary key.

Request ​

Query Parameters ​

Supports all global query parameters.

Response ​

Returns the requested permission object.

Example ​

Create a Permission Rule ​

Create a new permission rule

Request ​

Query Parameters ​

Supports all global query parameters.

Request Body ​

A partial permissions object. action and collection are required.

Response ​

Returns the permission object for the created permission.

Example ​

Create Multiple Permission Rules ​

Create multiple new permission rules

Request ​

Query Parameters ​

Supports all global query parameters.

Request Body ​

An array of partial permissions objects. action and collection are required.

Response ​

Returns the permission objects for the created permissions.

Example ​

Update Permissions ​

Update an existing permissions rule.

Request ​

Query Parameters ​

Supports all global query parameters.

Request Body ​

A partial permissions object.

Response ​

Returns the permission object for the updated permission.

Example ​

Update Multiple Permissions ​

Update multiple existing permissions rules.

Request ​

Query Parameters ​

Supports all global query parameters.

Request Body ​

keys Required
Array of primary keys of the permissions you'd like to update.

data Required
Any of the permission object's properties.

Returns ​

Returns the permission object for the updated permissions.

Example ​

Delete Permissions ​

Delete an existing permissions rule

Request ​

Response ​

Empty body.

Example ​

Delete Multiple Permissions ​

Delete multiple existing permissions rules

Request ​

Request Body ​

An array of permission primary keys

Response ​

Empty body.

Example ​

Get Current User Permissions ​

Check the current user's permissions across all collections.

Request ​

Response ​

The response is an object that contains one entry for every collection with at least one permission. Each collection has entries corresponding to the actions the user is able to perform on the collection.

The access property indicates the level of access the user has for an action for a collection. "none" means the user has no access, "partial" means the user has access to some items, but may not have access to all items, and "full" means the user has access to all items.

{
  "data": {
    "<collection>": {
      "create": {
        "access": "none" | "partial" | "full",
        "fields": permission_fields,
        "presets": permission_presets
      },
      "read": {
        "access": "none" | "partial" | "full",
        "full_access": boolean,
        "fields": permission_fields,
      },
      "update": {
        "access": "none" | "partial" | "full",
        "full_access": boolean,
        "fields": permission_fields,
        "presets": permission_presets
      },
      "delete": {
        "access": "none" | "partial" | "full",
        "full_access": boolean
      },
      "share": {
        "access": "none" | "partial" | "full",
        "full_access": boolean
      }
    }
  }
}

{
  "data": {
    "<collection>": {
      "create": {
        "access": "none" | "partial" | "full",
        "fields": permission_fields,
        "presets": permission_presets
      },
      "read": {
        "access": "none" | "partial" | "full",
        "full_access": boolean,
        "fields": permission_fields,
      },
      "update": {
        "access": "none" | "partial" | "full",
        "full_access": boolean,
        "fields": permission_fields,
        "presets": permission_presets
      },
      "delete": {
        "access": "none" | "partial" | "full",
        "full_access": boolean
      },
      "share": {
        "access": "none" | "partial" | "full",
        "full_access": boolean
      }
    }
  }
}

Example ​

Check Permissions for a Specific Item ​

Check the current user's permissions on a specific item.

Request ​

Response ​

{
	"data": {
		"update": {
			"access": boolean
		},
		"delete": {
			"access": boolean
		},
		"share": {
			"access": boolean
		}
	}
}

{
	"data": {
		"update": {
			"access": boolean
		},
		"delete": {
			"access": boolean
		},
		"share": {
			"access": boolean
		}
	}
}

For a Singleton where update access is given, the presets and fields properties from the corresponding update permission are additionally returned:

{
	"data": {
		"update": {
			"access": true,
			"presets": permission_presets,
			"fields": permission_fields
		},
		"delete": {
			"access": boolean
		},
		"share": {
			"access": boolean
		}
	}
}

{
	"data": {
		"update": {
			"access": true,
			"presets": permission_presets,
			"fields": permission_fields
		},
		"delete": {
			"access": boolean
		},
		"share": {
			"access": boolean
		}
	}
}

Example ​