Options
All
  • Public
  • Public/Protected
  • All
Menu

These are the SDK reference docs. If you’re looking for docs to implement SuperTokens, you might want to check out the User Guides

Module recipe/userroles

Index

Classes

Type aliases

Variables

Functions

Type aliases

RecipeInterface

RecipeInterface: { addRoleToUser: any; createNewRoleOrAddPermissions: any; deleteRole: any; getAllRoles: any; getPermissionsForRole: any; getRolesForUser: any; getRolesThatHavePermission: any; getUsersThatHaveRole: any; removePermissionsFromRole: any; removeUserRole: any }

Type declaration

  • addRoleToUser:function
    • addRoleToUser(input: { role: string; userContext: any; userId: string }): Promise<{ didUserAlreadyHaveRole: boolean; status: "OK" } | { status: "UNKNOWN_ROLE_ERROR" }>

    • Parameters

      • input: { role: string; userContext: any; userId: string }
        • role: string
        • userContext: any
        • userId: string

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

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

    • Parameters

      • input: { permissions: string[]; role: string; userContext: any }
        • permissions: string[]
        • role: string
        • userContext: any

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

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

    • Parameters

      • input: { role: string; userContext: any }
        • role: string
        • userContext: any

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

  • getAllRoles:function
    • getAllRoles(input: { userContext: any }): Promise<{ roles: string[]; status: "OK" }>
  • getPermissionsForRole:function
    • getPermissionsForRole(input: { role: string; userContext: any }): Promise<{ permissions: string[]; status: "OK" } | { status: "UNKNOWN_ROLE_ERROR" }>

    • Parameters

      • input: { role: string; userContext: any }
        • role: string
        • userContext: any

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

  • getRolesForUser:function
    • getRolesForUser(input: { userContext: any; userId: string }): Promise<{ roles: string[]; status: "OK" }>

    • Parameters

      • input: { userContext: any; userId: string }
        • userContext: any
        • userId: string

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

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

    • Parameters

      • input: { permission: string; userContext: any }
        • permission: string
        • userContext: any

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

  • getUsersThatHaveRole:function
    • getUsersThatHaveRole(input: { role: string; userContext: any }): Promise<{ status: "OK"; users: string[] } | { status: "UNKNOWN_ROLE_ERROR" }>

    • Parameters

      • input: { role: string; userContext: any }
        • role: string
        • userContext: any

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

  • removePermissionsFromRole:function
    • removePermissionsFromRole(input: { permissions: string[]; role: string; userContext: any }): Promise<{ status: "OK" | "UNKNOWN_ROLE_ERROR" }>

    • Parameters

      • input: { permissions: string[]; role: string; userContext: any }
        • permissions: string[]
        • role: string
        • userContext: any

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

  • removeUserRole:function
    • removeUserRole(input: { role: string; userContext: any; userId: string }): Promise<{ didUserHaveRole: boolean; status: "OK" } | { status: "UNKNOWN_ROLE_ERROR" }>

    • Parameters

      • input: { role: string; userContext: any; userId: string }
        • role: string
        • userContext: any
        • userId: string

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

Variables

Const PermissionClaim

PermissionClaim: PermissionClaimClass = ...

Const UserRoleClaim

UserRoleClaim: UserRoleClaimClass = ...

Functions

addRoleToUser

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

  • Parameters

    • userId: string
    • role: string
    • Optional userContext: any

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

createNewRoleOrAddPermissions

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

deleteRole

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

getAllRoles

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

getPermissionsForRole

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

  • Parameters

    • role: string
    • Optional userContext: any

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

getRolesForUser

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

getRolesThatHavePermission

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

getUsersThatHaveRole

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

init

  • init(config?: TypeInput): RecipeListFunction

removePermissionsFromRole

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

removeUserRole

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

  • Parameters

    • userId: string
    • role: string
    • Optional userContext: any

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

Generated using TypeDoc