Identity Provider - Get

Serviço:

API Management

Versão da API:

2024-05-01

Obtém os detalhes de configuração do Provedor de identidade configurado na instância de serviço 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 URI

Nome	Em	Obrigatório	Tipo	Description
identityProviderName	path	True	IdentityProviderType	Identificador de tipo de provedor de identidade.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	IdentityProviderContract	O corpo da resposta contém os detalhes de configuração da entidade IdentityProvider especificados. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementGetIdentityProvider

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
IdentityProviderContract	Detalhes do Provedor de Identidade.
IdentityProviderType	Identificador de tipo de provedor de identidade.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IdentityProviderContract

Objeto

Detalhes do Provedor de Identidade.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.allowedTenants	string[]	Lista de locatários permitidos ao configurar o logon do Azure Active Directory.
properties.authority	string	Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C.
properties.clientId	string minLength: 1	ID do cliente do aplicativo no Provedor de Identidade externo. É a ID do Aplicativo para logon do Facebook, a ID do Cliente para logon do Google, a ID do aplicativo para a Microsoft.
properties.clientLibrary	string minLength: 0 maxLength: 16	A biblioteca de clientes a ser usada no portal do desenvolvedor. Aplica-se apenas ao AAD e ao Provedor de Identidade B2C do AAD.
properties.clientSecret	string minLength: 1	Segredo do cliente do aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de logon. Por exemplo, é o segredo do aplicativo para logon do Facebook, a Chave de API para logon do Google, a Chave Pública da Microsoft. Essa propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
properties.passwordResetPolicyName	string minLength: 1	Nome da política de redefinição de senha. Aplica-se apenas ao Provedor de Identidade B2C do AAD.
properties.profileEditingPolicyName	string minLength: 1	Nome da política de edição de perfil. Aplica-se apenas ao Provedor de Identidade B2C do AAD.
properties.signinPolicyName	string minLength: 1	Nome da política de entrada. Aplica-se apenas ao Provedor de Identidade B2C do AAD.
properties.signinTenant	string	A TenantId a ser usada em vez de Comum ao fazer logon no Active Directory
properties.signupPolicyName	string minLength: 1	Nome da política de inscrição. Aplica-se apenas ao Provedor de Identidade B2C do AAD.
properties.type	IdentityProviderType	Identificador de tipo de provedor de identidade.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IdentityProviderType

Enumeração

Identificador de tipo de provedor de identidade.

Valor	Description
aad	Azure Active Directory como provedor de identidade.
aadB2C	Azure Active Directory B2C como provedor de identidade.
facebook	Facebook como provedor de identidade.
google	Google como provedor de identidade.
microsoft	Provedor do Microsoft Live como Identidade.
twitter	Twitter como provedor de identidade.