Delen via


Identity Provider - Update

Updates een bestaande IdentityProvider-configuratie.

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

De naam van de API Management service.

Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.

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 uit het headerantwoord van de GET-aanvraag of moet * zijn voor 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

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

Clientgeheim van de toepassing in de externe id-provider, die wordt gebruikt om de aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld App-geheim voor Facebook aanmelding, API-sleutel voor Google-aanmelding, Openbare sleutel voor Microsoft.

properties.passwordResetPolicyName

string

Naam van wachtwoordherstelbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.profileEditingPolicyName

string

Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.signinPolicyName

string

Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.signinTenant

string

De TenantId die moet worden gebruikt in plaats van Common bij het aanmelden bij Active Directory

properties.signupPolicyName

string

Naam van registratiebeleid. Alleen van toepassing op AAD B2C-id-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-stroom.

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

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateIdentityProvider

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Fout Veldcontract.

ErrorResponse

Foutreactie.

IdentityProviderContract

Details van id-provider.

IdentityProviderType

Id van id-providertype.

IdentityProviderUpdateParameters

Parameters die zijn opgegeven voor het bijwerken van de id-provider

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

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 verzenden in aanvraag, in het geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

IdentityProviderContract

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

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

Clientgeheim van de toepassing in de externe id-provider, die wordt gebruikt om de 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 bij 'GET'-bewerkingen! Gebruik post-aanvraag '/listSecrets' om de waarde op te halen.

properties.passwordResetPolicyName

string

Naam van wachtwoordherstelbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.profileEditingPolicyName

string

Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.signinPolicyName

string

Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.signinTenant

string

De TenantId die moet worden gebruikt in plaats van Common bij het aanmelden bij Active Directory

properties.signupPolicyName

string

Naam van registratiebeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.type

IdentityProviderType

Id van id-providertype.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

IdentityProviderType

Id van id-providertype.

Name Type Description
aad

string

Azure Active Directory als id-provider.

aadB2C

string

Azure Active Directory B2C als id-provider.

facebook

string

Facebook als id-provider.

google

string

Google als id-provider.

microsoft

string

Microsoft Live als id-provider.

twitter

string

Twitter als id-provider.

IdentityProviderUpdateParameters

Parameters die zijn opgegeven voor het bijwerken van de 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

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

Clientgeheim van de toepassing in de externe id-provider, die wordt gebruikt om de aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld App-geheim voor Facebook aanmelding, API-sleutel voor Google-aanmelding, Openbare sleutel voor Microsoft.

properties.passwordResetPolicyName

string

Naam van wachtwoordherstelbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.profileEditingPolicyName

string

Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.signinPolicyName

string

Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.signinTenant

string

De TenantId die moet worden gebruikt in plaats van Common bij het aanmelden bij Active Directory

properties.signupPolicyName

string

Naam van registratiebeleid. Alleen van toepassing op AAD B2C-id-provider.

properties.type

IdentityProviderType

Id van id-providertype.