Identity Provider - Update

Service:

API Management

API Version:

2021-08-01

Aktualizacje istniejącej konfiguracji IdentityProvider.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
identityProviderName	path	True	IdentityProviderType	Identyfikator typu dostawcy tożsamości.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
serviceName	path	True	string	Nazwa usługi API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API do użycia z żądaniem klienta.

Nagłówek żądania

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

Treść żądania

Nazwa	Typ	Opis
properties.allowedTenants	string[]	Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory.
properties.authority	string	Nazwa hosta punktu końcowego odnajdywania openID Connect dla usługi AAD lub usługi AAD B2C.
properties.clientId	string	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.clientSecret	string	Klucz 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 dla logowania Google, klucz publiczny dla firmy Microsoft.
properties.passwordResetPolicyName	string	Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.profileEditingPolicyName	string	Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinPolicyName	string	Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinTenant	string	Identyfikator dzierżawy do użycia zamiast typowego podczas logowania się do usługi Active Directory
properties.signupPolicyName	string	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. Headers ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateIdentityProvider

Sample Request

HTTP

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


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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.IdentityProviderContract;
import com.azure.resourcemanager.apimanagement.models.IdentityProviderType;

/** Samples for IdentityProvider Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateIdentityProvider.json
     */
    /**
     * Sample code: ApiManagementUpdateIdentityProvider.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateIdentityProvider(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        IdentityProviderContract resource =
            manager
                .identityProviders()
                .getWithResponse("rg1", "apimService1", IdentityProviderType.FACEBOOK, Context.NONE)
                .getValue();
        resource
            .update()
            .withClientId("updatedfacebookid")
            .withClientSecret("updatedfacebooksecret")
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_identity_provider.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.identity_provider.update(
        resource_group_name="rg1",
        service_name="apimService1",
        identity_provider_name="facebook",
        if_match="*",
        parameters={"properties": {"clientId": "updatedfacebookid", "clientSecret": "updatedfacebooksecret"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateIdentityProvider.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateIdentityProvider.json
func ExampleIdentityProviderClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIdentityProviderClient().Update(ctx, "rg1", "apimService1", armapimanagement.IdentityProviderTypeFacebook, "*", armapimanagement.IdentityProviderUpdateParameters{
		Properties: &armapimanagement.IdentityProviderUpdateProperties{
			ClientID:     to.Ptr("updatedfacebookid"),
			ClientSecret: to.Ptr("updatedfacebooksecret"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IdentityProviderContract = armapimanagement.IdentityProviderContract{
	// 	Name: to.Ptr("AadB2C"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C"),
	// 	Properties: &armapimanagement.IdentityProviderContractProperties{
	// 		Type: to.Ptr(armapimanagement.IdentityProviderTypeAADB2C),
	// 		AllowedTenants: []*string{
	// 			to.Ptr("contosoaadb2c.onmicrosoft.com"),
	// 			to.Ptr("contoso2aadb2c.onmicrosoft.com")},
	// 			Authority: to.Ptr("login.microsoftonline.com"),
	// 			SigninPolicyName: to.Ptr("B2C_1_policy-signin"),
	// 			SigninTenant: to.Ptr("contosoaadb2c.onmicrosoft.com"),
	// 			SignupPolicyName: to.Ptr("B2C_1_policy-signup"),
	// 			ClientID: to.Ptr("f02dafe2-b8b8-48ec-a38e-27e5c16c51e5"),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing IdentityProvider configuration.
 *
 * @summary Updates an existing IdentityProvider configuration.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateIdentityProvider.json
 */
async function apiManagementUpdateIdentityProvider() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const identityProviderName = "facebook";
  const ifMatch = "*";
  const parameters = {
    clientId: "updatedfacebookid",
    clientSecret: "updatedfacebooksecret",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.identityProvider.update(
    resourceGroupName,
    serviceName,
    identityProviderName,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateIdentityProvider.json
// this example is just showing the usage of "IdentityProvider_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementIdentityProviderResource created on azure
// for more information of creating ApiManagementIdentityProviderResource, please refer to the document of ApiManagementIdentityProviderResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
IdentityProviderType identityProviderName = IdentityProviderType.Facebook;
ResourceIdentifier apiManagementIdentityProviderResourceId = ApiManagementIdentityProviderResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, identityProviderName);
ApiManagementIdentityProviderResource apiManagementIdentityProvider = client.GetApiManagementIdentityProviderResource(apiManagementIdentityProviderResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementIdentityProviderPatch patch = new ApiManagementIdentityProviderPatch()
{
    ClientId = "updatedfacebookid",
    ClientSecret = "updatedfacebooksecret",
};
ApiManagementIdentityProviderResource result = await apiManagementIdentityProvider.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementIdentityProviderData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/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
ErrorFieldContract	Błąd Kontrakt pola.
ErrorResponse	Odpowiedź na błąd.
IdentityProviderContract	Szczegóły dostawcy tożsamości.
IdentityProviderType	Identyfikator typu dostawcy tożsamości.
IdentityProviderUpdateParameters	Parametry dostarczone do aktualizacji dostawcy tożsamości

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa	Typ	Opis
code	string	Kod błędu poziomu właściwości.
message	string	Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target	string	Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error.code	string	Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details	ErrorFieldContract[]	Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.
error.message	string	Czytelna dla człowieka reprezentacja błędu.

IdentityProviderContract

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	Nazwa hosta punktu końcowego odnajdywania openID Connect dla usługi AAD lub usługi AAD B2C.
properties.clientId	string	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.clientSecret	string	Klucz 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 dla logowania Google, klucz publiczny dla firmy Microsoft. Ta właściwość nie zostanie wypełniona operacjami "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość.
properties.passwordResetPolicyName	string	Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.profileEditingPolicyName	string	Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinPolicyName	string	Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinTenant	string	Identyfikator dzierżawy do użycia zamiast typowego podczas logowania się do usługi Active Directory
properties.signupPolicyName	string	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

Identyfikator typu dostawcy tożsamości.

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

IdentityProviderUpdateParameters

Parametry dostarczone do aktualizacji dostawcy tożsamości

Nazwa	Typ	Opis
properties.allowedTenants	string[]	Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory.
properties.authority	string	Nazwa hosta punktu końcowego odnajdywania openID Connect dla usługi AAD lub usługi AAD B2C.
properties.clientId	string	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.clientSecret	string	Klucz 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 dla logowania Google, klucz publiczny dla firmy Microsoft.
properties.passwordResetPolicyName	string	Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.profileEditingPolicyName	string	Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinPolicyName	string	Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.signinTenant	string	Identyfikator dzierżawy do użycia zamiast typowego podczas logowania się do usługi Active Directory
properties.signupPolicyName	string	Nazwa zasad rejestracji. Dotyczy tylko dostawcy tożsamości usługi AAD B2C.
properties.type	IdentityProviderType	Identyfikator typu dostawcy tożsamości.