Function UserApiFactory

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

• userControllerAssignRole: function

  • userControllerAssignRole(
        id: string,
        roleId: string,
        userRoleAssignChangeDTO?: UserRoleAssignChangeDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_USERS, MANAGE_ROLES
    OperationId: UserControllerAssignRole

    Parameters

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

      UserRoleAssignChangeDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• userControllerCreate: function

  • userControllerCreate(
        userCreateInputDTO?: UserCreateInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UserOutputDTOAPI>

    Required permissions: MANAGE_USERS
    OperationId: UserControllerCreate

    Parameters

    • OptionaluserCreateInputDTO: UserCreateInputDTO

      UserCreateInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserOutputDTOAPI>

    Throws

• userControllerDeleteSelectedDomainCookie: function

  • userControllerDeleteSelectedDomainCookie(
        options?: RawAxiosRequestConfig,
    ): 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.
    OperationId: UserControllerDeleteSelectedDomainCookie

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• userControllerGetOne: function

  • userControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UserOutputDTOAPI>

    Required permissions: READ_USERS
    OperationId: UserControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserOutputDTOAPI>

    Throws

• userControllerInvite: function

  • userControllerInvite(
        inviteCreateDTO?: InviteCreateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UserOutputDTOAPI>

    Required permissions: MANAGE_USERS
    OperationId: UserControllerInvite

    Parameters

    • OptionalinviteCreateDTO: InviteCreateDTO

      InviteCreateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserOutputDTOAPI>

    Throws

• userControllerLinkPlayerProfile: function

  • userControllerLinkPlayerProfile(
        linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO,
        options?: RawAxiosRequestConfig,
    ): 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.
    OperationId: UserControllerLinkPlayerProfile

    Parameters

    • OptionallinkPlayerUnauthedInputDTO: LinkPlayerUnauthedInputDTO

      LinkPlayerUnauthedInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• userControllerLogin: function

  • userControllerLogin(
        loginDTO?: LoginDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LoginOutputDTOAPI>

    
    OperationId: UserControllerLogin

    Parameters

    • OptionalloginDTO: LoginDTO

      LoginDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LoginOutputDTOAPI>

    Throws

• userControllerLogout: function

  • userControllerLogout(options?: RawAxiosRequestConfig): AxiosPromise<APIOutput>

    
    OperationId: UserControllerLogout

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• userControllerMe: function

  • userControllerMe(options?: RawAxiosRequestConfig): 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
    OperationId: UserControllerMe

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MeOutoutDTOAPI>

    Throws

• userControllerRemove: function

  • userControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_USERS
    OperationId: UserControllerRemove

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• userControllerRemoveRole: function

  • userControllerRemoveRole(
        id: string,
        roleId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_USERS, MANAGE_ROLES
    OperationId: UserControllerRemoveRole

    Parameters

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

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• userControllerSearch: function

  • userControllerSearch(
        userSearchInputDTO?: UserSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UserOutputArrayDTOAPI>

    Required permissions: READ_USERS
    OperationId: UserControllerSearch

    Parameters

    • OptionaluserSearchInputDTO: UserSearchInputDTO

      UserSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserOutputArrayDTOAPI>

    Throws

• userControllerSetSelectedDomain: function

  • userControllerSetSelectedDomain(
        domainId: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

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

    Parameters

    • domainId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• userControllerUpdate: function

  • userControllerUpdate(
        id: string,
        userUpdateDTO?: UserUpdateDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UserOutputDTOAPI>

    Required permissions: MANAGE_USERS
    OperationId: UserControllerUpdate

    Parameters

    • id: string
    • OptionaluserUpdateDTO: UserUpdateDTO

      UserUpdateDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserOutputDTOAPI>

    Throws