Class AdvancedApi

Index

Constructors

constructor

Methods

getToken getTokenWithHttpInfo introspectToken introspectTokenWithHttpInfo revokeToken revokeTokenWithHttpInfo

Constructors

constructor

new AdvancedApi(configuration, requestFactory?, responseProcessor?): AdvancedApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: AdvancedApiRequestFactory
- OptionalresponseProcessor: AdvancedApiResponseProcessor
Returns AdvancedApi
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:13

Methods

getToken

getToken(assertion?, clientAssertion?, clientAssertionType?, clientId?, clientSecret?, code?, codeVerifier?, grantType?, redirectUri?, refreshToken?, scope?, _options?): Promise<TokenResponseIF>
Authenticates a client and returns access and refresh tokens. OAuth token endpoint
Parameters
- Optionalassertion: string
- OptionalclientAssertion: string
- OptionalclientAssertionType: string
- OptionalclientId: string
- OptionalclientSecret: string
- Optionalcode: string
- OptionalcodeVerifier: string
- OptionalgrantType: string
- OptionalredirectUri: string
- OptionalrefreshToken: string
- Optionalscope: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<TokenResponseIF>
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:68

getTokenWithHttpInfo

getTokenWithHttpInfo(assertion?, clientAssertion?, clientAssertionType?, clientId?, clientSecret?, code?, codeVerifier?, grantType?, redirectUri?, refreshToken?, scope?, _options?): Promise<HttpInfo<TokenResponseIF>>
Authenticates a client and returns access and refresh tokens. OAuth token endpoint
Parameters
- Optionalassertion: string
- OptionalclientAssertion: string
- OptionalclientAssertionType: string
- OptionalclientId: string
- OptionalclientSecret: string
- Optionalcode: string
- OptionalcodeVerifier: string
- OptionalgrantType: string
- OptionalredirectUri: string
- OptionalrefreshToken: string
- Optionalscope: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<TokenResponseIF>>
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:36

introspectToken

introspectToken(clientId?, clientSecret?, token?, tokenTypeHint?, _options?): Promise<TokenInfoResponseBaseIF>
Returns validity and metadata for access and refresh tokens. Token introspection endpoint
Parameters
- OptionalclientId: string
- OptionalclientSecret: string
- Optionaltoken: string
- OptionaltokenTypeHint: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<TokenInfoResponseBaseIF>
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:118

introspectTokenWithHttpInfo

introspectTokenWithHttpInfo(clientId?, clientSecret?, token?, tokenTypeHint?, _options?): Promise<HttpInfo<TokenInfoResponseBaseIF>>
Returns validity and metadata for access and refresh tokens. Token introspection endpoint
Parameters
- OptionalclientId: string
- OptionalclientSecret: string
- Optionaltoken: string
- OptionaltokenTypeHint: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<TokenInfoResponseBaseIF>>
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:93

revokeToken

revokeToken(clientId?, clientSecret?, token?, tokenTypeHint?, _options?): Promise<void>
Deletes/Revokes provided Refresh Token Token Revocation endpoint
Parameters
- OptionalclientId: string
- OptionalclientSecret: string
- Optionaltoken: string
- OptionaltokenTypeHint: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<void>
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:168

revokeTokenWithHttpInfo

revokeTokenWithHttpInfo(clientId?, clientSecret?, token?, tokenTypeHint?, _options?): Promise<HttpInfo<void>>
Deletes/Revokes provided Refresh Token Token Revocation endpoint
Parameters
- OptionalclientId: string
- OptionalclientSecret: string
- Optionaltoken: string
- OptionaltokenTypeHint: string
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/oauth/v3/types/PromiseAPI.ts:143

Class AdvancedApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AdvancedApi

Methods

getToken

Parameters

Returns Promise<TokenResponseIF>

getTokenWithHttpInfo

Parameters

Returns Promise<HttpInfo<TokenResponseIF>>

introspectToken

Parameters

Returns Promise<TokenInfoResponseBaseIF>

introspectTokenWithHttpInfo

Parameters

Returns Promise<HttpInfo<TokenInfoResponseBaseIF>>

revokeToken

Parameters

Returns Promise<void>

revokeTokenWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

Settings

On This Page