supertokens-node/recipe/userroles

References documentation for the supertokens-node/recipe/userroles package

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
`init`	`static`	(`config?`) => `RecipeListFunction`	`Recipe.init`	recipe/userroles/index.ts
`PermissionClaim`	`static`	`PermissionClaimClass`	`PermissionClaim`	recipe/userroles/index.ts
`UserRoleClaim`	`static`	`UserRoleClaimClass`	`UserRoleClaim`	recipe/userroles/index.ts

Methods

addRoleToUser()

static addRoleToUser(
   tenantId, 
   userId, 
   role, 
   userContext?): Promise<
  | {
  didUserAlreadyHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`userId`	`string`
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { didUserAlreadyHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>

createNewRoleOrAddPermissions()

static createNewRoleOrAddPermissions(
   role, 
   permissions, 
   userContext?): Promise<{
  createdNewRole: boolean;
  status: "OK";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`permissions`	`string`[]
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ createdNewRole: boolean; status: "OK"; }>

deleteRole()

static deleteRole(role, userContext?): Promise<{
  didRoleExist: boolean;
  status: "OK";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ didRoleExist: boolean; status: "OK"; }>

getAllRoles()

static getAllRoles(userContext?): Promise<{
  roles: string[];
  status: "OK";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ roles: string[]; status: "OK"; }>

getPermissionsForRole()

static getPermissionsForRole(role, userContext?): Promise<
  | {
  permissions: string[];
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { permissions: string[]; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>

getRolesForUser()

static getRolesForUser(
   tenantId, 
   userId, 
   userContext?): Promise<{
  roles: string[];
  status: "OK";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`userId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ roles: string[]; status: "OK"; }>

getRolesThatHavePermission()

static getRolesThatHavePermission(permission, userContext?): Promise<{
  roles: string[];
  status: "OK";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`permission`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ roles: string[]; status: "OK"; }>

getUsersThatHaveRole()

static getUsersThatHaveRole(
   tenantId, 
   role, 
   userContext?): Promise<
  | {
  status: "OK";
  users: string[];
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { status: "OK"; users: string[]; } | { status: "UNKNOWN_ROLE_ERROR"; }>

removePermissionsFromRole()

static removePermissionsFromRole(
   role, 
   permissions, 
   userContext?): Promise<{
  status: "OK" | "UNKNOWN_ROLE_ERROR";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`permissions`	`string`[]
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ status: "OK" | "UNKNOWN_ROLE_ERROR"; }>

removeUserRole()

static removeUserRole(
   tenantId, 
   userId, 
   role, 
   userContext?): Promise<
  | {
  didUserHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}>;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`userId`	`string`
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { didUserHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>

Variables

addRoleToUser()

const addRoleToUser: (tenantId, userId, role, userContext?) => Promise<
  | {
  didUserAlreadyHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.addRoleToUser;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`userId`	`string`
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { didUserAlreadyHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>

createNewRoleOrAddPermissions()

const createNewRoleOrAddPermissions: (role, permissions, userContext?) => Promise<{
  createdNewRole: boolean;
  status: "OK";
}> = Wrapper.createNewRoleOrAddPermissions;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`permissions`	`string`[]
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ createdNewRole: boolean; status: "OK"; }>

deleteRole()

const deleteRole: (role, userContext?) => Promise<{
  didRoleExist: boolean;
  status: "OK";
}> = Wrapper.deleteRole;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ didRoleExist: boolean; status: "OK"; }>

getAllRoles()

const getAllRoles: (userContext?) => Promise<{
  roles: string[];
  status: "OK";
}> = Wrapper.getAllRoles;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ roles: string[]; status: "OK"; }>

getPermissionsForRole()

const getPermissionsForRole: (role, userContext?) => Promise<
  | {
  permissions: string[];
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.getPermissionsForRole;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { permissions: string[]; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>

getRolesForUser()

const getRolesForUser: (tenantId, userId, userContext?) => Promise<{
  roles: string[];
  status: "OK";
}> = Wrapper.getRolesForUser;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`userId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ roles: string[]; status: "OK"; }>

getRolesThatHavePermission()

const getRolesThatHavePermission: (permission, userContext?) => Promise<{
  roles: string[];
  status: "OK";
}> = Wrapper.getRolesThatHavePermission;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`permission`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ roles: string[]; status: "OK"; }>

getUsersThatHaveRole()

const getUsersThatHaveRole: (tenantId, role, userContext?) => Promise<
  | {
  status: "OK";
  users: string[];
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.getUsersThatHaveRole;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { status: "OK"; users: string[]; } | { status: "UNKNOWN_ROLE_ERROR"; }>

init()

const init: (config?) => RecipeListFunction = Wrapper.init;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`config?`	`TypeInput`

Returns

RecipeListFunction

PermissionClaim

const PermissionClaim: PermissionClaimClass;

Defined in: recipe/userroles/permissionClaim.ts

removePermissionsFromRole()

const removePermissionsFromRole: (role, permissions, userContext?) => Promise<{
  status: "OK" | "UNKNOWN_ROLE_ERROR";
}> = Wrapper.removePermissionsFromRole;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`role`	`string`
`permissions`	`string`[]
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<{ status: "OK" | "UNKNOWN_ROLE_ERROR"; }>

removeUserRole()

const removeUserRole: (tenantId, userId, role, userContext?) => Promise<
  | {
  didUserHaveRole: boolean;
  status: "OK";
}
  | {
  status: "UNKNOWN_ROLE_ERROR";
}> = Wrapper.removeUserRole;

Defined in: recipe/userroles/index.ts

Parameters

Parameter	Type
`tenantId`	`string`
`userId`	`string`
`role`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise< | { didUserHaveRole: boolean; status: "OK"; } | { status: "UNKNOWN_ROLE_ERROR"; }>

UserRoleClaim

const UserRoleClaim: UserRoleClaimClass;

Defined in: recipe/userroles/userRoleClaim.ts

References

RecipeInterface

Re-exports RecipeInterface