Identity Provider - List By Service

Service:

API Management

API Version:

2021-08-01

Lists a collection of Identity Provider configured in the specified service instance.

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

URI Parameters

Name	In	Required	Type	Description
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	IdentityProviderList	Lists a collection of Identity Providers.
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

ApiManagementListIdentityProviders

Sample request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for IdentityProvider ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListIdentityProviders.json
     */
    /**
     * Sample code: ApiManagementListIdentityProviders.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListIdentityProviders(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.identityProviders().listByService("rg1", "apimService1", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_identity_providers.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.identity_provider.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListIdentityProviders.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListIdentityProviders.json
func ExampleIdentityProviderClient_NewListByServicePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewIdentityProviderClient().NewListByServicePager("rg1", "apimService1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.IdentityProviderList = armapimanagement.IdentityProviderList{
		// 	Count: to.Ptr[int64](3),
		// 	Value: []*armapimanagement.IdentityProviderContract{
		// 		{
		// 			Name: to.Ptr("Google"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google"),
		// 			Properties: &armapimanagement.IdentityProviderContractProperties{
		// 				Type: to.Ptr(armapimanagement.IdentityProviderTypeGoogle),
		// 				ClientID: to.Ptr("googleId"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Aad"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad"),
		// 			Properties: &armapimanagement.IdentityProviderContractProperties{
		// 				Type: to.Ptr(armapimanagement.IdentityProviderTypeAAD),
		// 				AllowedTenants: []*string{
		// 					to.Ptr("samiraad.onmicrosoft.com")},
		// 					ClientID: to.Ptr("aadapplicationid"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("AadB2C"),
		// 				Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
		// 				ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C"),
		// 				Properties: &armapimanagement.IdentityProviderContractProperties{
		// 					Type: to.Ptr(armapimanagement.IdentityProviderTypeAADB2C),
		// 					AllowedTenants: []*string{
		// 						to.Ptr("samirtestbc.onmicrosoft.com")},
		// 						SigninPolicyName: to.Ptr("B2C_1_Signin_Default"),
		// 						SignupPolicyName: to.Ptr("B2C_1_Signup_Default"),
		// 						ClientID: to.Ptr("aadb2clientId"),
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of Identity Provider configured in the specified service instance.
 *
 * @summary Lists a collection of Identity Provider configured in the specified service instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListIdentityProviders.json
 */
async function apiManagementListIdentityProviders() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.identityProvider.listByService(resourceGroupName, serviceName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListIdentityProviders.json
// this example is just showing the usage of "IdentityProvider_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementIdentityProviderResource
ApiManagementIdentityProviderCollection collection = apiManagementService.GetApiManagementIdentityProviders();

// invoke the operation and iterate over the result
await foreach (ApiManagementIdentityProviderResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiManagementIdentityProviderData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Google",
      "type": "Microsoft.ApiManagement/service/identityProviders",
      "name": "Google",
      "properties": {
        "clientId": "googleId",
        "type": "google"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Aad",
      "type": "Microsoft.ApiManagement/service/identityProviders",
      "name": "Aad",
      "properties": {
        "clientId": "aadapplicationid",
        "type": "aad",
        "allowedTenants": [
          "samiraad.onmicrosoft.com"
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C",
      "type": "Microsoft.ApiManagement/service/identityProviders",
      "name": "AadB2C",
      "properties": {
        "clientId": "aadb2clientId",
        "type": "aadB2C",
        "allowedTenants": [
          "samirtestbc.onmicrosoft.com"
        ],
        "signupPolicyName": "B2C_1_Signup_Default",
        "signinPolicyName": "B2C_1_Signin_Default"
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definitions

Name	Description
ErrorFieldContract	Error Field contract.
ErrorResponse	Error Response.
IdentityProviderContract	Identity Provider details.
IdentityProviderList	List of all the Identity Providers configured on the service instance.
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"

IdentityProviderList

List of all the Identity Providers configured on the service instance.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	IdentityProviderContract[]	Identity Provider configuration values.

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.