Identity Provider - Update

Service:

API Management

API-versie:

2021-08-01

Hiermee wordt een bestaande IdentityProvider-configuratie bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
identityProviderName	path	True	IdentityProviderType	Id van id-providertype.
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string	Abonnementsreferenties die het Microsoft Azure-abonnement uniek identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.allowedTenants	string[]	Lijst met toegestane tenants bij het configureren van Azure Active Directory-aanmelding.
properties.authority	string	OpenID Connect-detectie-eindpunthostnaam voor AAD of AAD B2C.
properties.clientId	string minLength: 1	Client-id van de toepassing in de externe id-provider. Het is app-id voor Facebook-aanmelding, client-id voor Google-aanmelding, app-id voor Microsoft.
properties.clientSecret	string minLength: 1	Clientgeheim van de toepassing in externe id-provider, die wordt gebruikt om aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld app-geheim voor Facebook-aanmelding, API-sleutel voor Google-aanmelding, openbare sleutel voor Microsoft.
properties.passwordResetPolicyName	string minLength: 1	De beleidsnaam voor het opnieuw instellen van het wachtwoord. Alleen van toepassing op AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.signinTenant	string	De TenantId die moet worden gebruikt in plaats van Common wanneer u zich aanmeldt bij Active Directory
properties.signupPolicyName	string minLength: 1	Naam van registratiebeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.type	IdentityProviderType	Id van id-providertype.

Antwoorden

Name	Type	Description
200 OK	IdentityProviderContract	De bestaande id-provider is bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateIdentityProvider

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
ErrorFieldContract	Foutveldcontract.
ErrorResponse	Foutreactie.
IdentityProviderContract	Details van id-provider.
IdentityProviderType	Id van id-providertype.
IdentityProviderUpdateParameters	Parameters die zijn opgegeven voor het bijwerken van id-provider

ErrorFieldContract

Object

Foutveldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Leesbare weergave van fout op eigenschapsniveau.
target	string	Eigenschapsnaam.

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden die in de aanvraag worden verzonden, in het geval van een validatiefout.
error.message	string	Leesbare weergave van de fout.

IdentityProviderContract

Object

Details van id-provider.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.allowedTenants	string[]	Lijst met toegestane tenants bij het configureren van Azure Active Directory-aanmelding.
properties.authority	string	OpenID Connect-detectie-eindpunthostnaam voor AAD of AAD B2C.
properties.clientId	string minLength: 1	Client-id van de toepassing in de externe id-provider. Het is app-id voor Facebook-aanmelding, client-id voor Google-aanmelding, app-id voor Microsoft.
properties.clientSecret	string minLength: 1	Clientgeheim van de toepassing in externe id-provider, die wordt gebruikt om aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld app-geheim voor Facebook-aanmelding, API-sleutel voor Google-aanmelding, openbare sleutel voor Microsoft. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen.
properties.passwordResetPolicyName	string minLength: 1	De beleidsnaam voor het opnieuw instellen van het wachtwoord. Alleen van toepassing op AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.signinTenant	string	De TenantId die moet worden gebruikt in plaats van Common wanneer u zich aanmeldt bij Active Directory
properties.signupPolicyName	string minLength: 1	Naam van registratiebeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.type	IdentityProviderType	Id van id-providertype.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

IdentityProviderType

Inventarisatie

Id van id-providertype.

Waarde	Description
aad	Azure Active Directory als id-provider.
aadB2C	Azure Active Directory B2C als id-provider.
facebook	Facebook als id-provider.
google	Google als id-provider.
microsoft	Microsoft Live als id-provider.
twitter	Twitter als id-provider.

IdentityProviderUpdateParameters

Object

Parameters die zijn opgegeven voor het bijwerken van id-provider

Name	Type	Description
properties.allowedTenants	string[]	Lijst met toegestane tenants bij het configureren van Azure Active Directory-aanmelding.
properties.authority	string	OpenID Connect-detectie-eindpunthostnaam voor AAD of AAD B2C.
properties.clientId	string minLength: 1	Client-id van de toepassing in de externe id-provider. Het is app-id voor Facebook-aanmelding, client-id voor Google-aanmelding, app-id voor Microsoft.
properties.clientSecret	string minLength: 1	Clientgeheim van de toepassing in externe id-provider, die wordt gebruikt om aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld app-geheim voor Facebook-aanmelding, API-sleutel voor Google-aanmelding, openbare sleutel voor Microsoft.
properties.passwordResetPolicyName	string minLength: 1	De beleidsnaam voor het opnieuw instellen van het wachtwoord. Alleen van toepassing op AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.signinTenant	string	De TenantId die moet worden gebruikt in plaats van Common wanneer u zich aanmeldt bij Active Directory
properties.signupPolicyName	string minLength: 1	Naam van registratiebeleid. Alleen van toepassing op AAD B2C Identity Provider.
properties.type	IdentityProviderType	Id van id-providertype.