← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

Source code

IdentityProvider

Identity Provider details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateIdentityProvider

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var identityProvider = new AzureNative.ApiManagement.IdentityProvider("identityProvider", new AzureNative.ApiManagement.IdentityProviderArgs
        {
            ClientId = "facebookid",
            ClientSecret = "facebookapplicationsecret",
            IdentityProviderName = "facebook",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
        });
    }

}

package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"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
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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());

        }
}

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

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",
});

resources:
  identityProvider:
    type: azure-native:apimanagement:IdentityProvider
    properties:
      clientId: facebookid
      clientSecret: facebookapplicationsecret
      identityProviderName: facebook
      resourceGroupName: rg1
      serviceName: apimService1

Create a IdentityProvider Resource

new IdentityProvider(name: string, args: IdentityProviderArgs, opts?: CustomResourceOptions);

@overload
def IdentityProvider(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     allowed_tenants: Optional[Sequence[str]] = None,
                     authority: Optional[str] = None,
                     client_id: Optional[str] = None,
                     client_secret: Optional[str] = None,
                     identity_provider_name: Optional[str] = None,
                     password_reset_policy_name: Optional[str] = None,
                     profile_editing_policy_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     service_name: 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)
@overload
def IdentityProvider(resource_name: str,
                     args: IdentityProviderArgs,
                     opts: Optional[ResourceOptions] = 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.

name string: The unique name of the resource.
args IdentityProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args IdentityProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args IdentityProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args IdentityProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

The IdentityProvider resource accepts the following input 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.
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.
ResourceGroupName string: The name of the resource group.
ServiceName 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.
IdentityProviderName 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 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 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 string: The name of the resource group.
ServiceName 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.
IdentityProviderName 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 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 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 String: The name of the resource group.
serviceName String: The name of the API Management service.
allowedTenants List: List of Allowed Tenants when configuring Azure Active Directory login.
authority String: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
identityProviderName 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 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 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 string: The name of the resource group.
serviceName 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.
identityProviderName 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 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 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 str: The name of the resource group.
service_name 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.
identity_provider_name 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 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 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 String: The name of the resource group.
serviceName String: The name of the API Management service.
allowedTenants List: List of Allowed Tenants when configuring Azure Active Directory login.
authority String: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
identityProviderName 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: Resource name.

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.

Supporting Types

IdentityProviderType

Facebook: facebook
Facebook as Identity provider.
Google: google
Google as Identity provider.
Microsoft: microsoft
Microsoft Live as Identity provider.
Twitter: twitter
Twitter as Identity provider.
Aad: aad
Azure Active Directory as Identity provider.
AadB2C: aadB2C
Azure Active Directory B2C as Identity provider.

IdentityProviderTypeFacebook: facebook
Facebook as Identity provider.
IdentityProviderTypeGoogle: google
Google as Identity provider.
IdentityProviderTypeMicrosoft: microsoft
Microsoft Live as Identity provider.
IdentityProviderTypeTwitter: twitter
Twitter as Identity provider.
IdentityProviderTypeAad: aad
Azure Active Directory as Identity provider.
IdentityProviderTypeAadB2C: aadB2C
Azure Active Directory B2C as Identity provider.

Facebook: facebook
Facebook as Identity provider.
Google: google
Google as Identity provider.
Microsoft: microsoft
Microsoft Live as Identity provider.
Twitter: twitter
Twitter as Identity provider.
Aad: aad
Azure Active Directory as Identity provider.
AadB2C: aadB2C
Azure Active Directory B2C as Identity provider.

Facebook: facebook
Facebook as Identity provider.
Google: google
Google as Identity provider.
Microsoft: microsoft
Microsoft Live as Identity provider.
Twitter: twitter
Twitter as Identity provider.
Aad: aad
Azure Active Directory as Identity provider.
AadB2C: aadB2C
Azure Active Directory B2C as Identity provider.

FACEBOOK: facebook
Facebook as Identity provider.
GOOGLE: google
Google as Identity provider.
MICROSOFT: microsoft
Microsoft Live as Identity provider.
TWITTER: twitter
Twitter as Identity provider.
AAD: aad
Azure Active Directory as Identity provider.
AAD_B2_C: aadB2C
Azure Active Directory B2C as Identity provider.

"facebook": facebook
Facebook as Identity provider.
"google": google
Google as Identity provider.
"microsoft": microsoft
Microsoft Live as Identity provider.
"twitter": twitter
Twitter as Identity provider.
"aad": aad
Azure Active Directory as Identity provider.
"aadB2C": aadB2C
Azure 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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0