AeontelAeontel Docs

Permissions hooks

Hand-written shim. Generated CRUD hooks via ./permissions.gen. useGrantPermission + useRevokePermission stay hand-written.

Hooks

useGrantPermission composite

TypeScript
useGrantPermission(options?: MutationOpts<Permission, GrantPermissionParams>)

Types: Permission · GrantPermissionParams

useListPermissions query

List permissions.

TypeScript
useListPermissions(params?: Omit<ListPermissionsParams, | > & { filter?: PermissionFilter; orderBy?: PermissionOrderBy[]; } & PermissionShorthands, options?: QueryOpts<Page<Permission>>)

Types: ListPermissionsParams · PermissionFilter · PermissionOrderBy · PermissionShorthands · Page · Permission

usePurgePermission composite

Permanently delete a revoked permission.

TypeScript
usePurgePermission(options?: MutationOpts<SuccessResponse, PurgePermissionParams>)

Types: SuccessResponse · PurgePermissionParams

useRestorePermission composite

Restore a soft-deleted permission.

TypeScript
useRestorePermission(options?: MutationOpts<Permission, string>)

Types: Permission

useRetrievePermission query

Get a permission by ID.

TypeScript
useRetrievePermission(id: string, options?: QueryOpts<Permission>)

Types: Permission

useRevokePermission composite

TypeScript
useRevokePermission(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useUpdatePermission mutation

Update a permission.

TypeScript
useUpdatePermission(options?: MutationOpts<Permission, UpdatePermissionParams>)

Types: Permission · UpdatePermissionParams