azure-native.apimanagement.IdentityProvider
Explore with Pulumi AI
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",
});
});
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
})
}
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());
}
}
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 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 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.
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",
});
example, err := apimanagement.NewIdentityProvider(ctx, "identityProviderResource", &apimanagement.IdentityProviderArgs{
ClientSecret: pulumi.String("string"),
ServiceName: pulumi.String("string"),
ClientId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ClientLibrary: pulumi.String("string"),
IdentityProviderName: pulumi.String("string"),
PasswordResetPolicyName: pulumi.String("string"),
ProfileEditingPolicyName: pulumi.String("string"),
AllowedTenants: pulumi.StringArray{
pulumi.String("string"),
},
Authority: pulumi.String("string"),
SigninPolicyName: pulumi.String("string"),
SigninTenant: pulumi.String("string"),
SignupPolicyName: pulumi.String("string"),
Type: pulumi.String("string"),
})
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());
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")
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",
});
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
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:
- Client
Id 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.
- Client
Secret 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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Allowed
Tenants List<string> - List of Allowed Tenants when configuring Azure Active Directory login.
- string
- OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
- Client
Library string - The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
- Identity
Provider stringName - Identity Provider Type identifier.
- Password
Reset stringPolicy Name - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
- Profile
Editing stringPolicy Name - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
- Signin
Policy stringName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
- Signin
Tenant string - The TenantId to use instead of Common when logging into Active Directory
- Signup
Policy stringName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
- Type
string | Pulumi.
Azure Native. Api Management. Identity Provider Type - Identity Provider Type identifier.
- Client
Id 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.
- Client
Secret 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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Allowed
Tenants []string - List of Allowed Tenants when configuring Azure Active Directory login.
- string
- OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
- Client
Library string - The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
- Identity
Provider stringName - Identity Provider Type identifier.
- Password
Reset stringPolicy Name - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
- Profile
Editing stringPolicy Name - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
- Signin
Policy stringName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
- Signin
Tenant string - The TenantId to use instead of Common when logging into Active Directory
- Signup
Policy stringName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
- Type
string | Identity
Provider Type - Identity Provider Type identifier.
- client
Id 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.
- client
Secret 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- allowed
Tenants List<String> - List of Allowed Tenants when configuring Azure Active Directory login.
- String
- OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
- client
Library String - The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
- identity
Provider StringName - Identity Provider Type identifier.
- password
Reset StringPolicy Name - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
- profile
Editing StringPolicy Name - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
- signin
Policy StringName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
- signin
Tenant String - The TenantId to use instead of Common when logging into Active Directory
- signup
Policy StringName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
- type
String | Identity
Provider Type - Identity Provider Type identifier.
- client
Id 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.
- client
Secret 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.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- allowed
Tenants string[] - List of Allowed Tenants when configuring Azure Active Directory login.
- string
- OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
- client
Library string - The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
- identity
Provider stringName - Identity Provider Type identifier.
- password
Reset stringPolicy Name - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
- profile
Editing stringPolicy Name - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
- signin
Policy stringName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
- signin
Tenant string - The TenantId to use instead of Common when logging into Active Directory
- signup
Policy stringName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
- type
string | Identity
Provider Type - 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_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- allowed_
tenants Sequence[str] - List of Allowed Tenants when configuring Azure Active Directory login.
- 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_ strname - Identity Provider Type identifier.
- password_
reset_ strpolicy_ name - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
- profile_
editing_ strpolicy_ name - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
- signin_
policy_ strname - 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_ strname - Signup Policy Name. Only applies to AAD B2C Identity Provider.
- type
str | Identity
Provider Type - Identity Provider Type identifier.
- client
Id 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.
- client
Secret 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- allowed
Tenants List<String> - List of Allowed Tenants when configuring Azure Active Directory login.
- String
- OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
- client
Library String - The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
- identity
Provider StringName - Identity Provider Type identifier.
- password
Reset StringPolicy Name - Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
- profile
Editing StringPolicy Name - Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
- signin
Policy StringName - Signin Policy Name. Only applies to AAD B2C Identity Provider.
- signin
Tenant String - The TenantId to use instead of Common when logging into Active Directory
- signup
Policy StringName - Signup Policy Name. Only applies to AAD B2C Identity Provider.
- type
String | "facebook" | "google" | "microsoft" | "twitter" | "aad" | "aad
B2C" - Identity Provider Type identifier.
Outputs
All input properties are implicitly available as output properties. Additionally, the IdentityProvider resource produces the following output properties:
Supporting Types
IdentityProviderType, IdentityProviderTypeArgs
- facebookFacebook as Identity provider.
- googleGoogle as Identity provider.
- Microsoft
- microsoftMicrosoft Live as Identity provider.
- twitterTwitter as Identity provider.
- Aad
- aadAzure Active Directory as Identity provider.
- Aad
B2C - aadB2CAzure Active Directory B2C as Identity provider.
- Identity
Provider Type Facebook - facebookFacebook as Identity provider.
- Identity
Provider Type Google - googleGoogle as Identity provider.
- Identity
Provider Type Microsoft - microsoftMicrosoft Live as Identity provider.
- Identity
Provider Type Twitter - twitterTwitter as Identity provider.
- Identity
Provider Type Aad - aadAzure Active Directory as Identity provider.
- Identity
Provider Type Aad B2C - aadB2CAzure Active Directory B2C as Identity provider.
- facebookFacebook as Identity provider.
- googleGoogle as Identity provider.
- Microsoft
- microsoftMicrosoft Live as Identity provider.
- twitterTwitter as Identity provider.
- Aad
- aadAzure Active Directory as Identity provider.
- Aad
B2C - aadB2CAzure Active Directory B2C as Identity provider.
- facebookFacebook as Identity provider.
- googleGoogle as Identity provider.
- Microsoft
- microsoftMicrosoft Live as Identity provider.
- twitterTwitter as Identity provider.
- Aad
- aadAzure Active Directory as Identity provider.
- Aad
B2C - aadB2CAzure Active Directory B2C as Identity provider.
- facebookFacebook as Identity provider.
- googleGoogle as Identity provider.
- MICROSOFT
- microsoftMicrosoft Live as Identity provider.
- 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.
- "aad
B2C" - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0