Identity Provider - Update

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Aktualizuje istniejącą konfigurację IdentityProvider.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
identityProviderName	path	True	IdentityProviderType	Identyfikator typu dostawcy tożsamości.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match	True	string	Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

Treść żądania

Nazwa	Typ	Opis
properties.allowedTenants	string[]	Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory.
properties.authority	string	OpenID Connect nazwa hosta punktu końcowego odnajdywania dla usługi AAD lub usługi AAD B2C.
properties.clientId	string minLength: 1	Identyfikator klienta aplikacji w zewnętrznym dostawcy tożsamości. Jest to identyfikator aplikacji dla logowania do serwisu Facebook, identyfikator klienta logowania Google, identyfikator aplikacji dla firmy Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	Biblioteka klienta, która ma być używana w portalu deweloperów. Dotyczy tylko usług AAD i AAD B2C Identity Provider.
properties.clientSecret	string minLength: 1	Wpis tajny klienta aplikacji w zewnętrznym dostawcy tożsamości używany do uwierzytelniania żądania logowania. Na przykład jest to wpis tajny aplikacji na potrzeby logowania do serwisu Facebook, klucz interfejsu API do logowania Google, klucz publiczny dla firmy Microsoft.
properties.passwordResetPolicyName	string minLength: 1	Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.profileEditingPolicyName	string minLength: 1	Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinPolicyName	string minLength: 1	Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinTenant	string	Identyfikator TenantId do użycia zamiast typowego podczas logowania się do usługi Active Directory
properties.signupPolicyName	string minLength: 1	Nazwa zasad rejestracji. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.type	IdentityProviderType	Identyfikator typu dostawcy tożsamości.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	IdentityProviderContract	Istniejący dostawca tożsamości został pomyślnie zaktualizowany. Nagłówki ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

IdentityProviderContract

Istniejący dostawca tożsamości został pomyślnie zaktualizowany.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateIdentityProvider

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
IdentityProviderContract	Szczegóły dostawcy tożsamości.
IdentityProviderType	Identyfikator typu dostawcy tożsamości.
IdentityProviderUpdateParameters	Parametry dostarczone w celu zaktualizowania dostawcy tożsamości

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

IdentityProviderContract

Objekt

Szczegóły dostawcy tożsamości.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.allowedTenants	string[]	Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory.
properties.authority	string	OpenID Connect nazwa hosta punktu końcowego odnajdywania dla usługi AAD lub usługi AAD B2C.
properties.clientId	string minLength: 1	Identyfikator klienta aplikacji w zewnętrznym dostawcy tożsamości. Jest to identyfikator aplikacji dla logowania do serwisu Facebook, identyfikator klienta logowania Google, identyfikator aplikacji dla firmy Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	Biblioteka klienta, która ma być używana w portalu deweloperów. Dotyczy tylko usług AAD i AAD B2C Identity Provider.
properties.clientSecret	string minLength: 1	Wpis tajny klienta aplikacji w zewnętrznym dostawcy tożsamości używany do uwierzytelniania żądania logowania. Na przykład jest to wpis tajny aplikacji na potrzeby logowania do serwisu Facebook, klucz interfejsu API do logowania Google, klucz publiczny dla firmy Microsoft. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.
properties.passwordResetPolicyName	string minLength: 1	Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.profileEditingPolicyName	string minLength: 1	Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinPolicyName	string minLength: 1	Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinTenant	string	Identyfikator TenantId do użycia zamiast typowego podczas logowania się do usługi Active Directory
properties.signupPolicyName	string minLength: 1	Nazwa zasad rejestracji. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.type	IdentityProviderType	Identyfikator typu dostawcy tożsamości.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

IdentityProviderType

Wyliczanie

Identyfikator typu dostawcy tożsamości.

Wartość	Opis
aad	Usługa Azure Active Directory jako dostawca tożsamości.
aadB2C	Usługa Azure Active Directory B2C jako dostawca tożsamości.
facebook	Facebook jako dostawca tożsamości.
google	Google jako dostawca tożsamości.
microsoft	Microsoft Live jako dostawca tożsamości.
twitter	Twitter jako dostawca tożsamości.