Takaro - v0.6.0
    Preparing search index...

    Class UserApi

    UserApi - object-oriented interface

    UserApi

    Hierarchy

    • BaseAPI
      • UserApi
    Index

    Constructors

    constructor

    Properties

    axios basePath configuration

    Methods

    userControllerAssignRole userControllerCreate userControllerDeleteSelectedDomainCookie userControllerGetOne userControllerInvite userControllerLinkPlayerProfile userControllerLogin userControllerLogout userControllerMe userControllerRemove userControllerRemoveRole userControllerSearch userControllerSetSelectedDomain userControllerUpdate

    Constructors

    • Parameters

      • Optionalconfiguration: Configuration
      • basePath: string = BASE_PATH
      • axios: AxiosInstance = globalAxios

      Returns UserApi

    Properties

    axios: AxiosInstance = globalAxios
    basePath: string = BASE_PATH
    configuration: Configuration | undefined

    Methods

    • 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 Promise<AxiosResponse<void, any>>

      UserApi

    • 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 Promise<AxiosResponse<void, any>>

      UserApi

    • 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 Promise<AxiosResponse<MeOutoutDTOAPI, any>>

      UserApi

    • Required permissions: MANAGE_USERS, MANAGE_ROLES
      OperationId: UserControllerRemoveRole

      Parameters

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

        Override http request option.

      Returns Promise<AxiosResponse<APIOutput, any>>

      UserApi

    • 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 Promise<AxiosResponse<void, any>>

      UserApi

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods