@or-sdk/permissions-lambda
v2.8.1
Published
Downloads
1,333
Readme
Installation:
$ npm i @or-sdk/permissions-lambdaUsage:
import { PermissionsLambda } from '@or-sdk/permissions-lambda'
import { PermissionsLambda } from '@or-sdk/permissions-lambda'
const permissionsLambda = new PermissionsLambda({
isLocal: false,
functionName: 'permissions-core-function-name'
});Additional API reference
Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
PermissionsLambda
| Method | Returns | Purpose |
|---|---|---|
| registerProduct(data: RegisterProductDto) | Promise<Permission[]> | Registers a new product with its permissions |
| registerService(data: RegisterServiceDto) | Promise<Permission[]> | Registers a new service with its permissions |
| getAllAvailablePermissions() | Promise<AvailablePermissionsResponse> | Gets all available permissions across all services |
| getByService(data: GetByServicePayload) | Promise<PermissionsByServiceResponse> | Gets user permissions for a specific service, pass accountId to apply account-level defaults |
| getAll(data: GetAllPayload) | Promise<AllPermissionsResponse> | Gets all permissions for a user across all services, pass accountId to apply account-level defaults |
| getByUserIdAndAccount(data: GetByAccountUserPayload) | Promise<UserPermissionsResponse> | Gets permissions for a specific user within an account |
| updateSingleUser(data: UpdateEntityDto) | Promise<AllPermissionsResponse> | Updates permissions for a SingleUser |
| updateMultiUser(data: UpdateEntityDto) | Promise<AllPermissionsResponse> | Updates permissions for a MultiUser |
| checkScope(scope: string[]) | Promise<boolean> | Checks if user has the specified permission scopes |
| getApiTokenPermissionsForService(data: GetApiTokenByServicePayload) | Promise<PermissionsByServiceResponse> | Gets permissions for an API token for a specific service |
| getApiTokenPermissions(data: GetApiTokenPayload) | Promise<ApiTokenPermissionsResponse> | Gets all permissions for an API token |
| getBulkApiTokenPermissions(data: GetBulkApiTokenPayload) | Promise<BulkApiTokenPermissionsResponse> | Gets permissions for multiple API tokens |
| setApiTokenPermissions(data: SetApiTokenPermissionsPayload) | Promise<ApiTokenPermissionsResponse> | Sets permissions for an API token |
| deleteApiTokenPermissions(tokenId: string) | Promise<{ success: boolean }> | Deletes all permissions for an API token |
| getFlowPermissionsForProduct(data: GetFlowByProductPayload) | Promise<FlowProductPermissionsResponse> | Gets permissions for a flow for a specific product |
