AuthorizationServerContractBaseProperties interface

Paket:

@azure/arm-apimanagement

Externer OAuth-Autorisierungsserver: Vertrag für Updateeinstellungen.

Eigenschaften

authorizationMethods	HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.
bearerTokenSendingMethods	Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird.
clientAuthenticationMethod	Methode zur Authentifizierung, die vom Tokenendpunkt dieses Autorisierungsservers unterstützt wird. Mögliche Werte sind Basic und/oder Body. Wenn Body angegeben ist, werden Clientanmeldeinformationen und andere Parameter innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded übergeben.
defaultScope	Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden.
description	Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.
resourceOwnerPassword	Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers.
resourceOwnerUsername	Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers.
supportState	Wenn true, schließt der Autorisierungsserver den Zustandsparameter aus der Autorisierungsanforderung in seine Antwort ein. Der Client kann mithilfe des Zustandsparameters die Protokollsicherheit erhöhen.
tokenBodyParameters	Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers benötigt werden, die als Array von JSON-Objekten mit eigenschaften für Name und Wertzeichenfolge dargestellt werden, d. h. {"name" : "name value", "value": "a value"}.
tokenEndpoint	OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird.

Details zur Eigenschaft

authorizationMethods

HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.

authorizationMethods?: AuthorizationMethod[]

Eigenschaftswert

AuthorizationMethod[]

bearerTokenSendingMethods

Gibt den Mechanismus an, mit dessen Hilfe das Zugriffstoken an die API übergeben wird.

bearerTokenSendingMethods?: string[]

Eigenschaftswert

string[]

clientAuthenticationMethod

Methode zur Authentifizierung, die vom Tokenendpunkt dieses Autorisierungsservers unterstützt wird. Mögliche Werte sind Basic und/oder Body. Wenn Body angegeben ist, werden Clientanmeldeinformationen und andere Parameter innerhalb des Anforderungstexts im Format application/x-www-form-urlencoded übergeben.

clientAuthenticationMethod?: string[]

Eigenschaftswert

string[]

defaultScope

Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge mit durch Leerzeichen getrennten Werten bereitgestellt werden.

defaultScope?: string

Eigenschaftswert

string

description

Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.

description?: string

Eigenschaftswert

string

resourceOwnerPassword

Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Das Kennwort des Standardressourcenbesitzers.

resourceOwnerPassword?: string

Eigenschaftswert

string

resourceOwnerUsername

Kann optional angegeben werden, wenn der Erteilungstyp des Ressourcenbesitzerkennworts von diesem Autorisierungsserver unterstützt wird. Der Benutzername des Standardressourcenbesitzers.

resourceOwnerUsername?: string

Eigenschaftswert

string

supportState

Wenn true, schließt der Autorisierungsserver den Zustandsparameter aus der Autorisierungsanforderung in seine Antwort ein. Der Client kann mithilfe des Zustandsparameters die Protokollsicherheit erhöhen.

supportState?: boolean

Eigenschaftswert

boolean

tokenBodyParameters

Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers benötigt werden, die als Array von JSON-Objekten mit eigenschaften für Name und Wertzeichenfolge dargestellt werden, d. h. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Eigenschaftswert

TokenBodyParameterContract[]

tokenEndpoint

OAuth-Tokenendpunkt. Enthält einen absoluten URI zu der Entität, auf die verwiesen wird.

tokenEndpoint?: string

Eigenschaftswert

string