OAuthModel interface

Modèle d’authentification d’API avec OAuth2.

Extends

Propriétés

accessTokenPrepend

Jeton d’accès ajouté. La valeur par défaut est « Porteur ».

authorizationCode

Code d’autorisation de l’utilisateur.

authorizationEndpoint

Point de terminaison d’autorisation.

authorizationEndpointHeaders

En-têtes de point de terminaison d’autorisation.

authorizationEndpointQueryParameters

Paramètres de requête de point de terminaison d’autorisation.

clientId

ID d’application (client) affecté au fournisseur OAuth à votre application.

clientSecret

Secret d’application (client) que le fournisseur OAuth a affecté à votre application.

grantType

Le type d’octroi est généralement « code d’autorisation ».

isCredentialsInHeaders

Indiquant si nous voulons envoyer le clientId et le clientSecret au point de terminaison de jeton dans les en-têtes.

isJwtBearerFlow

Valeur indiquant s’il s’agit d’un flux JWT.

redirectUri

URL de redirection de l’application que l’utilisateur config dans le fournisseur OAuth.

scope

Étendue de l’application (client) affectée par le fournisseur OAuth à votre application.

tokenEndpoint

Point de terminaison de jeton. Définit le jeton de rafraîchissement OAuth2.

tokenEndpointHeaders

En-têtes de point de terminaison de jeton.

tokenEndpointQueryParameters

Paramètres de requête de point de terminaison de jeton.

type

Type d’authentification

Détails de la propriété

accessTokenPrepend

Jeton d’accès ajouté. La valeur par défaut est « Porteur ».

accessTokenPrepend?: string

Valeur de propriété

string

authorizationCode

Code d’autorisation de l’utilisateur.

authorizationCode?: string

Valeur de propriété

string

authorizationEndpoint

Point de terminaison d’autorisation.

authorizationEndpoint?: string

Valeur de propriété

string

authorizationEndpointHeaders

En-têtes de point de terminaison d’autorisation.

authorizationEndpointHeaders?: Record<string, string>

Valeur de propriété

Record<string, string>

authorizationEndpointQueryParameters

Paramètres de requête de point de terminaison d’autorisation.

authorizationEndpointQueryParameters?: Record<string, string>

Valeur de propriété

Record<string, string>

clientId

ID d’application (client) affecté au fournisseur OAuth à votre application.

clientId: string

Valeur de propriété

string

clientSecret

Secret d’application (client) que le fournisseur OAuth a affecté à votre application.

clientSecret: string

Valeur de propriété

string

grantType

Le type d’octroi est généralement « code d’autorisation ».

grantType: string

Valeur de propriété

string

isCredentialsInHeaders

Indiquant si nous voulons envoyer le clientId et le clientSecret au point de terminaison de jeton dans les en-têtes.

isCredentialsInHeaders?: boolean

Valeur de propriété

boolean

isJwtBearerFlow

Valeur indiquant s’il s’agit d’un flux JWT.

isJwtBearerFlow?: boolean

Valeur de propriété

boolean

redirectUri

URL de redirection de l’application que l’utilisateur config dans le fournisseur OAuth.

redirectUri?: string

Valeur de propriété

string

scope

Étendue de l’application (client) affectée par le fournisseur OAuth à votre application.

scope?: string

Valeur de propriété

string

tokenEndpoint

Point de terminaison de jeton. Définit le jeton de rafraîchissement OAuth2.

tokenEndpoint: string

Valeur de propriété

string

tokenEndpointHeaders

En-têtes de point de terminaison de jeton.

tokenEndpointHeaders?: Record<string, string>

Valeur de propriété

Record<string, string>

tokenEndpointQueryParameters

Paramètres de requête de point de terminaison de jeton.

tokenEndpointQueryParameters?: Record<string, string>

Valeur de propriété

Record<string, string>

type

Type d’authentification

type: "OAuth2"

Valeur de propriété

"OAuth2"