Identity Provider - Update
Mises à jour une configuration IdentityProvider existante.
PATCH 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 |
---|---|---|---|---|
identity
|
path | True |
Identificateur du type de fournisseur d’identité. |
|
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
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 pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande du client. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
If-Match | True |
string |
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle. |
Corps de la demande
Nom | Type | Description |
---|---|---|
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 |
ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour Facebook connexion, de l’ID client pour la connexion Google, de l’ID d’application pour Microsoft. |
properties.clientSecret |
string |
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 Facebook connexion, de la clé API pour la connexion Google, de la clé publique pour Microsoft. |
properties.passwordResetPolicyName |
string |
Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.profileEditingPolicyName |
string |
Nom de la stratégie de modification de profil. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.signinPolicyName |
string |
Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.signinTenant |
string |
TenantId à utiliser au lieu de Commun lors de la connexion à Active Directory |
properties.signupPolicyName |
string |
Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.type |
Identificateur du type de fournisseur d’identité. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Le fournisseur d’identité existant a été correctement mis à jour. En-têtes ETag: string |
|
Other Status Codes |
Réponse d’erreur décrivant la raison de l’échec de l’opération. |
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
ApiManagementUpdateIdentityProvider
Exemple de requête
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"
}
}
Exemple de réponse
{
"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"
}
}
Définitions
Nom | Description |
---|---|
Error |
Contrat de champ d’erreur. |
Error |
Réponse d’erreur. |
Identity |
Détails du fournisseur d’identité. |
Identity |
Identificateur du type de fournisseur d’identité. |
Identity |
Paramètres fournis pour mettre à jour le fournisseur d’identité |
ErrorFieldContract
Contrat de champ d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Code d'erreur de niveau propriété. |
message |
string |
Représentation lisible par l’homme de l’erreur au niveau des propriétés. |
target |
string |
Nom de propriété. |
ErrorResponse
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 |
Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation. |
|
error.message |
string |
Représentation contrôlable de visu de l’erreur. |
IdentityProviderContract
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 |
ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour Facebook connexion, de l’ID client pour la connexion Google, de l’ID d’application pour Microsoft. |
properties.clientSecret |
string |
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 Facebook connexion, 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 |
Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.profileEditingPolicyName |
string |
Nom de la stratégie de modification de profil. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.signinPolicyName |
string |
Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.signinTenant |
string |
TenantId à utiliser au lieu de Commun lors de la connexion à Active Directory |
properties.signupPolicyName |
string |
Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.type |
Identificateur du type de fournisseur d’identité. |
|
type |
string |
Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » |
IdentityProviderType
Identificateur du type de fournisseur d’identité.
Nom | Type | Description |
---|---|---|
aad |
string |
Azure Active Directory en tant que fournisseur d’identité. |
aadB2C |
string |
Azure Active Directory B2C en tant que fournisseur d’identité. |
string |
Facebook en tant que fournisseur d’identité. |
|
string |
Google en tant que fournisseur d’identité. |
|
microsoft |
string |
Microsoft Live en tant que fournisseur d’identité. |
string |
Twitter en tant que fournisseur d’identité. |
IdentityProviderUpdateParameters
Paramètres fournis pour mettre à jour le fournisseur d’identité
Nom | Type | Description |
---|---|---|
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 |
ID client de l’application dans le fournisseur d’identité externe. Il s’agit de l’ID d’application pour Facebook connexion, de l’ID client pour la connexion Google, de l’ID d’application pour Microsoft. |
properties.clientSecret |
string |
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 Facebook connexion, de la clé API pour la connexion Google, de la clé publique pour Microsoft. |
properties.passwordResetPolicyName |
string |
Nom de la stratégie de réinitialisation de mot de passe. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.profileEditingPolicyName |
string |
Nom de la stratégie de modification de profil. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.signinPolicyName |
string |
Nom de la stratégie de connexion. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.signinTenant |
string |
TenantId à utiliser au lieu de Commun lors de la connexion à Active Directory |
properties.signupPolicyName |
string |
Nom de la stratégie d’inscription. S’applique uniquement au fournisseur d’identité AAD B2C. |
properties.type |
Identificateur du type de fournisseur d’identité. |