Identity Provider - Get

Gets the configuration details of the identity Provider configured in specified service instance.

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

URI Parameters

Name In Required Type Description
identityProviderName
path True

IdentityProviderType

Identity Provider Type identifier.

resourceGroupName
path True

string

The name of the resource group.

serviceName
path True

string

The name of the API Management service.

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

subscriptionId
path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

Version of the API to be used with the client request.

Responses

Name Type Description
200 OK

IdentityProviderContract

The response body contains the specified IdentityProvider entity configuration details.

Headers

ETag: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementGetIdentityProvider

Sample request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C?api-version=2021-08-01

Sample response

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

Definitions

Name Description
ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

IdentityProviderContract

Identity Provider details.

IdentityProviderType

Identity Provider Type identifier.

ErrorFieldContract

Error Field contract.

Name Type Description
code

string

Property level error code.

message

string

Human-readable representation of property-level error.

target

string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code

string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

ErrorFieldContract[]

The list of invalid fields send in request, in case of validation error.

error.message

string

Human-readable representation of the error.

IdentityProviderContract

Identity Provider details.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.allowedTenants

string[]

List of Allowed Tenants when configuring Azure Active Directory login.

properties.authority

string

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

properties.clientId

string

Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.

properties.clientSecret

string

Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

properties.passwordResetPolicyName

string

Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

properties.profileEditingPolicyName

string

Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.

properties.signinPolicyName

string

Signin Policy Name. Only applies to AAD B2C Identity Provider.

properties.signinTenant

string

The TenantId to use instead of Common when logging into Active Directory

properties.signupPolicyName

string

Signup Policy Name. Only applies to AAD B2C Identity Provider.

properties.type

IdentityProviderType

Identity Provider Type identifier.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

IdentityProviderType

Identity Provider Type identifier.

Name Type Description
aad

string

Azure Active Directory as Identity provider.

aadB2C

string

Azure Active Directory B2C as Identity provider.

facebook

string

Facebook as Identity provider.

google

string

Google as Identity provider.

microsoft

string

Microsoft Live as Identity provider.

twitter

string

Twitter as Identity provider.