AuthorizationServerContractBaseProperties interface

Paket:

@azure/arm-apimanagement

Vertrag für externe OAuth-Autorisierungsserveraktualisierungseinstellungen.

Eigenschaften

authorizationMethods	HTTP-Verben, die vom Autorisierungsendpunkt unterstützt werden. GET muss immer vorhanden sein. POST ist optional.
bearerTokenSendingMethods	Gibt den Mechanismus an, mit dem zugriffstoken an die API übergeben wird.
clientAuthenticationMethod	Vom Tokenendpunkt dieses Autorisierungsservers unterstützte Authentifizierungsmethode. Mögliche Werte sind "Basic" und/oder "Body". Wenn "Body" angegeben wird, werden Clientanmeldeinformationen und andere Parameter im Anforderungstext im Anwendungs-/x-www-form-urlencoded-Format übergeben.
defaultScope	Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge bereitgestellt werden, die durch Leerzeichen getrennte Werte enthält.
description	Beschreibung des Autorisierungsservers. Kann HTML-Formatierungstags enthalten.
resourceOwnerPassword	Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardkennwort des Ressourcenbesitzers.
resourceOwnerUsername	Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardbenutzerbenutzername der Ressource.
supportState	Bei "true" enthält der Autorisierungsserver zustandsparameter aus der Autorisierungsanforderung an seine Antwort. Der Client kann zustandsparameter verwenden, um die Protokollsicherheit auszuheben.
tokenBodyParameters	Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers als Array von JSON-Objekten mit Namen- und Wertzeichenfolgeneigenschaften dargestellt werden, d. h. {"name" : "name value", "value": "a value"}.
tokenEndpoint	OAuth-Tokenendpunkt. Enthält einen absoluten URI für die 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 dem zugriffstoken an die API übergeben wird.

bearerTokenSendingMethods?: string[]

Eigenschaftswert

string[]

clientAuthenticationMethod

Vom Tokenendpunkt dieses Autorisierungsservers unterstützte Authentifizierungsmethode. Mögliche Werte sind "Basic" und/oder "Body". Wenn "Body" angegeben wird, werden Clientanmeldeinformationen und andere Parameter im Anforderungstext im Anwendungs-/x-www-form-urlencoded-Format übergeben.

clientAuthenticationMethod?: string[]

Eigenschaftswert

string[]

defaultScope

Zugriffstokenbereich, der standardmäßig angefordert wird. Kann auf API-Ebene überschrieben werden. Sollte in Form einer Zeichenfolge bereitgestellt werden, die durch Leerzeichen getrennte Werte enthält.

defaultScope?: string

Eigenschaftswert

string

description

Beschreibung des Autorisierungsservers. Kann HTML-Formatierungstags enthalten.

description?: string

Eigenschaftswert

string

resourceOwnerPassword

Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardkennwort des Ressourcenbesitzers.

resourceOwnerPassword?: string

Eigenschaftswert

string

resourceOwnerUsername

Kann optional angegeben werden, wenn der Typ der Kennworterteilung des Ressourcenbesitzers von diesem Autorisierungsserver unterstützt wird. Standardbenutzerbenutzername der Ressource.

resourceOwnerUsername?: string

Eigenschaftswert

string

supportState

Bei "true" enthält der Autorisierungsserver zustandsparameter aus der Autorisierungsanforderung an seine Antwort. Der Client kann zustandsparameter verwenden, um die Protokollsicherheit auszuheben.

supportState?: boolean

Eigenschaftswert

boolean

tokenBodyParameters

Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers als Array von JSON-Objekten mit Namen- und Wertzeichenfolgeneigenschaften dargestellt werden, d. h. {"name" : "name value", "value": "a value"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Eigenschaftswert

TokenBodyParameterContract[]

tokenEndpoint

OAuth-Tokenendpunkt. Enthält einen absoluten URI für die Entität, auf die verwiesen wird.

tokenEndpoint?: string

Eigenschaftswert

string