Identity Provider - Update

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Aktualisiert eine vorhandene IdentityProvider-Konfiguration.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
identityProviderName	path	True	IdentityProviderType	Id des Identitätsanbietertyps.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang 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.allowedTenants	string[]	Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung.
properties.authority	string	OpenID Connect-Endpunkt-Hostname für AAD oder AAD B2C.
properties.clientId	string minLength: 1	Client-ID der Anwendung im externen Identitätsanbieter. Es ist App-ID für Facebook-Anmeldung, Client-ID für Google-Anmeldung, App-ID für Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider.
properties.clientSecret	string minLength: 1	Der geheime Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Beispielsweise ist es App Secret für Facebook-Anmeldung, API-Schlüssel für Google-Anmeldung, Öffentlicher Schlüssel für Microsoft.
properties.passwordResetPolicyName	string minLength: 1	Name der Kennwortzurücksetzungsrichtlinie. Gilt nur für AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Anmelderichtlinienname. Gilt nur für AAD B2C Identity Provider.
properties.signinTenant	string	Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll
properties.signupPolicyName	string minLength: 1	Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identity Provider.
properties.type	IdentityProviderType	Id des Identitätsanbietertyps.

Antworten

Name	Typ	Beschreibung
200 OK	IdentityProviderContract	Der vorhandene Identitätsanbieter wurde erfolgreich aktualisiert. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

IdentityProviderContract

Der vorhandene Identitätsanbieter wurde erfolgreich aktualisiert.

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementUpdateIdentityProvider

Beispielanforderung

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/facebook?api-version=2024-05-01


{
  "properties": {
    "clientId": "updatedfacebookid",
    "clientSecret": "updatedfacebooksecret"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "AadB2C",
  "properties": {
    "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5",
    "type": "aadB2C",
    "authority": "login.microsoftonline.com",
    "signinTenant": "contosoaadb2c.onmicrosoft.com",
    "allowedTenants": [
      "contosoaadb2c.onmicrosoft.com",
      "contoso2aadb2c.onmicrosoft.com"
    ],
    "signupPolicyName": "B2C_1_policy-signup",
    "signinPolicyName": "B2C_1_policy-signin"
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IdentityProviderContract	Details des Identitätsanbieters.
IdentityProviderType	Id des Identitätsanbietertyps.
IdentityProviderUpdateParameters	Parameter, die zum Aktualisieren des Identitätsanbieters bereitgestellt werden

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IdentityProviderContract

Objekt

Details des Identitätsanbieters.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.allowedTenants	string[]	Liste der zulässigen Mandanten beim Konfigurieren der Azure Active Directory-Anmeldung.
properties.authority	string	OpenID Connect-Endpunkt-Hostname für AAD oder AAD B2C.
properties.clientId	string minLength: 1	Client-ID der Anwendung im externen Identitätsanbieter. Es ist App-ID für Facebook-Anmeldung, Client-ID für Google-Anmeldung, App-ID für Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	Die Clientbibliothek, die im Entwicklerportal verwendet werden soll. Gilt nur für AAD und AAD B2C Identity Provider.
properties.clientSecret	string minLength: 1	Der geheime Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Beispielsweise ist es App Secret für Facebook-Anmeldung, API-Schlüssel für Google-Anmeldung, Öffentlicher Schlüssel für Microsoft. Diese Eigenschaft wird für 'GET'-Vorgänge nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.
properties.passwordResetPolicyName	string minLength: 1	Name der Kennwortzurücksetzungsrichtlinie. Gilt nur für AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Anmelderichtlinienname. Gilt nur für AAD B2C Identity Provider.
properties.signinTenant	string	Die TenantId, die bei der Anmeldung bei Active Directory anstelle von "Common" verwendet werden soll
properties.signupPolicyName	string minLength: 1	Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identity Provider.
properties.type	IdentityProviderType	Id des Identitätsanbietertyps.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

IdentityProviderType

Enumeration

Id des Identitätsanbietertyps.

Wert	Beschreibung
aad	Azure Active Directory als Identitätsanbieter.
aadB2C	Azure Active Directory B2C als Identitätsanbieter.
facebook	Facebook als Identitätsanbieter.
google	Google als Identitätsanbieter.
microsoft	Microsoft Live as Identity-Anbieter.
twitter	Twitter als Identitätsanbieter.