Class UserApi

UserApi - object-oriented interface

Export

UserApi

Hierarchy

BaseAPI
- UserApi

Index

Constructors

constructor

new UserApi(configuration?, basePath?, axios?): UserApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns UserApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

userControllerAssignRole

userControllerAssignRole(id, roleId, userRoleAssignChangeDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_USERS, MANAGE_ROLES
Parameters
- id: string
- roleId: string
- OptionaluserRoleAssignChangeDTO: UserRoleAssignChangeDTO
  UserRoleAssignChangeDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Assign role

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22908

userControllerCreate

userControllerCreate(userCreateInputDTO?, options?): Promise<AxiosResponse<UserOutputDTOAPI, any>>
Required permissions: MANAGE_USERS
Parameters
- OptionaluserCreateInputDTO: UserCreateInputDTO
  UserCreateInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>
Summary
Create

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22927

userControllerDeleteSelectedDomainCookie

userControllerDeleteSelectedDomainCookie(options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>
Summary
Unset the selected domain for the user

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22940

userControllerGetOne

userControllerGetOne(id, options?): Promise<AxiosResponse<UserOutputDTOAPI, any>>
Required permissions: READ_USERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>
Summary
Get one

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22954

userControllerInvite

userControllerInvite(inviteCreateDTO?, options?): Promise<AxiosResponse<UserOutputDTOAPI, any>>
Required permissions: MANAGE_USERS
Parameters
- OptionalinviteCreateDTO: InviteCreateDTO
  InviteCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>
Summary
Invite

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22968

userControllerLinkPlayerProfile

userControllerLinkPlayerProfile(linkPlayerUnauthedInputDTO?, options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>
Summary
Link player profile

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22982

userControllerLogin

userControllerLogin(loginDTO?, options?): Promise<AxiosResponse<LoginOutputDTOAPI, any>>
Parameters
- OptionalloginDTO: LoginDTO
  LoginDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LoginOutputDTOAPI, any>>
Summary
Login

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:22999

userControllerLogout

userControllerLogout(options?): Promise<AxiosResponse<APIOutput, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Logout

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23012

userControllerMe

userControllerMe(options?): Promise<AxiosResponse<MeOutoutDTOAPI, any>>
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<AxiosResponse<MeOutoutDTOAPI, any>>
Summary
Get the current logged in user

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23025

userControllerRemove

userControllerRemove(id, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_USERS
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23039

userControllerRemoveRole

userControllerRemoveRole(id, roleId, options?): Promise<AxiosResponse<APIOutput, any>>
Required permissions: MANAGE_USERS, MANAGE_ROLES
Parameters
- id: string
- roleId: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Remove role

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23054

userControllerSearch

userControllerSearch(userSearchInputDTO?, options?): Promise<AxiosResponse<UserOutputArrayDTOAPI, any>>
Required permissions: READ_USERS
Parameters
- OptionaluserSearchInputDTO: UserSearchInputDTO
  UserSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23068

userControllerSetSelectedDomain

userControllerSetSelectedDomain(domainId, options?): Promise<AxiosResponse<void, any>>
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<AxiosResponse<void, any>>
Summary
Set the selected domain for the user

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23082

userControllerUpdate

userControllerUpdate(id, userUpdateDTO?, options?): Promise<AxiosResponse<UserOutputDTOAPI, any>>
Required permissions: MANAGE_USERS
Parameters
- id: string
- OptionaluserUpdateDTO: UserUpdateDTO
  UserUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>
Summary
Update

Throws
Memberof
UserApi
- Defined in packages/lib-apiclient/src/generated/api.ts:23097

Class UserApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

userControllerAssignRole

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

userControllerCreate

Parameters

Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>

Summary

Throws

Memberof

userControllerDeleteSelectedDomainCookie

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

userControllerGetOne

Parameters

Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>

Summary

Throws

Memberof

userControllerInvite

Parameters

Returns Promise<AxiosResponse<UserOutputDTOAPI, any>>

Summary

Throws

Memberof

userControllerLinkPlayerProfile

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

userControllerLogin

Parameters

Returns Promise<AxiosResponse<LoginOutputDTOAPI, any>>

Summary

Throws

Memberof

userControllerLogout

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

userControllerMe

Parameters

Returns Promise<AxiosResponse<MeOutoutDTOAPI, any>>

Summary

Throws

Memberof

userControllerRemove

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

Throws

Memberof

userControllerRemoveRole

Parameters

Returns Promise<AxiosResponse<APIOutput, any>>

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration