Class UserApi

UserApi - object-oriented interface

Export

UserApi

Hierarchy

BaseAPI
- UserApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

authenticateUserByName

authenticateUserByName(
requestParameters: UserApiAuthenticateUserByNameRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AuthenticationResult>>
Parameters
- requestParameters: UserApiAuthenticateUserByNameRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AuthenticationResult>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1157

authenticateWithQuickConnect

authenticateWithQuickConnect(
requestParameters: UserApiAuthenticateWithQuickConnectRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<AuthenticationResult>>
Parameters
- requestParameters: UserApiAuthenticateWithQuickConnectRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AuthenticationResult>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1169

createUserByName

createUserByName(
requestParameters: UserApiCreateUserByNameRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserDto>>
Parameters
- requestParameters: UserApiCreateUserByNameRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1181

deleteUser

deleteUser(
requestParameters: UserApiDeleteUserRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: UserApiDeleteUserRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1193

forgotPassword

forgotPassword(
requestParameters: UserApiForgotPasswordRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ForgotPasswordResult>>
Parameters
- requestParameters: UserApiForgotPasswordRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ForgotPasswordResult>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1205

forgotPasswordPin

forgotPasswordPin(
requestParameters: UserApiForgotPasswordPinRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PinRedeemResult>>
Parameters
- requestParameters: UserApiForgotPasswordPinRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PinRedeemResult>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1217

getCurrentUser

getCurrentUser(options?: RawAxiosRequestConfig): Promise<AxiosResponse<UserDto>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1228

getPublicUsers

getPublicUsers(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserDto[]>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto[]>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1239

getUserById

getUserById(
requestParameters: UserApiGetUserByIdRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserDto>>
Parameters
- requestParameters: UserApiGetUserByIdRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1251

getUsers

getUsers(
requestParameters?: UserApiGetUsersRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UserDto[]>>
Parameters
- requestParameters: UserApiGetUsersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto[]>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1263

updateUser

updateUser(
requestParameters: UserApiUpdateUserRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: UserApiUpdateUserRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1275

updateUserConfiguration

updateUserConfiguration(
requestParameters: UserApiUpdateUserConfigurationRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: UserApiUpdateUserConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1287

updateUserPassword

updateUserPassword(
requestParameters: UserApiUpdateUserPasswordRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: UserApiUpdateUserPasswordRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1299

updateUserPolicy

updateUserPolicy(
requestParameters: UserApiUpdateUserPolicyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: UserApiUpdateUserPolicyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1311

Class UserApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UserApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

authenticateUserByName

Parameters

Returns Promise<AxiosResponse<AuthenticationResult>>

Throws

Memberof

authenticateWithQuickConnect

Parameters

Returns Promise<AxiosResponse<AuthenticationResult>>

Throws

Memberof

createUserByName

Parameters

Returns Promise<AxiosResponse<UserDto>>

Throws

Memberof

deleteUser

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

forgotPassword

Parameters

Returns Promise<AxiosResponse<ForgotPasswordResult>>

Throws

Memberof

forgotPasswordPin

Parameters

Returns Promise<AxiosResponse<PinRedeemResult>>

Throws

Memberof

getCurrentUser

Parameters

Returns Promise<AxiosResponse<UserDto>>

Throws

Memberof

getPublicUsers

Parameters

Returns Promise<AxiosResponse<UserDto[]>>

Throws

Memberof

getUserById

Parameters

Returns Promise<AxiosResponse<UserDto>>

Throws

Memberof

getUsers

Parameters

Returns Promise<AxiosResponse<UserDto[]>>

Throws

Memberof

updateUser

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

updateUserConfiguration

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

updateUserPassword

Parameters

Returns Promise<AxiosResponse<void>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration