supertokens-node/recipe/userroles/types
References documentation for the supertokens-node/recipe/userroles/types package
Type Aliases
APIInterface
type APIInterface = object;Defined in: recipe/userroles/types.ts
RecipeInterface
type RecipeInterface = object;Defined in: recipe/userroles/types.ts
Properties
| Property | Type | Defined in |
|---|---|---|
addRoleToUser |
(input) => Promise< | { didUserAlreadyHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }> |
recipe/userroles/types.ts |
createNewRoleOrAddPermissions |
(input) => Promise<{ createdNewRole: boolean; status: "OK"; }> |
recipe/userroles/types.ts |
deleteRole |
(input) => Promise<{ didRoleExist: boolean; status: "OK"; }> |
recipe/userroles/types.ts |
getAllRoles |
(input) => Promise<{ roles: string[]; status: "OK"; }> |
recipe/userroles/types.ts |
getPermissionsForRole |
(input) => Promise< | { permissions: string[]; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }> |
recipe/userroles/types.ts |
getRolesForUser |
(input) => Promise<{ roles: string[]; status: "OK"; }> |
recipe/userroles/types.ts |
getRolesThatHavePermission |
(input) => Promise<{ roles: string[]; status: "OK"; }> |
recipe/userroles/types.ts |
getUsersThatHaveRole |
(input) => Promise< | { status: "OK"; users: string[]; } | { status: "UNKNOWN_ROLE_ERROR"; }> |
recipe/userroles/types.ts |
removePermissionsFromRole |
(input) => Promise<{ status: "OK" | "UNKNOWN_ROLE_ERROR"; }> |
recipe/userroles/types.ts |
removeUserRole |
(input) => Promise< | { didUserHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }> |
recipe/userroles/types.ts |
TypeInput
type TypeInput = object;Defined in: recipe/userroles/types.ts
Properties
| Property | Type | Defined in |
|---|---|---|
override? |
object |
recipe/userroles/types.ts |
override.apis? |
(originalImplementation, builder) => APIInterface |
recipe/userroles/types.ts |
override.functions? |
(originalImplementation, builder) => RecipeInterface |
recipe/userroles/types.ts |
skipAddingPermissionsToAccessToken? |
boolean |
recipe/userroles/types.ts |
skipAddingRolesToAccessToken? |
boolean |
recipe/userroles/types.ts |
TypeNormalisedInput
type TypeNormalisedInput = object;Defined in: recipe/userroles/types.ts
Properties
| Property | Type | Defined in |
|---|---|---|
override |
object |
recipe/userroles/types.ts |
override.apis |
(originalImplementation, builder) => APIInterface |
recipe/userroles/types.ts |
override.functions |
(originalImplementation, builder) => RecipeInterface |
recipe/userroles/types.ts |
skipAddingPermissionsToAccessToken |
boolean |
recipe/userroles/types.ts |
skipAddingRolesToAccessToken |
boolean |
recipe/userroles/types.ts |