@reactor/auth — permissionsclient
@reactor/auth / PermissionsClient
Class: PermissionsClient
Section titled “Class: PermissionsClient”Defined in: permissions.ts:13
Permissions client for checking user permissions.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PermissionsClient(
ctx):PermissionsClient
Defined in: permissions.ts:14
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”PermissionsClient
Methods
Section titled “Methods”check()
Section titled “check()”check(
permissions,options?):Promise<Result<{allowed:boolean;missing?:string[]; }>>
Defined in: permissions.ts:36
Check if the current user has specific permissions. Returns true if all requested permissions are granted.
Parameters
Section titled “Parameters”permissions
Section titled “permissions”string[]
options?
Section titled “options?”string
Returns
Section titled “Returns”Promise<Result<{ allowed: boolean; missing?: string[]; }>>
get(
options?):Promise<Result<PermissionsResponse>>
Defined in: permissions.ts:20
Get all permissions for the current user. Optionally scoped to a specific organization.
Parameters
Section titled “Parameters”options?
Section titled “options?”string
Returns
Section titled “Returns”Promise<Result<PermissionsResponse>>
resolveContext()
Section titled “resolveContext()”resolveContext():
Promise<Result<{org?: {id:string;role_id:string;slug:string; }; }>>
Defined in: permissions.ts:54
Resolve the current organization context. Returns the organization determined by the X-Reactor-Org header or default.
Returns
Section titled “Returns”Promise<Result<{ org?: { id: string; role_id: string; slug: string; }; }>>