Manages an Azure AD/Entra ID connector in Dex using the generic OIDC connector (type: oidc). This connector allows users to authenticate using their Azure AD/Entra ID credentials.
Create AzureOidcConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AzureOidcConnector(name: string, args: AzureOidcConnectorArgs, opts?: CustomResourceOptions);@overload
def AzureOidcConnector(resource_name: str,
args: AzureOidcConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AzureOidcConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
connector_id: Optional[str] = None,
name: Optional[str] = None,
redirect_uri: Optional[str] = None,
tenant_id: Optional[str] = None,
extra_oidc: Optional[Mapping[str, Any]] = None,
scopes: Optional[Sequence[str]] = None,
user_name_source: Optional[str] = None)func NewAzureOidcConnector(ctx *Context, name string, args AzureOidcConnectorArgs, opts ...ResourceOption) (*AzureOidcConnector, error)public AzureOidcConnector(string name, AzureOidcConnectorArgs args, CustomResourceOptions? opts = null)
public AzureOidcConnector(String name, AzureOidcConnectorArgs args)
public AzureOidcConnector(String name, AzureOidcConnectorArgs args, CustomResourceOptions options)
type: dex:resources:AzureOidcConnector
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 AzureOidcConnectorArgs
- 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 AzureOidcConnectorArgs
- 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 AzureOidcConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AzureOidcConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AzureOidcConnectorArgs
- 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 azureOidcConnectorResource = new Dex.Resources.AzureOidcConnector("azureOidcConnectorResource", new()
{
ClientId = "string",
ClientSecret = "string",
ConnectorId = "string",
Name = "string",
RedirectUri = "string",
TenantId = "string",
ExtraOidc =
{
{ "string", "any" },
},
Scopes = new[]
{
"string",
},
UserNameSource = "string",
});
example, err := resources.NewAzureOidcConnector(ctx, "azureOidcConnectorResource", &resources.AzureOidcConnectorArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ConnectorId: pulumi.String("string"),
Name: pulumi.String("string"),
RedirectUri: pulumi.String("string"),
TenantId: pulumi.String("string"),
ExtraOidc: pulumi.Map{
"string": pulumi.Any("any"),
},
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
UserNameSource: pulumi.String("string"),
})
var azureOidcConnectorResource = new AzureOidcConnector("azureOidcConnectorResource", AzureOidcConnectorArgs.builder()
.clientId("string")
.clientSecret("string")
.connectorId("string")
.name("string")
.redirectUri("string")
.tenantId("string")
.extraOidc(Map.of("string", "any"))
.scopes("string")
.userNameSource("string")
.build());
azure_oidc_connector_resource = dex.resources.AzureOidcConnector("azureOidcConnectorResource",
client_id="string",
client_secret="string",
connector_id="string",
name="string",
redirect_uri="string",
tenant_id="string",
extra_oidc={
"string": "any",
},
scopes=["string"],
user_name_source="string")
const azureOidcConnectorResource = new dex.resources.AzureOidcConnector("azureOidcConnectorResource", {
clientId: "string",
clientSecret: "string",
connectorId: "string",
name: "string",
redirectUri: "string",
tenantId: "string",
extraOidc: {
string: "any",
},
scopes: ["string"],
userNameSource: "string",
});
type: dex:resources:AzureOidcConnector
properties:
clientId: string
clientSecret: string
connectorId: string
extraOidc:
string: any
name: string
redirectUri: string
scopes:
- string
tenantId: string
userNameSource: string
AzureOidcConnector 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 AzureOidcConnector resource accepts the following input properties:
- Client
Id string - Azure AD application (client) ID.
- Client
Secret string - Azure AD application client secret.
- Connector
Id string - Unique identifier for the Azure connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in Azure AD. Must match Dex's callback URL (typically 'https://dex.example.com/callback').
- Tenant
Id string - Azure AD tenant ID (UUID format). This identifies your Azure AD organization.
- Extra
Oidc Dictionary<string, object> - Additional OIDC configuration fields as key-value pairs for advanced scenarios.
- Scopes List<string>
- OIDC scopes to request from Azure AD. Defaults to ['openid', 'profile', 'email', 'offline_access'] if not specified.
- User
Name stringSource - Source for the username claim. Valid values: 'preferred_username' (default), 'upn' (User Principal Name), or 'email'.
- Client
Id string - Azure AD application (client) ID.
- Client
Secret string - Azure AD application client secret.
- Connector
Id string - Unique identifier for the Azure connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in Azure AD. Must match Dex's callback URL (typically 'https://dex.example.com/callback').
- Tenant
Id string - Azure AD tenant ID (UUID format). This identifies your Azure AD organization.
- Extra
Oidc map[string]interface{} - Additional OIDC configuration fields as key-value pairs for advanced scenarios.
- Scopes []string
- OIDC scopes to request from Azure AD. Defaults to ['openid', 'profile', 'email', 'offline_access'] if not specified.
- User
Name stringSource - Source for the username claim. Valid values: 'preferred_username' (default), 'upn' (User Principal Name), or 'email'.
- client
Id String - Azure AD application (client) ID.
- client
Secret String - Azure AD application client secret.
- connector
Id String - Unique identifier for the Azure connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in Azure AD. Must match Dex's callback URL (typically 'https://dex.example.com/callback').
- tenant
Id String - Azure AD tenant ID (UUID format). This identifies your Azure AD organization.
- extra
Oidc Map<String,Object> - Additional OIDC configuration fields as key-value pairs for advanced scenarios.
- scopes List<String>
- OIDC scopes to request from Azure AD. Defaults to ['openid', 'profile', 'email', 'offline_access'] if not specified.
- user
Name StringSource - Source for the username claim. Valid values: 'preferred_username' (default), 'upn' (User Principal Name), or 'email'.
- client
Id string - Azure AD application (client) ID.
- client
Secret string - Azure AD application client secret.
- connector
Id string - Unique identifier for the Azure connector.
- name string
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri string - Redirect URI registered in Azure AD. Must match Dex's callback URL (typically 'https://dex.example.com/callback').
- tenant
Id string - Azure AD tenant ID (UUID format). This identifies your Azure AD organization.
- extra
Oidc {[key: string]: any} - Additional OIDC configuration fields as key-value pairs for advanced scenarios.
- scopes string[]
- OIDC scopes to request from Azure AD. Defaults to ['openid', 'profile', 'email', 'offline_access'] if not specified.
- user
Name stringSource - Source for the username claim. Valid values: 'preferred_username' (default), 'upn' (User Principal Name), or 'email'.
- client_
id str - Azure AD application (client) ID.
- client_
secret str - Azure AD application client secret.
- connector_
id str - Unique identifier for the Azure connector.
- name str
- Human-readable name for the connector, displayed to users during login.
- redirect_
uri str - Redirect URI registered in Azure AD. Must match Dex's callback URL (typically 'https://dex.example.com/callback').
- tenant_
id str - Azure AD tenant ID (UUID format). This identifies your Azure AD organization.
- extra_
oidc Mapping[str, Any] - Additional OIDC configuration fields as key-value pairs for advanced scenarios.
- scopes Sequence[str]
- OIDC scopes to request from Azure AD. Defaults to ['openid', 'profile', 'email', 'offline_access'] if not specified.
- user_
name_ strsource - Source for the username claim. Valid values: 'preferred_username' (default), 'upn' (User Principal Name), or 'email'.
- client
Id String - Azure AD application (client) ID.
- client
Secret String - Azure AD application client secret.
- connector
Id String - Unique identifier for the Azure connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in Azure AD. Must match Dex's callback URL (typically 'https://dex.example.com/callback').
- tenant
Id String - Azure AD tenant ID (UUID format). This identifies your Azure AD organization.
- extra
Oidc Map<Any> - Additional OIDC configuration fields as key-value pairs for advanced scenarios.
- scopes List<String>
- OIDC scopes to request from Azure AD. Defaults to ['openid', 'profile', 'email', 'offline_access'] if not specified.
- user
Name StringSource - Source for the username claim. Valid values: 'preferred_username' (default), 'upn' (User Principal Name), or 'email'.
Outputs
All input properties are implicitly available as output properties. Additionally, the AzureOidcConnector resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- dex kotaicode/pulumi-dex
- License
