Class: AuthApi

clients/platform-client/src.AuthApi

AuthApi - object-oriented interface

Export

Extends

• BaseAPI

Constructors

new AuthApi(configuration, basePath, axios)

new AuthApi(configuration?, basePath?, axios?): AuthApi

Parameters

▪ configuration?: Configuration

▪ basePath?: string= BASE_PATH

▪ axios?: AxiosInstance= globalAxios

Returns

AuthApi

Inherited from

BaseAPI.constructor

Source

libs/clients/platform-client/src/lib/generated/base.ts:53

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Source

libs/clients/platform-client/src/lib/generated/base.ts:53

---

basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Source

libs/clients/platform-client/src/lib/generated/base.ts:53

---

configuration

protected configuration: Configuration

Inherited from

BaseAPI.configuration

Source

libs/clients/platform-client/src/lib/generated/base.ts:51

Methods

authControllerApproveSignup

authControllerApproveSignup(ApproveSignUpRequest, options?): Promise<AxiosResponse<void, any>>

Parameters

▪ ApproveSignUpRequest: ApproveSignUpRequest

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

AuthApi

Source

libs/clients/platform-client/src/lib/generated/api.ts:1233

---

authControllerSamlAcknowledge

authControllerSamlAcknowledge(options?): Promise<AxiosResponse<void, any>>

Parameters

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

AuthApi

Source

libs/clients/platform-client/src/lib/generated/api.ts:1243

---

authControllerSamlLogin

authControllerSamlLogin(redirectUrl, tenantId, options?): Promise<AxiosResponse<void, any>>

Parameters

▪ redirectUrl: string

▪ tenantId: string

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

AuthApi

Source

libs/clients/platform-client/src/lib/generated/api.ts:1255

---

authControllerSignIn

authControllerSignIn(SignInRequest, options?): Promise<AxiosResponse<void, any>>

Parameters

▪ SignInRequest: SignInRequest

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

AuthApi

Source

libs/clients/platform-client/src/lib/generated/api.ts:1266

---

authControllerSignUp

authControllerSignUp(CreateUserRequest, options?): Promise<AxiosResponse<void, any>>

Parameters

▪ CreateUserRequest: CreateUserRequest

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

AuthApi

Source

libs/clients/platform-client/src/lib/generated/api.ts:1277

---

samlControllerSamlMetadata

samlControllerSamlMetadata(options?): Promise<AxiosResponse<void, any>>

Parameters

▪ options?: AxiosRequestConfig<any>

Override http request option.

Returns

Promise<AxiosResponse<void, any>>

Throws

Memberof

AuthApi

Source

libs/clients/platform-client/src/lib/generated/api.ts:1287

---

Generated using typedoc-plugin-markdown and TypeDoc