Function UserApiFp

Returns {
    userControllerAssignRole(id: string, roleId: string, userRoleAssignChangeDTO?: UserRoleAssignChangeDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>;
    userControllerCreate(userCreateInputDTO?: UserCreateInputDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>;
    userControllerDeleteSelectedDomainCookie(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    userControllerGetOne(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>;
    userControllerInvite(inviteCreateDTO?: InviteCreateDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>;
    userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    userControllerLogin(loginDTO?: LoginDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginOutputDTOAPI>)>;
    userControllerLogout(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>;
    userControllerMe(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeOutoutDTOAPI>)>;
    userControllerRemove(id: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>;
    userControllerRemoveRole(id: string, roleId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>;
    userControllerSearch(userSearchInputDTO?: UserSearchInputDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputArrayDTOAPI>)>;
    userControllerSetSelectedDomain(domainId: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    userControllerUpdate(id: string, userUpdateDTO?: UserUpdateDTO, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>;
}

• userControllerAssignRole:function

  • userControllerAssignRole(id, roleId, userRoleAssignChangeDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

  • Required permissions: MANAGE_USERS, MANAGE_ROLES

    Parameters

    • id: string
    • roleId: string
    • OptionaluserRoleAssignChangeDTO: UserRoleAssignChangeDTO

      UserRoleAssignChangeDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

    Summary

    Assign role

    Throws

• userControllerCreate:function

  • userControllerCreate(userCreateInputDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

  • Required permissions: MANAGE_USERS

    Parameters

    • OptionaluserCreateInputDTO: UserCreateInputDTO

      UserCreateInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

    Summary

    Create

    Throws

• userControllerDeleteSelectedDomainCookie:function

  • userControllerDeleteSelectedDomainCookie(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Unset the selected domain for the user, this will clear the domain cookie. On the next request, the backend will set this again.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Unset the selected domain for the user

    Throws

• userControllerGetOne:function

  • userControllerGetOne(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

  • Required permissions: READ_USERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

    Summary

    Get one

    Throws

• userControllerInvite:function

  • userControllerInvite(inviteCreateDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

  • Required permissions: MANAGE_USERS

    Parameters

    • OptionalinviteCreateDTO: InviteCreateDTO

      InviteCreateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

    Summary

    Invite

    Throws

• userControllerLinkPlayerProfile:function

  • userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Link your player profile to Takaro, allowing web access for things like shop and stats. To get the code, use the /link command in the game.

    Parameters

    • OptionallinkPlayerUnauthedInputDTO: LinkPlayerUnauthedInputDTO

      LinkPlayerUnauthedInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Link player profile

    Throws

• userControllerLogin:function

  • userControllerLogin(loginDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginOutputDTOAPI>)>

  • Parameters

    • OptionalloginDTO: LoginDTO

      LoginDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoginOutputDTOAPI>)>

    Summary

    Login

    Throws

• userControllerLogout:function

  • userControllerLogout(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

    Summary

    Logout

    Throws

• userControllerMe:function

  • userControllerMe(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeOutoutDTOAPI>)>

  • Get the current user and the domains that the user has access to. Note that you can only make requests in the scope of a single domain. In order to switch the domain, you need to use the domain selection endpoints

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<MeOutoutDTOAPI>)>

    Summary

    Get the current logged in user

    Throws

• userControllerRemove:function

  • userControllerRemove(id, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

  • Required permissions: MANAGE_USERS

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

    Summary

    Remove

    Throws

• userControllerRemoveRole:function

  • userControllerRemoveRole(id, roleId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

  • Required permissions: MANAGE_USERS, MANAGE_ROLES

    Parameters

    • id: string
    • roleId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>)>

    Summary

    Remove role

    Throws

• userControllerSearch:function

  • userControllerSearch(userSearchInputDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputArrayDTOAPI>)>

  • Required permissions: READ_USERS

    Parameters

    • OptionaluserSearchInputDTO: UserSearchInputDTO

      UserSearchInputDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputArrayDTOAPI>)>

    Summary

    Search

    Throws

• userControllerSetSelectedDomain:function

  • userControllerSetSelectedDomain(domainId, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • One user can have multiple domains, this endpoint is a helper to set the selected domain for the user

    Parameters

    • domainId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Set the selected domain for the user

    Throws

• userControllerUpdate:function

  • userControllerUpdate(id, userUpdateDTO?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

  • Required permissions: MANAGE_USERS

    Parameters

    • id: string
    • OptionaluserUpdateDTO: UserUpdateDTO

      UserUpdateDTO
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserOutputDTOAPI>)>

    Summary

    Update

    Throws