OAuthModel interface
Modell für die API-Authentifizierung mit OAuth2.
- Extends
Eigenschaften
| access |
Access-Token vorangestellt. Der Standardwert ist 'Bearer'. |
| authorization |
Der Autorisierungscode des Benutzers. |
| authorization |
Der Autorisierungsendpunkt. |
| authorization |
Die Autorisierungsendpunktheader. |
| authorization |
Die Abfrageparameter des Autorisierungsendpunkts. |
| client |
Die Anwendungs-ID (Client-ID), die der OAuth-Anbieter Ihrer App zugewiesen hat. |
| client |
Der geheime Anwendungsschlüssel (Client), den der OAuth-Anbieter Ihrer App zugewiesen hat. |
| grant |
Der Erteilungstyp ist in der Regel "Autorisierungscode". |
| is |
Gibt an, ob die clientId und clientSecret an den Tokenendpunkt in den Headern gesendet werden sollen. |
| is |
Ein Wert, der angibt, ob es sich um einen JWT-Fluss handelt. |
| redirect |
Die Anwendungsumleitungs-URL, die die Benutzerkonfiguration im OAuth-Anbieter enthält. |
| scope | Der Anwendungsbereich (Client), den der OAuth-Anbieter Ihrer App zugewiesen hat. |
| token |
Der Tokenendpunkt. Definiert das OAuth2-Aktualisierungstoken. |
| token |
Die Tokenendpunktheader. |
| token |
Die Abfrageparameter des Tokenendpunkts. |
| type | Der Authentifizierungstyp |
Details zur Eigenschaft
accessTokenPrepend
Access-Token vorangestellt. Der Standardwert ist 'Bearer'.
accessTokenPrepend?: string
Eigenschaftswert
string
authorizationCode
Der Autorisierungscode des Benutzers.
authorizationCode?: string
Eigenschaftswert
string
authorizationEndpoint
Der Autorisierungsendpunkt.
authorizationEndpoint?: string
Eigenschaftswert
string
authorizationEndpointHeaders
Die Autorisierungsendpunktheader.
authorizationEndpointHeaders?: Record<string, string>
Eigenschaftswert
Record<string, string>
authorizationEndpointQueryParameters
Die Abfrageparameter des Autorisierungsendpunkts.
authorizationEndpointQueryParameters?: Record<string, string>
Eigenschaftswert
Record<string, string>
clientId
Die Anwendungs-ID (Client-ID), die der OAuth-Anbieter Ihrer App zugewiesen hat.
clientId: string
Eigenschaftswert
string
clientSecret
Der geheime Anwendungsschlüssel (Client), den der OAuth-Anbieter Ihrer App zugewiesen hat.
clientSecret: string
Eigenschaftswert
string
grantType
Der Erteilungstyp ist in der Regel "Autorisierungscode".
grantType: string
Eigenschaftswert
string
isCredentialsInHeaders
Gibt an, ob die clientId und clientSecret an den Tokenendpunkt in den Headern gesendet werden sollen.
isCredentialsInHeaders?: boolean
Eigenschaftswert
boolean
isJwtBearerFlow
Ein Wert, der angibt, ob es sich um einen JWT-Fluss handelt.
isJwtBearerFlow?: boolean
Eigenschaftswert
boolean
redirectUri
Die Anwendungsumleitungs-URL, die die Benutzerkonfiguration im OAuth-Anbieter enthält.
redirectUri?: string
Eigenschaftswert
string
scope
Der Anwendungsbereich (Client), den der OAuth-Anbieter Ihrer App zugewiesen hat.
scope?: string
Eigenschaftswert
string
tokenEndpoint
Der Tokenendpunkt. Definiert das OAuth2-Aktualisierungstoken.
tokenEndpoint: string
Eigenschaftswert
string
tokenEndpointHeaders
Die Tokenendpunktheader.
tokenEndpointHeaders?: Record<string, string>
Eigenschaftswert
Record<string, string>
tokenEndpointQueryParameters
Die Abfrageparameter des Tokenendpunkts.
tokenEndpointQueryParameters?: Record<string, string>
Eigenschaftswert
Record<string, string>
type
Der Authentifizierungstyp
type: "OAuth2"
Eigenschaftswert
"OAuth2"