Skip to content

[I] Oauth2Auth

OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on a web server. OAuth relies on authentication scenarios called flows, which allow the resource owner (user) to share the protected content from the resource server without sharing their credentials. For that purpose, an OAuth 2.0 server issues access tokens that the client applications can use to access protected resources on behalf of the resource owner. For more information about OAuth 2.0, see oauth.net and RFC 6749.

Type Parameter
TFlows extends OAuth2Flow[]
PropertyModifierTypeDescriptionInherited from
description?publicstringDocumentation from the authentication model, when provided.HttpAuthBase.description
flowspublicTFlowsSupported token acquisition flows, with scopes resolved for each flow. A flow without explicit scopes uses the authentication model’s default scopes.-
idpublicstringScheme identifier, initially derived from the model name or authentication type. Service authentication resolution disambiguates conflicting identifiers.HttpAuthBase.id
modelreadonlyModelModel that defined the authenticationHttpAuthBase.model
typepublic"oauth2"Identifies an OAuth 2.0 scheme.-