Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. IdentityProvider
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.IdentityProvider

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Identity Provider details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.

Other available API versions: 2016-10-10, 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Example Usage

ApiManagementCreateIdentityProvider

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var identityProvider = new AzureNative.ApiManagement.IdentityProvider("identityProvider", new()
    {
        ClientId = "facebookid",
        ClientSecret = "facebookapplicationsecret",
        IdentityProviderName = "facebook",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewIdentityProvider(ctx, "identityProvider", &apimanagement.IdentityProviderArgs{
			ClientId:             pulumi.String("facebookid"),
			ClientSecret:         pulumi.String("facebookapplicationsecret"),
			IdentityProviderName: pulumi.String("facebook"),
			ResourceGroupName:    pulumi.String("rg1"),
			ServiceName:          pulumi.String("apimService1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.IdentityProvider;
import com.pulumi.azurenative.apimanagement.IdentityProviderArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var identityProvider = new IdentityProvider("identityProvider", IdentityProviderArgs.builder()
            .clientId("facebookid")
            .clientSecret("facebookapplicationsecret")
            .identityProviderName("facebook")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const identityProvider = new azure_native.apimanagement.IdentityProvider("identityProvider", {
    clientId: "facebookid",
    clientSecret: "facebookapplicationsecret",
    identityProviderName: "facebook",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

identity_provider = azure_native.apimanagement.IdentityProvider("identityProvider",
    client_id="facebookid",
    client_secret="facebookapplicationsecret",
    identity_provider_name="facebook",
    resource_group_name="rg1",
    service_name="apimService1")
Copy
resources:
  identityProvider:
    type: azure-native:apimanagement:IdentityProvider
    properties:
      clientId: facebookid
      clientSecret: facebookapplicationsecret
      identityProviderName: facebook
      resourceGroupName: rg1
      serviceName: apimService1
Copy

Create IdentityProvider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IdentityProvider(name: string, args: IdentityProviderArgs, opts?: CustomResourceOptions);
@overload
def IdentityProvider(resource_name: str,
                     args: IdentityProviderArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def IdentityProvider(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     client_secret: Optional[str] = None,
                     service_name: Optional[str] = None,
                     client_id: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     client_library: Optional[str] = None,
                     identity_provider_name: Optional[str] = None,
                     password_reset_policy_name: Optional[str] = None,
                     profile_editing_policy_name: Optional[str] = None,
                     allowed_tenants: Optional[Sequence[str]] = None,
                     authority: Optional[str] = None,
                     signin_policy_name: Optional[str] = None,
                     signin_tenant: Optional[str] = None,
                     signup_policy_name: Optional[str] = None,
                     type: Optional[Union[str, IdentityProviderType]] = None)
func NewIdentityProvider(ctx *Context, name string, args IdentityProviderArgs, opts ...ResourceOption) (*IdentityProvider, error)
public IdentityProvider(string name, IdentityProviderArgs args, CustomResourceOptions? opts = null)
public IdentityProvider(String name, IdentityProviderArgs args)
public IdentityProvider(String name, IdentityProviderArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:IdentityProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IdentityProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IdentityProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IdentityProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IdentityProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IdentityProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var identityProviderResource = new AzureNative.Apimanagement.IdentityProvider("identityProviderResource", new()
{
    ClientSecret = "string",
    ServiceName = "string",
    ClientId = "string",
    ResourceGroupName = "string",
    ClientLibrary = "string",
    IdentityProviderName = "string",
    PasswordResetPolicyName = "string",
    ProfileEditingPolicyName = "string",
    AllowedTenants = new[]
    {
        "string",
    },
    Authority = "string",
    SigninPolicyName = "string",
    SigninTenant = "string",
    SignupPolicyName = "string",
    Type = "string",
});
Copy
example, err := apimanagement.NewIdentityProvider(ctx, "identityProviderResource", &apimanagement.IdentityProviderArgs{
	ClientSecret:             "string",
	ServiceName:              "string",
	ClientId:                 "string",
	ResourceGroupName:        "string",
	ClientLibrary:            "string",
	IdentityProviderName:     "string",
	PasswordResetPolicyName:  "string",
	ProfileEditingPolicyName: "string",
	AllowedTenants: []string{
		"string",
	},
	Authority:        "string",
	SigninPolicyName: "string",
	SigninTenant:     "string",
	SignupPolicyName: "string",
	Type:             "string",
})
Copy
var identityProviderResource = new IdentityProvider("identityProviderResource", IdentityProviderArgs.builder()
    .clientSecret("string")
    .serviceName("string")
    .clientId("string")
    .resourceGroupName("string")
    .clientLibrary("string")
    .identityProviderName("string")
    .passwordResetPolicyName("string")
    .profileEditingPolicyName("string")
    .allowedTenants("string")
    .authority("string")
    .signinPolicyName("string")
    .signinTenant("string")
    .signupPolicyName("string")
    .type("string")
    .build());
Copy
identity_provider_resource = azure_native.apimanagement.IdentityProvider("identityProviderResource",
    client_secret=string,
    service_name=string,
    client_id=string,
    resource_group_name=string,
    client_library=string,
    identity_provider_name=string,
    password_reset_policy_name=string,
    profile_editing_policy_name=string,
    allowed_tenants=[string],
    authority=string,
    signin_policy_name=string,
    signin_tenant=string,
    signup_policy_name=string,
    type=string)
Copy
const identityProviderResource = new azure_native.apimanagement.IdentityProvider("identityProviderResource", {
    clientSecret: "string",
    serviceName: "string",
    clientId: "string",
    resourceGroupName: "string",
    clientLibrary: "string",
    identityProviderName: "string",
    passwordResetPolicyName: "string",
    profileEditingPolicyName: "string",
    allowedTenants: ["string"],
    authority: "string",
    signinPolicyName: "string",
    signinTenant: "string",
    signupPolicyName: "string",
    type: "string",
});
Copy
type: azure-native:apimanagement:IdentityProvider
properties:
    allowedTenants:
        - string
    authority: string
    clientId: string
    clientLibrary: string
    clientSecret: string
    identityProviderName: string
    passwordResetPolicyName: string
    profileEditingPolicyName: string
    resourceGroupName: string
    serviceName: string
    signinPolicyName: string
    signinTenant: string
    signupPolicyName: string
    type: string
Copy

IdentityProvider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The IdentityProvider resource accepts the following input properties:

ClientId This property is required. 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.
ClientSecret This property is required. 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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
AllowedTenants List<string>
List of Allowed Tenants when configuring Azure Active Directory login.
Authority string
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
ClientLibrary string
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
IdentityProviderName Changes to this property will trigger replacement. string
Identity Provider Type identifier.
PasswordResetPolicyName string
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName string
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName string
Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninTenant string
The TenantId to use instead of Common when logging into Active Directory
SignupPolicyName string
Signup Policy Name. Only applies to AAD B2C Identity Provider.
Type string | Pulumi.AzureNative.ApiManagement.IdentityProviderType
Identity Provider Type identifier.
ClientId This property is required. 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.
ClientSecret This property is required. 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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
AllowedTenants []string
List of Allowed Tenants when configuring Azure Active Directory login.
Authority string
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
ClientLibrary string
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
IdentityProviderName Changes to this property will trigger replacement. string
Identity Provider Type identifier.
PasswordResetPolicyName string
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
ProfileEditingPolicyName string
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
SigninPolicyName string
Signin Policy Name. Only applies to AAD B2C Identity Provider.
SigninTenant string
The TenantId to use instead of Common when logging into Active Directory
SignupPolicyName string
Signup Policy Name. Only applies to AAD B2C Identity Provider.
Type string | IdentityProviderType
Identity Provider Type identifier.
clientId This property is required. 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.
clientSecret This property is required. 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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
allowedTenants List<String>
List of Allowed Tenants when configuring Azure Active Directory login.
authority String
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary String
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
identityProviderName Changes to this property will trigger replacement. String
Identity Provider Type identifier.
passwordResetPolicyName String
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName String
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName String
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant String
The TenantId to use instead of Common when logging into Active Directory
signupPolicyName String
Signup Policy Name. Only applies to AAD B2C Identity Provider.
type String | IdentityProviderType
Identity Provider Type identifier.
clientId This property is required. 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.
clientSecret This property is required. 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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
allowedTenants string[]
List of Allowed Tenants when configuring Azure Active Directory login.
authority string
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary string
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
identityProviderName Changes to this property will trigger replacement. string
Identity Provider Type identifier.
passwordResetPolicyName string
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName string
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName string
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant string
The TenantId to use instead of Common when logging into Active Directory
signupPolicyName string
Signup Policy Name. Only applies to AAD B2C Identity Provider.
type string | IdentityProviderType
Identity Provider Type identifier.
client_id This property is required. str
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.
client_secret This property is required. str
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
allowed_tenants Sequence[str]
List of Allowed Tenants when configuring Azure Active Directory login.
authority str
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
client_library str
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
identity_provider_name Changes to this property will trigger replacement. str
Identity Provider Type identifier.
password_reset_policy_name str
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name str
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name str
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signin_tenant str
The TenantId to use instead of Common when logging into Active Directory
signup_policy_name str
Signup Policy Name. Only applies to AAD B2C Identity Provider.
type str | IdentityProviderType
Identity Provider Type identifier.
clientId This property is required. 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.
clientSecret This property is required. 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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
allowedTenants List<String>
List of Allowed Tenants when configuring Azure Active Directory login.
authority String
OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary String
The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
identityProviderName Changes to this property will trigger replacement. String
Identity Provider Type identifier.
passwordResetPolicyName String
Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName String
Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName String
Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant String
The TenantId to use instead of Common when logging into Active Directory
signupPolicyName String
Signup Policy Name. Only applies to AAD B2C Identity Provider.
type String | "facebook" | "google" | "microsoft" | "twitter" | "aad" | "aadB2C"
Identity Provider Type identifier.

Outputs

All input properties are implicitly available as output properties. Additionally, the IdentityProvider resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource

Supporting Types

IdentityProviderType
, IdentityProviderTypeArgs

Facebook
facebookFacebook as Identity provider.
Google
googleGoogle as Identity provider.
Microsoft
microsoftMicrosoft Live as Identity provider.
Twitter
twitterTwitter as Identity provider.
Aad
aadAzure Active Directory as Identity provider.
AadB2C
aadB2CAzure Active Directory B2C as Identity provider.
IdentityProviderTypeFacebook
facebookFacebook as Identity provider.
IdentityProviderTypeGoogle
googleGoogle as Identity provider.
IdentityProviderTypeMicrosoft
microsoftMicrosoft Live as Identity provider.
IdentityProviderTypeTwitter
twitterTwitter as Identity provider.
IdentityProviderTypeAad
aadAzure Active Directory as Identity provider.
IdentityProviderTypeAadB2C
aadB2CAzure Active Directory B2C as Identity provider.
Facebook
facebookFacebook as Identity provider.
Google
googleGoogle as Identity provider.
Microsoft
microsoftMicrosoft Live as Identity provider.
Twitter
twitterTwitter as Identity provider.
Aad
aadAzure Active Directory as Identity provider.
AadB2C
aadB2CAzure Active Directory B2C as Identity provider.
Facebook
facebookFacebook as Identity provider.
Google
googleGoogle as Identity provider.
Microsoft
microsoftMicrosoft Live as Identity provider.
Twitter
twitterTwitter as Identity provider.
Aad
aadAzure Active Directory as Identity provider.
AadB2C
aadB2CAzure Active Directory B2C as Identity provider.
FACEBOOK
facebookFacebook as Identity provider.
GOOGLE
googleGoogle as Identity provider.
MICROSOFT
microsoftMicrosoft Live as Identity provider.
TWITTER
twitterTwitter as Identity provider.
AAD
aadAzure Active Directory as Identity provider.
AAD_B2_C
aadB2CAzure Active Directory B2C as Identity provider.
"facebook"
facebookFacebook as Identity provider.
"google"
googleGoogle as Identity provider.
"microsoft"
microsoftMicrosoft Live as Identity provider.
"twitter"
twitterTwitter as Identity provider.
"aad"
aadAzure Active Directory as Identity provider.
"aadB2C"
aadB2CAzure Active Directory B2C as Identity provider.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:IdentityProvider Facebook /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native