Manages a Google connector in Dex. This connector allows users to authenticate using their Google accounts and supports domain and group-based access control.
Create GoogleConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GoogleConnector(name: string, args: GoogleConnectorArgs, opts?: CustomResourceOptions);@overload
def GoogleConnector(resource_name: str,
args: GoogleConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GoogleConnector(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,
domain_to_admin_email: Optional[Mapping[str, str]] = None,
groups: Optional[Sequence[str]] = None,
hosted_domains: Optional[Sequence[str]] = None,
prompt_type: Optional[str] = None,
service_account_file_path: Optional[str] = None)func NewGoogleConnector(ctx *Context, name string, args GoogleConnectorArgs, opts ...ResourceOption) (*GoogleConnector, error)public GoogleConnector(string name, GoogleConnectorArgs args, CustomResourceOptions? opts = null)
public GoogleConnector(String name, GoogleConnectorArgs args)
public GoogleConnector(String name, GoogleConnectorArgs args, CustomResourceOptions options)
type: dex:resources:GoogleConnector
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 GoogleConnectorArgs
- 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 GoogleConnectorArgs
- 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 GoogleConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GoogleConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GoogleConnectorArgs
- 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 googleConnectorResource = new Dex.Resources.GoogleConnector("googleConnectorResource", new()
{
ClientId = "string",
ClientSecret = "string",
ConnectorId = "string",
Name = "string",
RedirectUri = "string",
DomainToAdminEmail =
{
{ "string", "string" },
},
Groups = new[]
{
"string",
},
HostedDomains = new[]
{
"string",
},
PromptType = "string",
ServiceAccountFilePath = "string",
});
example, err := resources.NewGoogleConnector(ctx, "googleConnectorResource", &resources.GoogleConnectorArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ConnectorId: pulumi.String("string"),
Name: pulumi.String("string"),
RedirectUri: pulumi.String("string"),
DomainToAdminEmail: pulumi.StringMap{
"string": pulumi.String("string"),
},
Groups: pulumi.StringArray{
pulumi.String("string"),
},
HostedDomains: pulumi.StringArray{
pulumi.String("string"),
},
PromptType: pulumi.String("string"),
ServiceAccountFilePath: pulumi.String("string"),
})
var googleConnectorResource = new GoogleConnector("googleConnectorResource", GoogleConnectorArgs.builder()
.clientId("string")
.clientSecret("string")
.connectorId("string")
.name("string")
.redirectUri("string")
.domainToAdminEmail(Map.of("string", "string"))
.groups("string")
.hostedDomains("string")
.promptType("string")
.serviceAccountFilePath("string")
.build());
google_connector_resource = dex.resources.GoogleConnector("googleConnectorResource",
client_id="string",
client_secret="string",
connector_id="string",
name="string",
redirect_uri="string",
domain_to_admin_email={
"string": "string",
},
groups=["string"],
hosted_domains=["string"],
prompt_type="string",
service_account_file_path="string")
const googleConnectorResource = new dex.resources.GoogleConnector("googleConnectorResource", {
clientId: "string",
clientSecret: "string",
connectorId: "string",
name: "string",
redirectUri: "string",
domainToAdminEmail: {
string: "string",
},
groups: ["string"],
hostedDomains: ["string"],
promptType: "string",
serviceAccountFilePath: "string",
});
type: dex:resources:GoogleConnector
properties:
clientId: string
clientSecret: string
connectorId: string
domainToAdminEmail:
string: string
groups:
- string
hostedDomains:
- string
name: string
promptType: string
redirectUri: string
serviceAccountFilePath: string
GoogleConnector 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 GoogleConnector resource accepts the following input properties:
- Client
Id string - Google OAuth client ID.
- Client
Secret string - Google OAuth client secret.
- Connector
Id string - Unique identifier for the Google connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in Google OAuth app. Must match Dex's callback URL.
- Domain
To Dictionary<string, string>Admin Email - Map of domain names to admin email addresses. Used for group lookups in Google Workspace.
- Groups List<string>
- List of Google Groups. Only users in these groups will be allowed to authenticate.
- Hosted
Domains List<string> - List of Google Workspace domains. Only users with email addresses in these domains will be allowed to authenticate.
- Prompt
Type string - OAuth prompt type. Valid values: 'consent' (default) or 'select_account'.
- Service
Account stringFile Path - Path to Google service account JSON file. Required for group-based access control.
- Client
Id string - Google OAuth client ID.
- Client
Secret string - Google OAuth client secret.
- Connector
Id string - Unique identifier for the Google connector.
- Name string
- Human-readable name for the connector, displayed to users during login.
- Redirect
Uri string - Redirect URI registered in Google OAuth app. Must match Dex's callback URL.
- Domain
To map[string]stringAdmin Email - Map of domain names to admin email addresses. Used for group lookups in Google Workspace.
- Groups []string
- List of Google Groups. Only users in these groups will be allowed to authenticate.
- Hosted
Domains []string - List of Google Workspace domains. Only users with email addresses in these domains will be allowed to authenticate.
- Prompt
Type string - OAuth prompt type. Valid values: 'consent' (default) or 'select_account'.
- Service
Account stringFile Path - Path to Google service account JSON file. Required for group-based access control.
- client
Id String - Google OAuth client ID.
- client
Secret String - Google OAuth client secret.
- connector
Id String - Unique identifier for the Google connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in Google OAuth app. Must match Dex's callback URL.
- domain
To Map<String,String>Admin Email - Map of domain names to admin email addresses. Used for group lookups in Google Workspace.
- groups List<String>
- List of Google Groups. Only users in these groups will be allowed to authenticate.
- hosted
Domains List<String> - List of Google Workspace domains. Only users with email addresses in these domains will be allowed to authenticate.
- prompt
Type String - OAuth prompt type. Valid values: 'consent' (default) or 'select_account'.
- service
Account StringFile Path - Path to Google service account JSON file. Required for group-based access control.
- client
Id string - Google OAuth client ID.
- client
Secret string - Google OAuth client secret.
- connector
Id string - Unique identifier for the Google connector.
- name string
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri string - Redirect URI registered in Google OAuth app. Must match Dex's callback URL.
- domain
To {[key: string]: string}Admin Email - Map of domain names to admin email addresses. Used for group lookups in Google Workspace.
- groups string[]
- List of Google Groups. Only users in these groups will be allowed to authenticate.
- hosted
Domains string[] - List of Google Workspace domains. Only users with email addresses in these domains will be allowed to authenticate.
- prompt
Type string - OAuth prompt type. Valid values: 'consent' (default) or 'select_account'.
- service
Account stringFile Path - Path to Google service account JSON file. Required for group-based access control.
- client_
id str - Google OAuth client ID.
- client_
secret str - Google OAuth client secret.
- connector_
id str - Unique identifier for the Google connector.
- name str
- Human-readable name for the connector, displayed to users during login.
- redirect_
uri str - Redirect URI registered in Google OAuth app. Must match Dex's callback URL.
- domain_
to_ Mapping[str, str]admin_ email - Map of domain names to admin email addresses. Used for group lookups in Google Workspace.
- groups Sequence[str]
- List of Google Groups. Only users in these groups will be allowed to authenticate.
- hosted_
domains Sequence[str] - List of Google Workspace domains. Only users with email addresses in these domains will be allowed to authenticate.
- prompt_
type str - OAuth prompt type. Valid values: 'consent' (default) or 'select_account'.
- service_
account_ strfile_ path - Path to Google service account JSON file. Required for group-based access control.
- client
Id String - Google OAuth client ID.
- client
Secret String - Google OAuth client secret.
- connector
Id String - Unique identifier for the Google connector.
- name String
- Human-readable name for the connector, displayed to users during login.
- redirect
Uri String - Redirect URI registered in Google OAuth app. Must match Dex's callback URL.
- domain
To Map<String>Admin Email - Map of domain names to admin email addresses. Used for group lookups in Google Workspace.
- groups List<String>
- List of Google Groups. Only users in these groups will be allowed to authenticate.
- hosted
Domains List<String> - List of Google Workspace domains. Only users with email addresses in these domains will be allowed to authenticate.
- prompt
Type String - OAuth prompt type. Valid values: 'consent' (default) or 'select_account'.
- service
Account StringFile Path - Path to Google service account JSON file. Required for group-based access control.
Outputs
All input properties are implicitly available as output properties. Additionally, the GoogleConnector 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
