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 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, options?): Promise<AxiosResponse<AuthenticationResult, any>>
Parameters
- requestParameters: UserApiAuthenticateUserByNameRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AuthenticationResult, any>>
Summary
Authenticates a user by name.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1157

authenticateWithQuickConnect

authenticateWithQuickConnect(requestParameters, options?): Promise<AxiosResponse<AuthenticationResult, any>>
Parameters
- requestParameters: UserApiAuthenticateWithQuickConnectRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AuthenticationResult, any>>
Summary
Authenticates a user with quick connect.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1169

createUserByName

createUserByName(requestParameters, options?): Promise<AxiosResponse<UserDto, any>>
Parameters
- requestParameters: UserApiCreateUserByNameRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto, any>>
Summary
Creates a user.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1181

deleteUser

deleteUser(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UserApiDeleteUserRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes a user.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1193

forgotPassword

forgotPassword(requestParameters, options?): Promise<AxiosResponse<ForgotPasswordResult, any>>
Parameters
- requestParameters: UserApiForgotPasswordRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ForgotPasswordResult, any>>
Summary
Initiates the forgot password process for a local user.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1205

forgotPasswordPin

forgotPasswordPin(requestParameters, options?): Promise<AxiosResponse<PinRedeemResult, any>>
Parameters
- requestParameters: UserApiForgotPasswordPinRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PinRedeemResult, any>>
Summary
Redeems a forgot password pin.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1217

getCurrentUser

getCurrentUser(options?): Promise<AxiosResponse<UserDto, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto, any>>
Summary
Gets the user based on auth token.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1228

getPublicUsers

getPublicUsers(options?): Promise<AxiosResponse<UserDto[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto[], any>>
Summary
Gets a list of publicly visible users for display on a login screen.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1239

getUserById

getUserById(requestParameters, options?): Promise<AxiosResponse<UserDto, any>>
Parameters
- requestParameters: UserApiGetUserByIdRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto, any>>
Summary
Gets a user by Id.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1251

getUsers

getUsers(requestParameters?, options?): Promise<AxiosResponse<UserDto[], any>>
Parameters
- requestParameters: UserApiGetUsersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserDto[], any>>
Summary
Gets a list of users.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1263

updateUser

updateUser(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UserApiUpdateUserRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a user.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1275

updateUserConfiguration

updateUserConfiguration(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UserApiUpdateUserConfigurationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a user configuration.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1287

updateUserPassword

updateUserPassword(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UserApiUpdateUserPasswordRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a user's password.

Throws
Memberof
UserApi
- Defined in generated-client/api/user-api.ts:1299

updateUserPolicy

updateUserPolicy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: UserApiUpdateUserPolicyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a user policy.

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, any>>

Summary

Throws

Memberof

authenticateWithQuickConnect

Parameters

Returns Promise<AxiosResponse<AuthenticationResult, any>>

Summary

Throws

Memberof

createUserByName

Parameters

Returns Promise<AxiosResponse<UserDto, any>>

Summary

Throws

Memberof

deleteUser

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

forgotPassword

Parameters

Returns Promise<AxiosResponse<ForgotPasswordResult, any>>

Summary

Throws

Memberof

forgotPasswordPin

Parameters

Returns Promise<AxiosResponse<PinRedeemResult, any>>

Summary

Throws

Memberof

getCurrentUser

Parameters

Returns Promise<AxiosResponse<UserDto, any>>

Summary

Throws

Memberof

getPublicUsers

Parameters

Returns Promise<AxiosResponse<UserDto[], any>>

Summary

Throws

Memberof

getUserById

Parameters

Returns Promise<AxiosResponse<UserDto, any>>

Summary

Throws

Memberof

getUsers

Parameters

Returns Promise<AxiosResponse<UserDto[], any>>

Summary

Throws

Memberof

updateUser

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration