Class default

constructor

• new default(): default

  Returns default

Staticinit

StaticPermissionClaim

StaticUserRoleClaim

StaticaddRoleToUser

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

  Parameters

  • tenantId: string
  • userId: string
  • role: string
  • OptionaluserContext: Record<string, any>

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

StaticcreateNewRoleOrAddPermissions

• createNewRoleOrAddPermissions(
      role: string,
      permissions: string[],
      userContext?: Record<string, any>,
  ): Promise<{ createdNewRole: boolean; status: "OK" }>

  Parameters

  • role: string
  • permissions: string[]
  • OptionaluserContext: Record<string, any>

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

StaticdeleteRole

• deleteRole(
      role: string,
      userContext?: Record<string, any>,
  ): Promise<{ didRoleExist: boolean; status: "OK" }>

  Parameters

  • role: string
  • OptionaluserContext: Record<string, any>

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

StaticgetAllRoles

• getAllRoles(
      userContext?: Record<string, any>,
  ): Promise<{ roles: string[]; status: "OK" }>

  Parameters

  • OptionaluserContext: Record<string, any>

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

StaticgetPermissionsForRole

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

  Parameters

  • role: string
  • OptionaluserContext: Record<string, any>

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

StaticgetRolesForUser

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

  Parameters

  • tenantId: string
  • userId: string
  • OptionaluserContext: Record<string, any>

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

StaticgetRolesThatHavePermission

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

  Parameters

  • permission: string
  • OptionaluserContext: Record<string, any>

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

StaticgetUsersThatHaveRole

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

  Parameters

  • tenantId: string
  • role: string
  • OptionaluserContext: Record<string, any>

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

StaticremovePermissionsFromRole

• removePermissionsFromRole(
      role: string,
      permissions: string[],
      userContext?: Record<string, any>,
  ): Promise<{ status: "OK" | "UNKNOWN_ROLE_ERROR" }>

  Parameters

  • role: string
  • permissions: string[]
  • OptionaluserContext: Record<string, any>

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

StaticremoveUserRole

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

  Parameters

  • tenantId: string
  • userId: string
  • role: string
  • OptionaluserContext: Record<string, any>

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