Identity Provider - Create Or Update

Erstellt oder aktualisiert die Konfiguration des Identitätsanbieters

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

URI-Parameter

Name In Required Type Description
identityProviderName
path True

Id des Identitätsanbietertyps.

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

serviceName
path True
  • string

Der Name des API Management Diensts.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die 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 Required Type Description
If-Match
  • string

ETag der Entität. Nicht erforderlich beim Erstellen einer Entität, aber erforderlich beim Aktualisieren einer Entität.

Anforderungstext

Name Required Type Description
properties.clientId True
  • string

Client-ID der Anwendung im externen Identitätsanbieter. Dabei handelt es sich um die App-ID für die Facebook-Anmeldung, die Client-ID für die Google-Anmeldung und die App-ID für Microsoft.

properties.clientSecret True
  • string

Geheimer Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Es handelt sich beispielsweise um das App-Geheimnis für die Facebook-Anmeldung, den API-Schlüssel für die Google-Anmeldung und den öffentlichen Schlüssel für Microsoft. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

properties.allowedTenants
  • string[]

Liste der zulässigen Mandanten beim Konfigurieren Azure Active Directory Anmeldung.

properties.authority
  • string

OpenID Verbinden Hostname des Ermittlungsendpunkts für AAD oder AAD B2C.

properties.passwordResetPolicyName
  • string

Name der Richtlinie für die Kennwortrücksetzung. Gilt nur für AAD B2C Identitätsanbieter.

properties.profileEditingPolicyName
  • string

Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identitätsanbieter.

properties.signinPolicyName
  • string

Anmelderichtlinienname. Gilt nur für AAD B2C Identitätsanbieter.

properties.signinTenant
  • string

Die TenantId, die bei der Anmeldung bei Active Directory anstelle von Common verwendet werden soll.

properties.signupPolicyName
  • string

Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identitätsanbieter.

properties.type

Id des Identitätsanbietertyps.

Antworten

Name Type Description
200 OK

Der vorhandene Identitätsanbieter wurde erfolgreich aktualisiert.

Headers

  • ETag: string
201 Created

Die IdentityProvider-Konfiguration wurde erfolgreich erstellt.

Headers

  • ETag: string
Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Identität Ihres Benutzerkontos annehmen

Beispiele

ApiManagementCreateIdentityProvider

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/facebook?api-version=2021-01-01-preview
{
  "properties": {
    "clientId": "facebookid",
    "clientSecret": "facebookapplicationsecret"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "Facebook",
  "properties": {
    "clientId": "facebookid",
    "type": "facebook"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "Facebook",
  "properties": {
    "clientId": "facebookid",
    "type": "facebook"
  }
}

Definitionen

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

IdentityProviderContract

Details zum Identitätsanbieter.

IdentityProviderCreateContract

Details zum Identitätsanbieter.

IdentityProviderType

Id des Identitätsanbietertyps.

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.

message
  • string

Lesbare Darstellung von Fehlern auf Eigenschaftsebene.

target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

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

error.details

Die Liste ungültiger Felder, die bei einem Validierungsfehler in der Anforderung gesendet werden.

error.message
  • string

Lesbare Darstellung des Fehlers.

IdentityProviderContract

Details zum Identitätsanbieter.

Name Type Description
id
  • string

Ressourcen-ID

name
  • string

Name der Ressource.

properties.allowedTenants
  • string[]

Liste der zulässigen Mandanten beim Konfigurieren Azure Active Directory Anmeldung.

properties.authority
  • string

OpenID Verbinden Hostname des Ermittlungsendpunkts für AAD oder AAD B2C.

properties.clientId
  • string

Client-ID der Anwendung im externen Identitätsanbieter. Dabei handelt es sich um die App-ID für die Facebook-Anmeldung, die Client-ID für die Google-Anmeldung und die App-ID für Microsoft.

properties.clientSecret
  • string

Geheimer Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Es handelt sich beispielsweise um das App-Geheimnis für die Facebook-Anmeldung, den API-Schlüssel für die Google-Anmeldung und den öffentlichen Schlüssel für Microsoft. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

properties.passwordResetPolicyName
  • string

Name der Richtlinie für die Kennwortrücksetzung. Gilt nur für AAD B2C Identitätsanbieter.

properties.profileEditingPolicyName
  • string

Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identitätsanbieter.

properties.signinPolicyName
  • string

Anmelderichtlinienname. Gilt nur für AAD B2C Identitätsanbieter.

properties.signinTenant
  • string

Die TenantId, die bei der Anmeldung bei Active Directory anstelle von Common verwendet werden soll.

properties.signupPolicyName
  • string

Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identitätsanbieter.

properties.type

Id des Identitätsanbietertyps.

type
  • string

Ressourcentyp für API Management Ressource.

IdentityProviderCreateContract

Details zum Identitätsanbieter.

Name Type Description
id
  • string

Ressourcen-ID

name
  • string

Name der Ressource.

properties.allowedTenants
  • string[]

Liste der zulässigen Mandanten beim Konfigurieren Azure Active Directory Anmeldung.

properties.authority
  • string

OpenID Verbinden Hostname des Ermittlungsendpunkts für AAD oder AAD B2C.

properties.clientId
  • string

Client-ID der Anwendung im externen Identitätsanbieter. Dabei handelt es sich um die App-ID für die Facebook-Anmeldung, die Client-ID für die Google-Anmeldung und die App-ID für Microsoft.

properties.clientSecret
  • string

Geheimer Clientschlüssel der Anwendung im externen Identitätsanbieter, der zum Authentifizieren der Anmeldeanforderung verwendet wird. Es handelt sich beispielsweise um das App-Geheimnis für die Facebook-Anmeldung, den API-Schlüssel für die Google-Anmeldung und den öffentlichen Schlüssel für Microsoft. Diese Eigenschaft wird bei GET-Vorgängen nicht ausgefüllt! Verwenden Sie die POST-Anforderung "/listSecrets", um den Wert abzurufen.

properties.passwordResetPolicyName
  • string

Name der Richtlinie für die Kennwortrücksetzung. Gilt nur für AAD B2C Identitätsanbieter.

properties.profileEditingPolicyName
  • string

Name der Profilbearbeitungsrichtlinie. Gilt nur für AAD B2C Identitätsanbieter.

properties.signinPolicyName
  • string

Anmelderichtlinienname. Gilt nur für AAD B2C Identitätsanbieter.

properties.signinTenant
  • string

Die TenantId, die bei der Anmeldung bei Active Directory anstelle von Common verwendet werden soll.

properties.signupPolicyName
  • string

Name der Registrierungsrichtlinie. Gilt nur für AAD B2C Identitätsanbieter.

properties.type

Id des Identitätsanbietertyps.

type
  • string

Ressourcentyp für API Management Ressource.

IdentityProviderType

Id des Identitätsanbietertyps.

Name Type Description
aad
  • string

Azure Active Directory als Identitätsanbieter.

aadB2C
  • string

Azure Active Directory B2C als Identitätsanbieter.

facebook
  • string

Facebook als Identitätsanbieter.

google
  • string

Google als Identitätsanbieter.

microsoft
  • string

Microsoft Live als Identitätsanbieter.

twitter
  • string

Twitter als Identitätsanbieter.