Identity Provider - Get

Servizio:

API Management

Versione API:

2024-05-01

Ottiene i dettagli di configurazione del provider di identità configurato nell'istanza del servizio specificata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
identityProviderName	path	True	IdentityProviderType	Identificatore del tipo di provider di identità.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	IdentityProviderContract	Il corpo della risposta contiene i dettagli di configurazione dell'entità IdentityProvider specificati. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementGetIdentityProvider

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C?api-version=2024-05-01

Risposta di esempio

Codice di stato:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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"
  }
}

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
IdentityProviderContract	Dettagli del provider di identità.
IdentityProviderType	Identificatore del tipo di provider di identità.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

IdentityProviderContract

Object

Dettagli del provider di identità.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.allowedTenants	string[]	Elenco di tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory.
properties.authority	string	Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C.
properties.clientId	string minLength: 1	ID client dell'applicazione nel provider di identità esterno. Si tratta dell'ID app per l'account di accesso di Facebook, l'ID client per l'account di accesso google, l'ID app per Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e al provider di identità AAD B2C.
properties.clientSecret	string minLength: 1	Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per l'account di accesso di Facebook, chiave API per l'account di accesso google, chiave pubblica per Microsoft. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.passwordResetPolicyName	string minLength: 1	Nome criterio di reimpostazione della password. Si applica solo al provider di identità AAD B2C.
properties.profileEditingPolicyName	string minLength: 1	Nome criterio di modifica del profilo. Si applica solo al provider di identità AAD B2C.
properties.signinPolicyName	string minLength: 1	Nome criterio di accesso. Si applica solo al provider di identità AAD B2C.
properties.signinTenant	string	TenantId da usare invece di Common durante l'accesso ad Active Directory
properties.signupPolicyName	string minLength: 1	Nome criterio di iscrizione. Si applica solo al provider di identità AAD B2C.
properties.type	IdentityProviderType	Identificatore del tipo di provider di identità.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IdentityProviderType

Enumerazione

Identificatore del tipo di provider di identità.

Valore	Descrizione
aad	Azure Active Directory come provider di identità.
aadB2C	Azure Active Directory B2C come provider di identità.
facebook	Facebook come provider di identità.
google	Google come provider di identità.
microsoft	Microsoft Live come provider di identità.
twitter	Twitter come provider di identità.