Auth_api.CredentialApi.md

saasus-sdk / Auth/api / CredentialApi

Class: CredentialApi

Auth/api.CredentialApi

CredentialApi - object-oriented interface

Export

CredentialApi

Hierarchy

• BaseAPI

  ↳ CredentialApi

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• configuration

Methods

• createAuthCredentials
• getAuthCredentials

Constructors

constructor

• new CredentialApi(configuration?, basePath?, axios?): CredentialApi

Parameters

Name	Type	Default value
configuration?	Configuration	undefined
basePath	string	BASE_PATH
axios	AxiosInstance	globalAxios

Returns

CredentialApi

Inherited from

BaseAPI.constructor

Defined in

src/generated/Auth/base.ts:52

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios

Defined in

src/generated/Auth/base.ts:52

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath

Defined in

src/generated/Auth/base.ts:52

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/Auth/base.ts:50

Methods

createAuthCredentials

▸ createAuthCredentials(body?, options?): Promise<AxiosResponse<AuthorizationTempCode, any>>

Temporarily save the parameter for the ID token, access token, and refresh token and return a temporary code for obtaining. Temporary codes are valid for 10 seconds from issuance.

Parameters

Name	Type	Description
body?	Credentials
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<AuthorizationTempCode, any>>

Summary

Save Authentication/Authorization Information

Throws

Memberof

CredentialApi

Defined in

src/generated/Auth/api.ts:3699

---

getAuthCredentials

▸ getAuthCredentials(code?, authFlow?, refreshToken?, options?): Promise<AxiosResponse<Credentials, any>>

Get ID token, access token, and refresh token using a temporary code or a refresh token.

Parameters

Name	Type	Description
code?	string	Temp Code
authFlow?	"tempCodeAuth" | "refreshTokenAuth"	Authentication Flow tempCodeAuth: Getting authentication information using a temporary code refreshTokenAuth: Getting authentication information using a refresh token If not specified, it will be tempCodeAuth
refreshToken?	string	Refresh Token
options?	AxiosRequestConfig<any>	Override http request option.

Returns

Promise<AxiosResponse<Credentials, any>>

Summary

Get Authentication/Authorization Information

Throws

Memberof

CredentialApi

Defined in

src/generated/Auth/api.ts:3713