Identity Provider - Create Or Update

Service:

API Management

Version d'API:

2021-08-01

Crée ou met à jour la configuration IdentityProvider.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
identityProviderName	path	True	IdentityProviderType	Identificateur de type de fournisseur d’identité.
resourceGroupName	path	True	string	Nom du groupe de ressources.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string	Version de l’API à utiliser avec la demande cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.clientId	True	string minLength: 1	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour la connexion Facebook, l’ID client pour la connexion Google, l’ID d’application pour Microsoft.
properties.clientSecret	True	string minLength: 1	Clé secrète client de l’application dans le fournisseur d’identité externe, utilisée pour authentifier la demande de connexion. Par exemple, il s’agit du secret d’application pour la connexion Facebook, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
properties.allowedTenants		string[]	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.
properties.authority		string	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.
properties.passwordResetPolicyName		string minLength: 1	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.profileEditingPolicyName		string minLength: 1	Nom de la stratégie d’édition de profil. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.signinPolicyName		string minLength: 1	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.signinTenant		string	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory
properties.signupPolicyName		string minLength: 1	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.type		IdentityProviderType	Identificateur de type de fournisseur d’identité.

Réponses

Nom	Type	Description
200 OK	IdentityProviderContract	Le fournisseur d’identité existant a été mis à jour. En-têtes ETag: string
201 Created	IdentityProviderContract	La configuration IdentityProvider a été créée avec succès. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementCreateIdentityProvider

Exemple de requête

HTTP

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

{
  "properties": {
    "clientId": "facebookid",
    "clientSecret": "facebookapplicationsecret"
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.IdentityProviderType;

/** Samples for IdentityProvider CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateIdentityProvider.json
     */
    /**
     * Sample code: ApiManagementCreateIdentityProvider.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateIdentityProvider(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .identityProviders()
            .define(IdentityProviderType.FACEBOOK)
            .withExistingService("rg1", "apimService1")
            .withClientId("facebookid")
            .withClientSecret("facebookapplicationsecret")
            .create();
    }
}

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_create_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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        identity_provider_name="facebook",
        parameters={"properties": {"clientId": "facebookid", "clientSecret": "facebookapplicationsecret"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateIdentityProvider.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/ApiManagementCreateIdentityProvider.json
func ExampleIdentityProviderClient_CreateOrUpdate() {
	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().CreateOrUpdate(ctx, "rg1", "apimService1", armapimanagement.IdentityProviderTypeFacebook, armapimanagement.IdentityProviderCreateContract{
		Properties: &armapimanagement.IdentityProviderCreateContractProperties{
			ClientID:     to.Ptr("facebookid"),
			ClientSecret: to.Ptr("facebookapplicationsecret"),
		},
	}, &armapimanagement.IdentityProviderClientCreateOrUpdateOptions{IfMatch: 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("Facebook"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook"),
	// 	Properties: &armapimanagement.IdentityProviderContractProperties{
	// 		Type: to.Ptr(armapimanagement.IdentityProviderTypeFacebook),
	// 		ClientID: to.Ptr("facebookid"),
	// 	},
	// }
}

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 Creates or Updates the IdentityProvider configuration.
 *
 * @summary Creates or Updates the IdentityProvider configuration.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateIdentityProvider.json
 */
async function apiManagementCreateIdentityProvider() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const identityProviderName = "facebook";
  const parameters = {
    clientId: "facebookid",
    clientSecret: "facebookapplicationsecret",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.identityProvider.createOrUpdate(
    resourceGroupName,
    serviceName,
    identityProviderName,
    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/ApiManagementCreateIdentityProvider.json
// this example is just showing the usage of "IdentityProvider_CreateOrUpdate" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementIdentityProviderResource
ApiManagementIdentityProviderCollection collection = apiManagementService.GetApiManagementIdentityProviders();

// invoke the operation
IdentityProviderType identityProviderName = IdentityProviderType.Facebook;
ApiManagementIdentityProviderCreateOrUpdateContent content = new ApiManagementIdentityProviderCreateOrUpdateContent()
{
    ClientId = "facebookid",
    ClientSecret = "facebookapplicationsecret",
};
ArmOperation<ApiManagementIdentityProviderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, identityProviderName, content);
ApiManagementIdentityProviderResource result = lro.Value;

// 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

Exemple de réponse

Code d’état:

201

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

Code d’état:

200

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

Définitions

Nom	Description
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur.
IdentityProviderContract	Détails du fournisseur d’identité.
IdentityProviderCreateContract	Détails du fournisseur d’identité.
IdentityProviderType	Identificateur de type de fournisseur d’identité.

ErrorFieldContract

Object

Contrat de champ d’erreur.

Nom	Type	Description
code	string	Code d’erreur au niveau de la propriété.
message	string	Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target	string	Nom de la propriété.

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error.code	string	Code d’erreur défini par le service. Ce code sert de sous-état pour le code d’erreur HTTP spécifié dans la réponse.
error.details	ErrorFieldContract[]	Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message	string	Représentation lisible par l’homme de l’erreur.

IdentityProviderContract

Object

Détails du fournisseur d’identité.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.allowedTenants	string[]	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.
properties.authority	string	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.
properties.clientId	string minLength: 1	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour la connexion Facebook, l’ID client pour la connexion Google, l’ID d’application pour Microsoft.
properties.clientSecret	string minLength: 1	Clé secrète client de l’application dans le fournisseur d’identité externe, utilisée pour authentifier la demande de connexion. Par exemple, il s’agit du secret d’application pour la connexion Facebook, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
properties.passwordResetPolicyName	string minLength: 1	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.profileEditingPolicyName	string minLength: 1	Nom de la stratégie d’édition de profil. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.signinPolicyName	string minLength: 1	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.signinTenant	string	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory
properties.signupPolicyName	string minLength: 1	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.type	IdentityProviderType	Identificateur de type de fournisseur d’identité.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

IdentityProviderCreateContract

Object

Détails du fournisseur d’identité.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.allowedTenants	string[]	Liste des locataires autorisés lors de la configuration de la connexion Azure Active Directory.
properties.authority	string	Nom d’hôte du point de terminaison de découverte OpenID Connect pour AAD ou AAD B2C.
properties.clientId	string minLength: 1	ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour la connexion Facebook, l’ID client pour la connexion Google, l’ID d’application pour Microsoft.
properties.clientSecret	string minLength: 1	Clé secrète client de l’application dans le fournisseur d’identité externe, utilisée pour authentifier la demande de connexion. Par exemple, il s’agit du secret d’application pour la connexion Facebook, de la clé API pour la connexion Google, de la clé publique pour Microsoft. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
properties.passwordResetPolicyName	string minLength: 1	Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.profileEditingPolicyName	string minLength: 1	Nom de la stratégie d’édition de profil. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.signinPolicyName	string minLength: 1	Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.signinTenant	string	TenantId à utiliser au lieu de Common lors de la connexion à Active Directory
properties.signupPolicyName	string minLength: 1	Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C.
properties.type	IdentityProviderType	Identificateur de type de fournisseur d’identité.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

IdentityProviderType

Énumération

Identificateur de type de fournisseur d’identité.

Valeur	Description
aad	Azure Active Directory en tant que fournisseur d’identité.
aadB2C	Azure Active Directory B2C en tant que fournisseur d’identité.
facebook	Facebook en tant que fournisseur d’identité.
google	Google en tant que fournisseur d’identité.
microsoft	Microsoft Live en tant que fournisseur d’identité.
twitter	Twitter en tant que fournisseur d’identité.