Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Authentik Provider
  3. API Docs
  4. ProviderGoogleWorkspace
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.ProviderGoogleWorkspace

Explore with Pulumi AI

authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik

Create ProviderGoogleWorkspace Resource

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

Constructor syntax

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

@overload
def ProviderGoogleWorkspace(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            default_group_email_domain: Optional[str] = None,
                            credentials: Optional[str] = None,
                            delegated_subject: Optional[str] = None,
                            exclude_users_service_account: Optional[bool] = None,
                            filter_group: Optional[str] = None,
                            group_delete_action: Optional[str] = None,
                            name: Optional[str] = None,
                            property_mappings: Optional[Sequence[str]] = None,
                            property_mappings_groups: Optional[Sequence[str]] = None,
                            provider_google_workspace_id: Optional[str] = None,
                            user_delete_action: Optional[str] = None)
func NewProviderGoogleWorkspace(ctx *Context, name string, args ProviderGoogleWorkspaceArgs, opts ...ResourceOption) (*ProviderGoogleWorkspace, error)
public ProviderGoogleWorkspace(string name, ProviderGoogleWorkspaceArgs args, CustomResourceOptions? opts = null)
public ProviderGoogleWorkspace(String name, ProviderGoogleWorkspaceArgs args)
public ProviderGoogleWorkspace(String name, ProviderGoogleWorkspaceArgs args, CustomResourceOptions options)

type: authentik:ProviderGoogleWorkspace
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. ProviderGoogleWorkspaceArgs
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. ProviderGoogleWorkspaceArgs
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. ProviderGoogleWorkspaceArgs
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. ProviderGoogleWorkspaceArgs
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. ProviderGoogleWorkspaceArgs
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 providerGoogleWorkspaceResource = new Authentik.ProviderGoogleWorkspace("providerGoogleWorkspaceResource", new()
{
    DefaultGroupEmailDomain = "string",
    Credentials = "string",
    DelegatedSubject = "string",
    ExcludeUsersServiceAccount = false,
    FilterGroup = "string",
    GroupDeleteAction = "string",
    Name = "string",
    PropertyMappings = new[]
    {
        "string",
    },
    PropertyMappingsGroups = new[]
    {
        "string",
    },
    ProviderGoogleWorkspaceId = "string",
    UserDeleteAction = "string",
});
Copy
example, err := authentik.NewProviderGoogleWorkspace(ctx, "providerGoogleWorkspaceResource", &authentik.ProviderGoogleWorkspaceArgs{
	DefaultGroupEmailDomain:    pulumi.String("string"),
	Credentials:                pulumi.String("string"),
	DelegatedSubject:           pulumi.String("string"),
	ExcludeUsersServiceAccount: pulumi.Bool(false),
	FilterGroup:                pulumi.String("string"),
	GroupDeleteAction:          pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PropertyMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	PropertyMappingsGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ProviderGoogleWorkspaceId: pulumi.String("string"),
	UserDeleteAction:          pulumi.String("string"),
})
Copy
var providerGoogleWorkspaceResource = new ProviderGoogleWorkspace("providerGoogleWorkspaceResource", ProviderGoogleWorkspaceArgs.builder()
    .defaultGroupEmailDomain("string")
    .credentials("string")
    .delegatedSubject("string")
    .excludeUsersServiceAccount(false)
    .filterGroup("string")
    .groupDeleteAction("string")
    .name("string")
    .propertyMappings("string")
    .propertyMappingsGroups("string")
    .providerGoogleWorkspaceId("string")
    .userDeleteAction("string")
    .build());
Copy
provider_google_workspace_resource = authentik.ProviderGoogleWorkspace("providerGoogleWorkspaceResource",
    default_group_email_domain="string",
    credentials="string",
    delegated_subject="string",
    exclude_users_service_account=False,
    filter_group="string",
    group_delete_action="string",
    name="string",
    property_mappings=["string"],
    property_mappings_groups=["string"],
    provider_google_workspace_id="string",
    user_delete_action="string")
Copy
const providerGoogleWorkspaceResource = new authentik.ProviderGoogleWorkspace("providerGoogleWorkspaceResource", {
    defaultGroupEmailDomain: "string",
    credentials: "string",
    delegatedSubject: "string",
    excludeUsersServiceAccount: false,
    filterGroup: "string",
    groupDeleteAction: "string",
    name: "string",
    propertyMappings: ["string"],
    propertyMappingsGroups: ["string"],
    providerGoogleWorkspaceId: "string",
    userDeleteAction: "string",
});
Copy
type: authentik:ProviderGoogleWorkspace
properties:
    credentials: string
    defaultGroupEmailDomain: string
    delegatedSubject: string
    excludeUsersServiceAccount: false
    filterGroup: string
    groupDeleteAction: string
    name: string
    propertyMappings:
        - string
    propertyMappingsGroups:
        - string
    providerGoogleWorkspaceId: string
    userDeleteAction: string
Copy

ProviderGoogleWorkspace 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 ProviderGoogleWorkspace resource accepts the following input properties:

DefaultGroupEmailDomain This property is required. string
Credentials string
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
DelegatedSubject string
Defaults to seconds=0.
ExcludeUsersServiceAccount bool
FilterGroup string
GroupDeleteAction string
Allowed values: - delete - do_nothing Defaults to delete.
Name string
PropertyMappings List<string>
PropertyMappingsGroups List<string>
ProviderGoogleWorkspaceId string
UserDeleteAction string
Allowed values: - do_nothing - delete - suspend Defaults to delete.
DefaultGroupEmailDomain This property is required. string
Credentials string
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
DelegatedSubject string
Defaults to seconds=0.
ExcludeUsersServiceAccount bool
FilterGroup string
GroupDeleteAction string
Allowed values: - delete - do_nothing Defaults to delete.
Name string
PropertyMappings []string
PropertyMappingsGroups []string
ProviderGoogleWorkspaceId string
UserDeleteAction string
Allowed values: - do_nothing - delete - suspend Defaults to delete.
defaultGroupEmailDomain This property is required. String
credentials String
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
delegatedSubject String
Defaults to seconds=0.
excludeUsersServiceAccount Boolean
filterGroup String
groupDeleteAction String
Allowed values: - delete - do_nothing Defaults to delete.
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerGoogleWorkspaceId String
userDeleteAction String
Allowed values: - do_nothing - delete - suspend Defaults to delete.
defaultGroupEmailDomain This property is required. string
credentials string
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
delegatedSubject string
Defaults to seconds=0.
excludeUsersServiceAccount boolean
filterGroup string
groupDeleteAction string
Allowed values: - delete - do_nothing Defaults to delete.
name string
propertyMappings string[]
propertyMappingsGroups string[]
providerGoogleWorkspaceId string
userDeleteAction string
Allowed values: - do_nothing - delete - suspend Defaults to delete.
default_group_email_domain This property is required. str
credentials str
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
delegated_subject str
Defaults to seconds=0.
exclude_users_service_account bool
filter_group str
group_delete_action str
Allowed values: - delete - do_nothing Defaults to delete.
name str
property_mappings Sequence[str]
property_mappings_groups Sequence[str]
provider_google_workspace_id str
user_delete_action str
Allowed values: - do_nothing - delete - suspend Defaults to delete.
defaultGroupEmailDomain This property is required. String
credentials String
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
delegatedSubject String
Defaults to seconds=0.
excludeUsersServiceAccount Boolean
filterGroup String
groupDeleteAction String
Allowed values: - delete - do_nothing Defaults to delete.
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerGoogleWorkspaceId String
userDeleteAction String
Allowed values: - do_nothing - delete - suspend Defaults to delete.

Outputs

All input properties are implicitly available as output properties. Additionally, the ProviderGoogleWorkspace 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.

Look up Existing ProviderGoogleWorkspace Resource

Get an existing ProviderGoogleWorkspace resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProviderGoogleWorkspaceState, opts?: CustomResourceOptions): ProviderGoogleWorkspace
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[str] = None,
        default_group_email_domain: Optional[str] = None,
        delegated_subject: Optional[str] = None,
        exclude_users_service_account: Optional[bool] = None,
        filter_group: Optional[str] = None,
        group_delete_action: Optional[str] = None,
        name: Optional[str] = None,
        property_mappings: Optional[Sequence[str]] = None,
        property_mappings_groups: Optional[Sequence[str]] = None,
        provider_google_workspace_id: Optional[str] = None,
        user_delete_action: Optional[str] = None) -> ProviderGoogleWorkspace
func GetProviderGoogleWorkspace(ctx *Context, name string, id IDInput, state *ProviderGoogleWorkspaceState, opts ...ResourceOption) (*ProviderGoogleWorkspace, error)
public static ProviderGoogleWorkspace Get(string name, Input<string> id, ProviderGoogleWorkspaceState? state, CustomResourceOptions? opts = null)
public static ProviderGoogleWorkspace get(String name, Output<String> id, ProviderGoogleWorkspaceState state, CustomResourceOptions options)
resources:  _:    type: authentik:ProviderGoogleWorkspace    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Credentials string
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
DefaultGroupEmailDomain string
DelegatedSubject string
Defaults to seconds=0.
ExcludeUsersServiceAccount bool
FilterGroup string
GroupDeleteAction string
Allowed values: - delete - do_nothing Defaults to delete.
Name string
PropertyMappings List<string>
PropertyMappingsGroups List<string>
ProviderGoogleWorkspaceId string
UserDeleteAction string
Allowed values: - do_nothing - delete - suspend Defaults to delete.
Credentials string
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
DefaultGroupEmailDomain string
DelegatedSubject string
Defaults to seconds=0.
ExcludeUsersServiceAccount bool
FilterGroup string
GroupDeleteAction string
Allowed values: - delete - do_nothing Defaults to delete.
Name string
PropertyMappings []string
PropertyMappingsGroups []string
ProviderGoogleWorkspaceId string
UserDeleteAction string
Allowed values: - do_nothing - delete - suspend Defaults to delete.
credentials String
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
defaultGroupEmailDomain String
delegatedSubject String
Defaults to seconds=0.
excludeUsersServiceAccount Boolean
filterGroup String
groupDeleteAction String
Allowed values: - delete - do_nothing Defaults to delete.
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerGoogleWorkspaceId String
userDeleteAction String
Allowed values: - do_nothing - delete - suspend Defaults to delete.
credentials string
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
defaultGroupEmailDomain string
delegatedSubject string
Defaults to seconds=0.
excludeUsersServiceAccount boolean
filterGroup string
groupDeleteAction string
Allowed values: - delete - do_nothing Defaults to delete.
name string
propertyMappings string[]
propertyMappingsGroups string[]
providerGoogleWorkspaceId string
userDeleteAction string
Allowed values: - do_nothing - delete - suspend Defaults to delete.
credentials str
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
default_group_email_domain str
delegated_subject str
Defaults to seconds=0.
exclude_users_service_account bool
filter_group str
group_delete_action str
Allowed values: - delete - do_nothing Defaults to delete.
name str
property_mappings Sequence[str]
property_mappings_groups Sequence[str]
provider_google_workspace_id str
user_delete_action str
Allowed values: - do_nothing - delete - suspend Defaults to delete.
credentials String
JSON format expected. Use jsonencode() to pass objects. Defaults to {}.
defaultGroupEmailDomain String
delegatedSubject String
Defaults to seconds=0.
excludeUsersServiceAccount Boolean
filterGroup String
groupDeleteAction String
Allowed values: - delete - do_nothing Defaults to delete.
name String
propertyMappings List<String>
propertyMappingsGroups List<String>
providerGoogleWorkspaceId String
userDeleteAction String
Allowed values: - do_nothing - delete - suspend Defaults to delete.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik
goauthentik/terraform-provider-authentik