AuthorizationServerContract interface

Paket:

@azure/arm-apimanagement

Externe OAuth-Autorisierungsservereinstellungen.

Extends

ProxyResource

Eigenschaften

authorizationEndpoint	OAuth-Autorisierungsendpunkt. Siehe http://tools.ietf.org/html/rfc6749#section-3.2.
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.
clientId	Client- oder App-ID, die bei diesem Autorisierungsserver registriert ist.
clientRegistrationEndpoint	Optionaler Verweis auf eine Seite, auf der Client- oder App-Registrierung für diesen Autorisierungsserver ausgeführt wird. Enthält absolute URL zu Entität, auf die verwiesen wird.
clientSecret	Client- oder App-Geheimschlüssel, der bei diesem Autorisierungsserver registriert ist. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
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.
displayName	Benutzerfreundlicher Autorisierungsservername.
grantTypes	Form einer Autorisierungserteilung, die der Client zum Anfordern des Zugriffstokens verwendet.
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.
useInApiDocumentation	Bei "true" wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.
useInTestConsole	Bei "true" kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird.

Geerbte Eigenschaften

id	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
name	Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
type	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

authorizationEndpoint

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

authorizationEndpoint?: string

Eigenschaftswert

string

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

clientId

Client- oder App-ID, die bei diesem Autorisierungsserver registriert ist.

clientId?: string

Eigenschaftswert

string

clientRegistrationEndpoint

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

clientRegistrationEndpoint?: string

Eigenschaftswert

string

clientSecret

Client- oder App-Geheimschlüssel, der bei diesem Autorisierungsserver registriert ist. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

clientSecret?: 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

displayName

Benutzerfreundlicher Autorisierungsservername.

displayName?: string

Eigenschaftswert

string

grantTypes

Form einer Autorisierungserteilung, die der Client zum Anfordern des Zugriffstokens verwendet.

grantTypes?: 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

useInApiDocumentation

Bei "true" wird der Autorisierungsserver in der API-Dokumentation im Entwicklerportal verwendet. False standardmäßig, wenn kein Wert angegeben wird.

useInApiDocumentation?: boolean

Eigenschaftswert

boolean

useInTestConsole

Bei "true" kann der Autorisierungsserver in der Testkonsole des Entwicklerportals verwendet werden. True standardmäßig, wenn kein Wert angegeben wird.

useInTestConsole?: boolean

Eigenschaftswert

boolean

Geerbte Eigenschaftsdetails

id

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

geerbt vonProxyResource.id

name

Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

geerbt vonProxyResource.name

type

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

von"ProxyResource.type" geerbt