Authorization Server - Update

Updates die Details des Autorisierungsservers, der durch seinen Bezeichner angegeben wird.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}?api-version=2021-08-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
authsid
path True

string

Bezeichner des Autorisierungsservers.

RegEx-Muster: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Der Name der Ressourcengruppe.

serviceName
path True

string

Der Name des API Management-Diensts.

RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match True

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name Typ Beschreibung
properties.authorizationEndpoint

string

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

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

properties.clientAuthenticationMethod

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 im Format application/x-www-form-urlencoded innerhalb des Anforderungstexts übergeben.

properties.clientId

string

Bei diesem Autorisierungsserver registrierte Client- oder App-ID.

properties.clientRegistrationEndpoint

string

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.

properties.clientSecret

string

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.

properties.defaultScope

string

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

properties.description

string

Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.

properties.displayName

string

Benutzerfreundlicher Autorisierungsservername.

properties.grantTypes

GrantType[]

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

properties.resourceOwnerPassword

string

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

properties.resourceOwnerUsername

string

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

properties.supportState

boolean

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.

properties.tokenBodyParameters

TokenBodyParameterContract[]

Zusätzliche Parameter, die vom Tokenendpunkt dieses Autorisierungsservers benötigt werden, werden als Array von JSON-Objekten mit den Eigenschaften name und Value string dargestellt, d. h. {"name" : "name value", "value": "a value"}.

properties.tokenEndpoint

string

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

Antworten

Name Typ Beschreibung
200 OK

AuthorizationServerContract

Die Autorisierungsservereinstellungen wurden erfolgreich aktualisiert.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementUpdateAuthorizationServer

Beispielanforderung

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer?api-version=2021-08-01


{
  "properties": {
    "clientId": "update",
    "clientSecret": "updated"
  }
}

Beispiel für eine Antwort

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationServers/newauthServer",
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "name": "newauthServer",
  "properties": {
    "displayName": "test3",
    "description": "test server",
    "clientRegistrationEndpoint": "https://www.contoso.com/apps",
    "authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
    "authorizationMethods": [
      "GET"
    ],
    "clientAuthenticationMethod": [
      "Basic"
    ],
    "tokenEndpoint": "https://www.contoso.com/oauth2/token",
    "supportState": true,
    "defaultScope": "read write",
    "grantTypes": [
      "authorizationCode",
      "implicit"
    ],
    "bearerTokenSendingMethods": [
      "authorizationHeader"
    ],
    "clientId": "updated",
    "resourceOwnerUsername": "un",
    "resourceOwnerPassword": "pwd"
  }
}

Definitionen

Name Beschreibung
AuthorizationMethod

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

AuthorizationServerContract

Einstellungen des externen OAuth-Autorisierungsservers.

AuthorizationServerUpdateContract

Einstellungen des externen OAuth-Autorisierungsservers.

BearerTokenSendingMethod

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.

ErrorFieldContract

Fehler Feldvertrag.

ErrorResponse

Fehlerantwort.

GrantType

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

TokenBodyParameterContract

OAuth-Parameter zum Abrufen des Tokenanforderungstexts (www-url-form-codiert).

AuthorizationMethod

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

Name Typ Beschreibung
DELETE

string

GET

string

HEAD

string

OPTIONS

string

PATCH

string

POST

string

PUT

string

TRACE

string

AuthorizationServerContract

Einstellungen des externen OAuth-Autorisierungsservers.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.authorizationEndpoint

string

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

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

properties.clientAuthenticationMethod

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.

properties.clientId

string

Bei diesem Autorisierungsserver registrierte Client- oder App-ID.

properties.clientRegistrationEndpoint

string

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.

properties.clientSecret

string

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.

properties.defaultScope

string

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

properties.description

string

Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.

properties.displayName

string

Benutzerfreundlicher Autorisierungsservername.

properties.grantTypes

GrantType[]

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

properties.resourceOwnerPassword

string

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

properties.resourceOwnerUsername

string

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

properties.supportState

boolean

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.

properties.tokenBodyParameters

TokenBodyParameterContract[]

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"}.

properties.tokenEndpoint

string

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

type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AuthorizationServerUpdateContract

Einstellungen des externen OAuth-Autorisierungsservers.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Der Name der Ressource

properties.authorizationEndpoint

string

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

properties.authorizationMethods

AuthorizationMethod[]

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

properties.bearerTokenSendingMethods

BearerTokenSendingMethod[]

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

properties.clientAuthenticationMethod

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.

properties.clientId

string

Bei diesem Autorisierungsserver registrierte Client- oder App-ID.

properties.clientRegistrationEndpoint

string

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.

properties.clientSecret

string

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.

properties.defaultScope

string

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

properties.description

string

Die Beschreibung des Autorisierungsservers. Darf HTML-Formatierungstags enthalten.

properties.displayName

string

Benutzerfreundlicher Autorisierungsservername.

properties.grantTypes

GrantType[]

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

properties.resourceOwnerPassword

string

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

properties.resourceOwnerUsername

string

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

properties.supportState

boolean

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.

properties.tokenBodyParameters

TokenBodyParameterContract[]

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"}.

properties.tokenEndpoint

string

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

type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

BearerTokenSendingMethod

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

Name Typ Beschreibung
authorizationHeader

string

query

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.

Name Typ Beschreibung
Basic

string

Grundlegende Clientauthentifizierungsmethode.

Body

string

Textbasierte Authentifizierungsmethode.

ErrorFieldContract

Fehler Feldvertrag.

Name Typ Beschreibung
code

string

Fehlercode auf Eigenschaftsebene.

message

string

Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.

target

string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Typ Beschreibung
error.code

string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

ErrorFieldContract[]

Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.

error.message

string

Lesbare Darstellung des Fehlers.

GrantType

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

Name Typ Beschreibung
authorizationCode

string

Autorisierungscode-Gewährungsflow, wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.1.

clientCredentials

string

Ablauf zur Gewährung von Clientanmeldeinformationen wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.4.

implicit

string

Impliziter Code grant-Flow wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.2.

resourceOwnerPassword

string

Ablauf für die Kennwortzuweisung von Ressourcenbesitzern wie beschrieben https://tools.ietf.org/html/rfc6749#section-4.3.

TokenBodyParameterContract

OAuth-Parameter zum Abrufen des Tokenanforderungstexts (www-url-form-codiert).

Name Typ Beschreibung
name

string

body-Parametername.

value

string

body-Parameterwert.