Directus / @directus/sdk / rest / readPermission

Function: readPermission() ​

readPermission<Schema, TQuery>(key, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { action: string; collection: string; fields: (...) | (...); id: number; permissions: (...) | (...); policy: (...) | (...) | (...); presets: (...) | (...); validation: (...) | (...) }, "directus_permissions" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { action: ...; collection: ...; fields: ...; id: ...; permissions: ...; policy: ...; presets: ...; validation: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { action: string; collection: string; fields: (...) | (...); id: number; permissions: (...) | (...); policy: (...) | (...) | (...); presets: (...) | (...); validation: (...) | (...) }, "directus_permissions" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { action: ...; collection: ...; fields: ...; id: ...; permissions: ...; policy: ...; presets: ...; validation: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { action: ...; collection: ...; fields: ...; id: ...; permissions: ...; policy: ...; presets: ...; validation: ... }, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Defined in: rest/commands/read/permissions.ts:53

List all Permissions that exist in Directus.

Type Parameters ​

• Schema

• TQuery extends Query<Schema, DirectusPermission<Schema>>

Parameters ​

key ​

DirectusPermission<Schema>["id"]

The primary key of the permission

query? ​

TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { action: string; collection: string; fields: (...) | (...); id: number; permissions: (...) | (...); policy: (...) | (...) | (...); presets: (...) | (...); validation: (...) | (...) }, "directus_permissions" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { action: ...; collection: ...; fields: ...; id: ...; permissions: ...; policy: ...; presets: ...; validation: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { action: string; collection: string; fields: (...) | (...); id: number; permissions: (...) | (...); policy: (...) | (...) | (...); presets: (...) | (...); validation: (...) | (...) }, "directus_permissions" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { action: ...; collection: ...; fields: ...; id: ...; permissions: ...; policy: ...; presets: ...; validation: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { action: ...; collection: ...; fields: ...; id: ...; permissions: ...; policy: ...; presets: ...; validation: ... }, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Returns a Permission object if a valid primary key was provided.

Throws ​

Will throw if key is empty