Freigeben über

AuthorizationServerUpdateContractProperties interface

  • Referenz
Paket:
@azure/arm-apimanagement

Externer OAuth-Autorisierungsserver: Vertrag für Updateeinstellungen.

Extends
AuthorizationServerContractBaseProperties

Eigenschaften

authorizationEndpoint

OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.
clientId

Bei diesem Autorisierungsserver registrierte Client- oder App-ID.
clientRegistrationEndpoint

Optionaler Verweis auf eine Seite, auf der die Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält eine absolute URL zu der Entität, auf die verwiesen wird.
clientSecret

Bei diesem Autorisierungsserver registrierter geheimer Schlüssel des Clients oder der App. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
displayName

Benutzerfreundlicher Autorisierungsservername.
grantTypes

Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.
useInApiDocumentation

Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. Standardmäßig false, wenn kein Wert angegeben wird.
useInTestConsole

Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. Standardmäßig true, wenn kein Wert angegeben wird.

Geerbte 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

authorizationEndpoint

OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationEndpoint?: string

Eigenschaftswert

string

clientId

Bei diesem Autorisierungsserver registrierte Client- oder App-ID.

clientId?: string

Eigenschaftswert

string

clientRegistrationEndpoint

Optionaler Verweis auf eine Seite, auf der die Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält eine absolute URL zu der Entität, auf die verwiesen wird.

clientRegistrationEndpoint?: string

Eigenschaftswert

string

clientSecret

Bei diesem Autorisierungsserver registrierter geheimer Schlüssel des Clients oder der App. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

clientSecret?: string

Eigenschaftswert

string

displayName

Benutzerfreundlicher Autorisierungsservername.

displayName?: string

Eigenschaftswert

string

grantTypes

Form einer Autorisierungszuweisung, die der Client verwendet, um das Zugriffstoken anzufordern.

grantTypes?: string[]

Eigenschaftswert

string[]

useInApiDocumentation

Wenn true, wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. Standardmäßig false, wenn kein Wert angegeben wird.

useInApiDocumentation?: boolean

Eigenschaftswert

boolean

useInTestConsole

Wenn true, kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. Standardmäßig true, wenn kein Wert angegeben wird.

useInTestConsole?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

authorizationMethods

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

authorizationMethods?: AuthorizationMethod[]

Eigenschaftswert

AuthorizationMethod[]

Geerbt vonAuthorizationServerContractBaseProperties.authorizationMethods

bearerTokenSendingMethods

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

bearerTokenSendingMethods?: string[]

Eigenschaftswert

string[]

Geerbt vonAuthorizationServerContractBaseProperties.bearerTokenSendingMethods

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[]

Geerbt vonAuthorizationServerContractBaseProperties.clientAuthenticationMethod

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

Geerbt vonAuthorizationServerContractBaseProperties.defaultScope

description

Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.

description?: string

Eigenschaftswert

string

Geerbt vonAuthorizationServerContractBaseProperties.description

resourceOwnerPassword

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

resourceOwnerPassword?: string

Eigenschaftswert

string

Geerbt vonAuthorizationServerContractBaseProperties.resourceOwnerPassword

resourceOwnerUsername

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

resourceOwnerUsername?: string

Eigenschaftswert

string

Geerbt vonAuthorizationServerContractBaseProperties.resourceOwnerUsername

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

Geerbt vonAuthorizationServerContractBaseProperties.supportState

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[]

Geerbt vonAuthorizationServerContractBaseProperties.tokenBodyParameters

tokenEndpoint

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

tokenEndpoint?: string

Eigenschaftswert

string

Geerbt vonAuthorizationServerContractBaseProperties.tokenEndpoint