UserRoles Types

Type Aliases

APIInterface

type APIInterface = object;

Defined in: recipe/userroles/types.ts:43

RecipeInterface

type RecipeInterface = object;

Defined in: recipe/userroles/types.ts:45

Properties

Property	Type	Defined in
addRoleToUser	(input) => Promise< | { didUserAlreadyHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>	recipe/userroles/types.ts:46
createNewRoleOrAddPermissions	(input) => Promise<{ createdNewRole: boolean; status: "OK"; }>	recipe/userroles/types.ts:81
deleteRole	(input) => Promise<{ didRoleExist: boolean; status: "OK"; }>	recipe/userroles/types.ts:109
getAllRoles	(input) => Promise<{ roles: string[]; status: "OK"; }>	recipe/userroles/types.ts:114
getPermissionsForRole	(input) => Promise< | { permissions: string[]; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>	recipe/userroles/types.ts:90
getRolesForUser	(input) => Promise<{ roles: string[]; status: "OK"; }>	recipe/userroles/types.ts:66
getRolesThatHavePermission	(input) => Promise<{ roles: string[]; status: "OK"; }>	recipe/userroles/types.ts:104
getUsersThatHaveRole	(input) => Promise< | { status: "OK"; users: string[]; } | { status: "UNKNOWN_ROLE_ERROR"; }>	recipe/userroles/types.ts:71
removePermissionsFromRole	(input) => Promise<{ status: "OK" | "UNKNOWN_ROLE_ERROR"; }>	recipe/userroles/types.ts:100
removeUserRole	(input) => Promise< | { didUserHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>	recipe/userroles/types.ts:56

TypeInput

type TypeInput = object;

Defined in: recipe/userroles/types.ts:19

Properties

Property	Type	Defined in
override?	object	recipe/userroles/types.ts:22
override.apis?	(originalImplementation, builder) => APIInterface	recipe/userroles/types.ts:27
override.functions?	(originalImplementation, builder) => RecipeInterface	recipe/userroles/types.ts:23
skipAddingPermissionsToAccessToken?	boolean	recipe/userroles/types.ts:21
skipAddingRolesToAccessToken?	boolean	recipe/userroles/types.ts:20

TypeNormalisedInput

type TypeNormalisedInput = object;

Defined in: recipe/userroles/types.ts:31

Properties

Property	Type	Defined in
override	object	recipe/userroles/types.ts:34
override.apis	(originalImplementation, builder) => APIInterface	recipe/userroles/types.ts:39
override.functions	(originalImplementation, builder) => RecipeInterface	recipe/userroles/types.ts:35
skipAddingPermissionsToAccessToken	boolean	recipe/userroles/types.ts:33
skipAddingRolesToAccessToken	boolean	recipe/userroles/types.ts:32