Takaro - v0.4.9
    Preparing search index...

    Function UserApiAxiosParamCreator

    • UserApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

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

      • userControllerAssignRole: (
            id: string,
            roleId: string,
            userRoleAssignChangeDTO?: UserRoleAssignChangeDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: MANAGE_USERS, MANAGE_ROLES
        OperationId: UserControllerAssignRole

      • userControllerCreate: (
            userCreateInputDTO?: UserCreateInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: MANAGE_USERS
        OperationId: UserControllerCreate

      • userControllerDeleteSelectedDomainCookie: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        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

      • userControllerGetOne: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Required permissions: READ_USERS
        OperationId: UserControllerGetOne

      • userControllerInvite: (
            inviteCreateDTO?: InviteCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: MANAGE_USERS
        OperationId: UserControllerInvite

      • userControllerLinkPlayerProfile: (
            linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        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

      • userControllerLogin: (loginDTO?: LoginDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>


        OperationId: UserControllerLogin

      • userControllerLogout: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>


        OperationId: UserControllerLogout

      • userControllerMe: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        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

      • userControllerRemove: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

        Required permissions: MANAGE_USERS
        OperationId: UserControllerRemove

      • userControllerRemoveRole: (
            id: string,
            roleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: MANAGE_USERS, MANAGE_ROLES
        OperationId: UserControllerRemoveRole

      • userControllerSearch: (
            userSearchInputDTO?: UserSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: READ_USERS
        OperationId: UserControllerSearch

      • userControllerSetSelectedDomain: (domainId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

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

      • userControllerUpdate: (
            id: string,
            userUpdateDTO?: UserUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: MANAGE_USERS
        OperationId: UserControllerUpdate