Identity Provider - Get

Referencia

Servicio:: API Management

Versión de la API:: 2024-05-01

Obtiene los detalles de configuración del proveedor de identidades configurado en la instancia de servicio especificada.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
identityProviderName	path	True	IdentityProviderType	Identificador de tipo de proveedor de identidades.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	IdentityProviderContract	El cuerpo de la respuesta contiene los detalles de configuración de la entidad IdentityProvider especificados. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

IdentityProviderContract

El cuerpo de la respuesta contiene los detalles de configuración de la entidad IdentityProvider especificados.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementGetIdentityProvider

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IdentityProviderContract	Detalles del proveedor de identidades.
IdentityProviderType	Identificador de tipo de proveedor de identidades.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IdentityProviderContract

Object

Detalles del proveedor de identidades.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.allowedTenants	string[]	Lista de inquilinos permitidos al configurar el inicio de sesión de Azure Active Directory.
properties.authority	string	Nombre de host del punto de conexión de detección de OpenID Connect para AAD o AAD B2C.
properties.clientId	string minLength: 1	Id. de cliente de la aplicación en el proveedor de identidades externo. Es id. de aplicación para el inicio de sesión de Facebook, id. de cliente para el inicio de sesión de Google, id. de aplicación para Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	Biblioteca cliente que se va a usar en el portal para desarrolladores. Solo se aplica a AAD y AAD B2C Identity Provider.
properties.clientSecret	string minLength: 1	Secreto de cliente de la aplicación en el proveedor de identidades externo, que se usa para autenticar la solicitud de inicio de sesión. Por ejemplo, es Secreto de aplicación para el inicio de sesión de Facebook, clave de API para el inicio de sesión de Google, clave pública para Microsoft. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.
properties.passwordResetPolicyName	string minLength: 1	Nombre de la directiva de restablecimiento de contraseña. Solo se aplica al proveedor de identidades de AAD B2C.
properties.profileEditingPolicyName	string minLength: 1	Nombre de la directiva de edición de perfiles. Solo se aplica al proveedor de identidades de AAD B2C.
properties.signinPolicyName	string minLength: 1	Nombre de la directiva de inicio de sesión. Solo se aplica al proveedor de identidades de AAD B2C.
properties.signinTenant	string	TenantId que se va a usar en lugar de Common al iniciar sesión en Active Directory
properties.signupPolicyName	string minLength: 1	Nombre de la directiva de registro. Solo se aplica al proveedor de identidades de AAD B2C.
properties.type	IdentityProviderType	Identificador de tipo de proveedor de identidades.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IdentityProviderType

Enumeración

Identificador de tipo de proveedor de identidades.

Valor	Description
aad	Azure Active Directory como proveedor de identidades.
aadB2C	Azure Active Directory B2C como proveedor de identidades.
facebook	Facebook como proveedor de identidades.
google	Google como proveedor de identidades.
microsoft	Microsoft Live como proveedor de identidades.
twitter	Twitter como proveedor de identidades.

Compartir a través de

Identity Provider - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementGetIdentityProvider

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProviderContract

IdentityProviderType

Recursos adicionales