Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. User
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.User

Explore with Pulumi AI

googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

User resource manages Google Workspace Users. User resides under the https://www.googleapis.com/auth/admin.directory.user client scope.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as googleworkspace from "@pulumi/googleworkspace";

const birthday = new googleworkspace.Schema("birthday", {
    schemaName: "birthday",
    fields: [
        {
            fieldName: "birthday",
            fieldType: "DATE",
        },
        {
            fieldName: "favorite-numbers",
            fieldType: "INT64",
            multiValued: true,
            numericIndexingSpec: {
                minValue: 1,
                maxValue: 100,
            },
        },
    ],
});
const dwight = new googleworkspace.User("dwight", {
    primaryEmail: "dwight.schrute@example.com",
    password: "34819d7beeabb9260a5c854bc85b3e44",
    hashFunction: "MD5",
    name: {
        familyName: "Schrute",
        givenName: "Dwight",
    },
    aliases: ["assistant_to_regional_manager@example.com"],
    emails: [{
        address: "dwight.schrute.dunder.mifflin@example.com",
        type: "work",
    }],
    relations: [{
        type: "assistant",
        value: "Michael Scott",
    }],
    addresses: [{
        country: "USA",
        countryCode: "US",
        locality: "Scranton",
        poBox: "123",
        postalCode: "18508",
        region: "PA",
        streetAddress: "123 Dunder Mifflin Pkwy",
        type: "work",
    }],
    organizations: [{
        department: "sales",
        location: "Scranton",
        name: "Dunder Mifflin",
        primary: true,
        symbol: "DUMI",
        title: "member",
        type: "work",
    }],
    phones: [
        {
            type: "home",
            value: "555-123-7890",
        },
        {
            type: "work",
            primary: true,
            value: "555-123-0987",
        },
    ],
    keywords: [{
        type: "occupation",
        value: "salesperson",
    }],
    customSchemas: [{
        schemaName: birthday.schemaName,
        schemaValues: {
            birthday: JSON.stringify("1970-01-20"),
            "favorite-numbers": JSON.stringify([
                1,
                2,
                3,
            ]),
        },
    }],
    recoveryEmail: "dwightkschrute@example.com",
});
Copy
import pulumi
import json
import pulumi_googleworkspace as googleworkspace

birthday = googleworkspace.Schema("birthday",
    schema_name="birthday",
    fields=[
        {
            "field_name": "birthday",
            "field_type": "DATE",
        },
        {
            "field_name": "favorite-numbers",
            "field_type": "INT64",
            "multi_valued": True,
            "numeric_indexing_spec": {
                "min_value": 1,
                "max_value": 100,
            },
        },
    ])
dwight = googleworkspace.User("dwight",
    primary_email="dwight.schrute@example.com",
    password="34819d7beeabb9260a5c854bc85b3e44",
    hash_function="MD5",
    name={
        "family_name": "Schrute",
        "given_name": "Dwight",
    },
    aliases=["assistant_to_regional_manager@example.com"],
    emails=[{
        "address": "dwight.schrute.dunder.mifflin@example.com",
        "type": "work",
    }],
    relations=[{
        "type": "assistant",
        "value": "Michael Scott",
    }],
    addresses=[{
        "country": "USA",
        "country_code": "US",
        "locality": "Scranton",
        "po_box": "123",
        "postal_code": "18508",
        "region": "PA",
        "street_address": "123 Dunder Mifflin Pkwy",
        "type": "work",
    }],
    organizations=[{
        "department": "sales",
        "location": "Scranton",
        "name": "Dunder Mifflin",
        "primary": True,
        "symbol": "DUMI",
        "title": "member",
        "type": "work",
    }],
    phones=[
        {
            "type": "home",
            "value": "555-123-7890",
        },
        {
            "type": "work",
            "primary": True,
            "value": "555-123-0987",
        },
    ],
    keywords=[{
        "type": "occupation",
        "value": "salesperson",
    }],
    custom_schemas=[{
        "schema_name": birthday.schema_name,
        "schema_values": {
            "birthday": json.dumps("1970-01-20"),
            "favorite-numbers": json.dumps([
                1,
                2,
                3,
            ]),
        },
    }],
    recovery_email="dwightkschrute@example.com")
Copy
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/googleworkspace/googleworkspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		birthday, err := googleworkspace.NewSchema(ctx, "birthday", &googleworkspace.SchemaArgs{
			SchemaName: pulumi.String("birthday"),
			Fields: googleworkspace.SchemaFieldArray{
				&googleworkspace.SchemaFieldArgs{
					FieldName: pulumi.String("birthday"),
					FieldType: pulumi.String("DATE"),
				},
				&googleworkspace.SchemaFieldArgs{
					FieldName:   pulumi.String("favorite-numbers"),
					FieldType:   pulumi.String("INT64"),
					MultiValued: pulumi.Bool(true),
					NumericIndexingSpec: &googleworkspace.SchemaFieldNumericIndexingSpecArgs{
						MinValue: pulumi.Float64(1),
						MaxValue: pulumi.Float64(100),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal("1970-01-20")
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal([]float64{
			1,
			2,
			3,
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = googleworkspace.NewUser(ctx, "dwight", &googleworkspace.UserArgs{
			PrimaryEmail: pulumi.String("dwight.schrute@example.com"),
			Password:     pulumi.String("34819d7beeabb9260a5c854bc85b3e44"),
			HashFunction: pulumi.String("MD5"),
			Name: &googleworkspace.UserNameArgs{
				FamilyName: pulumi.String("Schrute"),
				GivenName:  pulumi.String("Dwight"),
			},
			Aliases: pulumi.StringArray{
				pulumi.String("assistant_to_regional_manager@example.com"),
			},
			Emails: googleworkspace.UserEmailArray{
				&googleworkspace.UserEmailArgs{
					Address: pulumi.String("dwight.schrute.dunder.mifflin@example.com"),
					Type:    pulumi.String("work"),
				},
			},
			Relations: googleworkspace.UserRelationArray{
				&googleworkspace.UserRelationArgs{
					Type:  pulumi.String("assistant"),
					Value: pulumi.String("Michael Scott"),
				},
			},
			Addresses: googleworkspace.UserAddressArray{
				&googleworkspace.UserAddressArgs{
					Country:       pulumi.String("USA"),
					CountryCode:   pulumi.String("US"),
					Locality:      pulumi.String("Scranton"),
					PoBox:         pulumi.String("123"),
					PostalCode:    pulumi.String("18508"),
					Region:        pulumi.String("PA"),
					StreetAddress: pulumi.String("123 Dunder Mifflin Pkwy"),
					Type:          pulumi.String("work"),
				},
			},
			Organizations: googleworkspace.UserOrganizationArray{
				&googleworkspace.UserOrganizationArgs{
					Department: pulumi.String("sales"),
					Location:   pulumi.String("Scranton"),
					Name:       pulumi.String("Dunder Mifflin"),
					Primary:    pulumi.Bool(true),
					Symbol:     pulumi.String("DUMI"),
					Title:      pulumi.String("member"),
					Type:       pulumi.String("work"),
				},
			},
			Phones: googleworkspace.UserPhoneArray{
				&googleworkspace.UserPhoneArgs{
					Type:  pulumi.String("home"),
					Value: pulumi.String("555-123-7890"),
				},
				&googleworkspace.UserPhoneArgs{
					Type:    pulumi.String("work"),
					Primary: pulumi.Bool(true),
					Value:   pulumi.String("555-123-0987"),
				},
			},
			Keywords: googleworkspace.UserKeywordArray{
				&googleworkspace.UserKeywordArgs{
					Type:  pulumi.String("occupation"),
					Value: pulumi.String("salesperson"),
				},
			},
			CustomSchemas: googleworkspace.UserCustomSchemaArray{
				&googleworkspace.UserCustomSchemaArgs{
					SchemaName: birthday.SchemaName,
					SchemaValues: pulumi.StringMap{
						"birthday":         pulumi.String(json0),
						"favorite-numbers": pulumi.String(json1),
					},
				},
			},
			RecoveryEmail: pulumi.String("dwightkschrute@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Googleworkspace = Pulumi.Googleworkspace;

return await Deployment.RunAsync(() => 
{
    var birthday = new Googleworkspace.Schema("birthday", new()
    {
        SchemaName = "birthday",
        Fields = new[]
        {
            new Googleworkspace.Inputs.SchemaFieldArgs
            {
                FieldName = "birthday",
                FieldType = "DATE",
            },
            new Googleworkspace.Inputs.SchemaFieldArgs
            {
                FieldName = "favorite-numbers",
                FieldType = "INT64",
                MultiValued = true,
                NumericIndexingSpec = new Googleworkspace.Inputs.SchemaFieldNumericIndexingSpecArgs
                {
                    MinValue = 1,
                    MaxValue = 100,
                },
            },
        },
    });

    var dwight = new Googleworkspace.User("dwight", new()
    {
        PrimaryEmail = "dwight.schrute@example.com",
        Password = "34819d7beeabb9260a5c854bc85b3e44",
        HashFunction = "MD5",
        Name = new Googleworkspace.Inputs.UserNameArgs
        {
            FamilyName = "Schrute",
            GivenName = "Dwight",
        },
        Aliases = new[]
        {
            "assistant_to_regional_manager@example.com",
        },
        Emails = new[]
        {
            new Googleworkspace.Inputs.UserEmailArgs
            {
                Address = "dwight.schrute.dunder.mifflin@example.com",
                Type = "work",
            },
        },
        Relations = new[]
        {
            new Googleworkspace.Inputs.UserRelationArgs
            {
                Type = "assistant",
                Value = "Michael Scott",
            },
        },
        Addresses = new[]
        {
            new Googleworkspace.Inputs.UserAddressArgs
            {
                Country = "USA",
                CountryCode = "US",
                Locality = "Scranton",
                PoBox = "123",
                PostalCode = "18508",
                Region = "PA",
                StreetAddress = "123 Dunder Mifflin Pkwy",
                Type = "work",
            },
        },
        Organizations = new[]
        {
            new Googleworkspace.Inputs.UserOrganizationArgs
            {
                Department = "sales",
                Location = "Scranton",
                Name = "Dunder Mifflin",
                Primary = true,
                Symbol = "DUMI",
                Title = "member",
                Type = "work",
            },
        },
        Phones = new[]
        {
            new Googleworkspace.Inputs.UserPhoneArgs
            {
                Type = "home",
                Value = "555-123-7890",
            },
            new Googleworkspace.Inputs.UserPhoneArgs
            {
                Type = "work",
                Primary = true,
                Value = "555-123-0987",
            },
        },
        Keywords = new[]
        {
            new Googleworkspace.Inputs.UserKeywordArgs
            {
                Type = "occupation",
                Value = "salesperson",
            },
        },
        CustomSchemas = new[]
        {
            new Googleworkspace.Inputs.UserCustomSchemaArgs
            {
                SchemaName = birthday.SchemaName,
                SchemaValues = 
                {
                    { "birthday", JsonSerializer.Serialize("1970-01-20") },
                    { "favorite-numbers", JsonSerializer.Serialize(new object?[]
                    {
                        1,
                        2,
                        3,
                    }) },
                },
            },
        },
        RecoveryEmail = "dwightkschrute@example.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.Schema;
import com.pulumi.googleworkspace.SchemaArgs;
import com.pulumi.googleworkspace.inputs.SchemaFieldArgs;
import com.pulumi.googleworkspace.inputs.SchemaFieldNumericIndexingSpecArgs;
import com.pulumi.googleworkspace.User;
import com.pulumi.googleworkspace.UserArgs;
import com.pulumi.googleworkspace.inputs.UserNameArgs;
import com.pulumi.googleworkspace.inputs.UserEmailArgs;
import com.pulumi.googleworkspace.inputs.UserRelationArgs;
import com.pulumi.googleworkspace.inputs.UserAddressArgs;
import com.pulumi.googleworkspace.inputs.UserOrganizationArgs;
import com.pulumi.googleworkspace.inputs.UserPhoneArgs;
import com.pulumi.googleworkspace.inputs.UserKeywordArgs;
import com.pulumi.googleworkspace.inputs.UserCustomSchemaArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 birthday = new Schema("birthday", SchemaArgs.builder()
            .schemaName("birthday")
            .fields(            
                SchemaFieldArgs.builder()
                    .fieldName("birthday")
                    .fieldType("DATE")
                    .build(),
                SchemaFieldArgs.builder()
                    .fieldName("favorite-numbers")
                    .fieldType("INT64")
                    .multiValued(true)
                    .numericIndexingSpec(SchemaFieldNumericIndexingSpecArgs.builder()
                        .minValue(1)
                        .maxValue(100)
                        .build())
                    .build())
            .build());

        var dwight = new User("dwight", UserArgs.builder()
            .primaryEmail("dwight.schrute@example.com")
            .password("34819d7beeabb9260a5c854bc85b3e44")
            .hashFunction("MD5")
            .name(UserNameArgs.builder()
                .familyName("Schrute")
                .givenName("Dwight")
                .build())
            .aliases("assistant_to_regional_manager@example.com")
            .emails(UserEmailArgs.builder()
                .address("dwight.schrute.dunder.mifflin@example.com")
                .type("work")
                .build())
            .relations(UserRelationArgs.builder()
                .type("assistant")
                .value("Michael Scott")
                .build())
            .addresses(UserAddressArgs.builder()
                .country("USA")
                .countryCode("US")
                .locality("Scranton")
                .poBox("123")
                .postalCode("18508")
                .region("PA")
                .streetAddress("123 Dunder Mifflin Pkwy")
                .type("work")
                .build())
            .organizations(UserOrganizationArgs.builder()
                .department("sales")
                .location("Scranton")
                .name("Dunder Mifflin")
                .primary(true)
                .symbol("DUMI")
                .title("member")
                .type("work")
                .build())
            .phones(            
                UserPhoneArgs.builder()
                    .type("home")
                    .value("555-123-7890")
                    .build(),
                UserPhoneArgs.builder()
                    .type("work")
                    .primary(true)
                    .value("555-123-0987")
                    .build())
            .keywords(UserKeywordArgs.builder()
                .type("occupation")
                .value("salesperson")
                .build())
            .customSchemas(UserCustomSchemaArgs.builder()
                .schemaName(birthday.schemaName())
                .schemaValues(Map.ofEntries(
                    Map.entry("birthday", serializeJson(
                        "1970-01-20")),
                    Map.entry("favorite-numbers", serializeJson(
                        jsonArray(
                            1, 
                            2, 
                            3
                        )))
                ))
                .build())
            .recoveryEmail("dwightkschrute@example.com")
            .build());

    }
}
Copy
resources:
  birthday:
    type: googleworkspace:Schema
    properties:
      schemaName: birthday
      fields:
        - fieldName: birthday
          fieldType: DATE
        - fieldName: favorite-numbers
          fieldType: INT64
          multiValued: true
          numericIndexingSpec:
            minValue: 1
            maxValue: 100
  dwight:
    type: googleworkspace:User
    properties:
      primaryEmail: dwight.schrute@example.com
      password: 34819d7beeabb9260a5c854bc85b3e44
      hashFunction: MD5
      name:
        familyName: Schrute
        givenName: Dwight
      aliases:
        - assistant_to_regional_manager@example.com
      emails:
        - address: dwight.schrute.dunder.mifflin@example.com
          type: work
      relations:
        - type: assistant
          value: Michael Scott
      addresses:
        - country: USA
          countryCode: US
          locality: Scranton
          poBox: '123'
          postalCode: '18508'
          region: PA
          streetAddress: 123 Dunder Mifflin Pkwy
          type: work
      organizations:
        - department: sales
          location: Scranton
          name: Dunder Mifflin
          primary: true
          symbol: DUMI
          title: member
          type: work
      phones:
        - type: home
          value: 555-123-7890
        - type: work
          primary: true
          value: 555-123-0987
      keywords:
        - type: occupation
          value: salesperson
      customSchemas:
        - schemaName: ${birthday.schemaName}
          schemaValues:
            birthday:
              fn::toJSON: 1970-01-20
            favorite-numbers:
              fn::toJSON:
                - 1
                - 2
                - 3
      recoveryEmail: dwightkschrute@example.com
Copy

Create User Resource

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

Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         name: Optional[UserNameArgs] = None,
         primary_email: Optional[str] = None,
         hash_function: Optional[str] = None,
         websites: Optional[Sequence[UserWebsiteArgs]] = None,
         locations: Optional[Sequence[UserLocationArgs]] = None,
         emails: Optional[Sequence[UserEmailArgs]] = None,
         external_ids: Optional[Sequence[UserExternalIdArgs]] = None,
         addresses: Optional[Sequence[UserAddressArgs]] = None,
         ims: Optional[Sequence[UserImArgs]] = None,
         include_in_global_address_list: Optional[bool] = None,
         ip_allowlist: Optional[bool] = None,
         is_admin: Optional[bool] = None,
         keywords: Optional[Sequence[UserKeywordArgs]] = None,
         languages: Optional[Sequence[UserLanguageArgs]] = None,
         custom_schemas: Optional[Sequence[UserCustomSchemaArgs]] = None,
         change_password_at_next_login: Optional[bool] = None,
         recovery_phone: Optional[str] = None,
         organizations: Optional[Sequence[UserOrganizationArgs]] = None,
         password: Optional[str] = None,
         phones: Optional[Sequence[UserPhoneArgs]] = None,
         posix_accounts: Optional[Sequence[UserPosixAccountArgs]] = None,
         aliases: Optional[Sequence[str]] = None,
         recovery_email: Optional[str] = None,
         org_unit_path: Optional[str] = None,
         relations: Optional[Sequence[UserRelationArgs]] = None,
         ssh_public_keys: Optional[Sequence[UserSshPublicKeyArgs]] = None,
         suspended: Optional[bool] = None,
         timeouts: Optional[UserTimeoutsArgs] = None,
         archived: Optional[bool] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: googleworkspace:User
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. UserArgs
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. UserArgs
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. UserArgs
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. UserArgs
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. UserArgs
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 userResource = new Googleworkspace.User("userResource", new()
{
    Name = new Googleworkspace.Inputs.UserNameArgs
    {
        FamilyName = "string",
        FullName = "string",
        GivenName = "string",
    },
    PrimaryEmail = "string",
    HashFunction = "string",
    Websites = new[]
    {
        new Googleworkspace.Inputs.UserWebsiteArgs
        {
            Type = "string",
            Value = "string",
            CustomType = "string",
            Primary = false,
        },
    },
    Locations = new[]
    {
        new Googleworkspace.Inputs.UserLocationArgs
        {
            Type = "string",
            Area = "string",
            BuildingId = "string",
            CustomType = "string",
            DeskCode = "string",
            FloorName = "string",
            FloorSection = "string",
        },
    },
    Emails = new[]
    {
        new Googleworkspace.Inputs.UserEmailArgs
        {
            Type = "string",
            Address = "string",
            CustomType = "string",
            Primary = false,
        },
    },
    ExternalIds = new[]
    {
        new Googleworkspace.Inputs.UserExternalIdArgs
        {
            Type = "string",
            Value = "string",
            CustomType = "string",
        },
    },
    Addresses = new[]
    {
        new Googleworkspace.Inputs.UserAddressArgs
        {
            Type = "string",
            PoBox = "string",
            CustomType = "string",
            ExtendedAddress = "string",
            Formatted = "string",
            Locality = "string",
            Country = "string",
            PostalCode = "string",
            Primary = false,
            Region = "string",
            SourceIsStructured = false,
            StreetAddress = "string",
            CountryCode = "string",
        },
    },
    Ims = new[]
    {
        new Googleworkspace.Inputs.UserImArgs
        {
            Protocol = "string",
            Type = "string",
            CustomProtocol = "string",
            CustomType = "string",
            Im = "string",
            Primary = false,
        },
    },
    IncludeInGlobalAddressList = false,
    IpAllowlist = false,
    IsAdmin = false,
    Keywords = new[]
    {
        new Googleworkspace.Inputs.UserKeywordArgs
        {
            Type = "string",
            Value = "string",
            CustomType = "string",
        },
    },
    Languages = new[]
    {
        new Googleworkspace.Inputs.UserLanguageArgs
        {
            CustomLanguage = "string",
            LanguageCode = "string",
            Preference = "string",
        },
    },
    CustomSchemas = new[]
    {
        new Googleworkspace.Inputs.UserCustomSchemaArgs
        {
            SchemaName = "string",
            SchemaValues = 
            {
                { "string", "string" },
            },
        },
    },
    ChangePasswordAtNextLogin = false,
    RecoveryPhone = "string",
    Organizations = new[]
    {
        new Googleworkspace.Inputs.UserOrganizationArgs
        {
            Type = "string",
            CostCenter = "string",
            CustomType = "string",
            Department = "string",
            Description = "string",
            Domain = "string",
            FullTimeEquivalent = 0,
            Location = "string",
            Name = "string",
            Primary = false,
            Symbol = "string",
            Title = "string",
        },
    },
    Password = "string",
    Phones = new[]
    {
        new Googleworkspace.Inputs.UserPhoneArgs
        {
            Type = "string",
            Value = "string",
            CustomType = "string",
            Primary = false,
        },
    },
    PosixAccounts = new[]
    {
        new Googleworkspace.Inputs.UserPosixAccountArgs
        {
            AccountId = "string",
            Gecos = "string",
            Gid = "string",
            HomeDirectory = "string",
            OperatingSystemType = "string",
            Primary = false,
            Shell = "string",
            SystemId = "string",
            Uid = "string",
            Username = "string",
        },
    },
    Aliases = new[]
    {
        "string",
    },
    RecoveryEmail = "string",
    OrgUnitPath = "string",
    Relations = new[]
    {
        new Googleworkspace.Inputs.UserRelationArgs
        {
            Type = "string",
            Value = "string",
            CustomType = "string",
        },
    },
    SshPublicKeys = new[]
    {
        new Googleworkspace.Inputs.UserSshPublicKeyArgs
        {
            Key = "string",
            ExpirationTimeUsec = "string",
            Fingerprint = "string",
        },
    },
    Suspended = false,
    Timeouts = new Googleworkspace.Inputs.UserTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
    Archived = false,
});
Copy
example, err := googleworkspace.NewUser(ctx, "userResource", &googleworkspace.UserArgs{
Name: &.UserNameArgs{
FamilyName: pulumi.String("string"),
FullName: pulumi.String("string"),
GivenName: pulumi.String("string"),
},
PrimaryEmail: pulumi.String("string"),
HashFunction: pulumi.String("string"),
Websites: .UserWebsiteArray{
&.UserWebsiteArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
CustomType: pulumi.String("string"),
Primary: pulumi.Bool(false),
},
},
Locations: .UserLocationArray{
&.UserLocationArgs{
Type: pulumi.String("string"),
Area: pulumi.String("string"),
BuildingId: pulumi.String("string"),
CustomType: pulumi.String("string"),
DeskCode: pulumi.String("string"),
FloorName: pulumi.String("string"),
FloorSection: pulumi.String("string"),
},
},
Emails: .UserEmailArray{
&.UserEmailArgs{
Type: pulumi.String("string"),
Address: pulumi.String("string"),
CustomType: pulumi.String("string"),
Primary: pulumi.Bool(false),
},
},
ExternalIds: .UserExternalIdArray{
&.UserExternalIdArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
CustomType: pulumi.String("string"),
},
},
Addresses: .UserAddressArray{
&.UserAddressArgs{
Type: pulumi.String("string"),
PoBox: pulumi.String("string"),
CustomType: pulumi.String("string"),
ExtendedAddress: pulumi.String("string"),
Formatted: pulumi.String("string"),
Locality: pulumi.String("string"),
Country: pulumi.String("string"),
PostalCode: pulumi.String("string"),
Primary: pulumi.Bool(false),
Region: pulumi.String("string"),
SourceIsStructured: pulumi.Bool(false),
StreetAddress: pulumi.String("string"),
CountryCode: pulumi.String("string"),
},
},
Ims: .UserImArray{
&.UserImArgs{
Protocol: pulumi.String("string"),
Type: pulumi.String("string"),
CustomProtocol: pulumi.String("string"),
CustomType: pulumi.String("string"),
Im: pulumi.String("string"),
Primary: pulumi.Bool(false),
},
},
IncludeInGlobalAddressList: pulumi.Bool(false),
IpAllowlist: pulumi.Bool(false),
IsAdmin: pulumi.Bool(false),
Keywords: .UserKeywordArray{
&.UserKeywordArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
CustomType: pulumi.String("string"),
},
},
Languages: .UserLanguageArray{
&.UserLanguageArgs{
CustomLanguage: pulumi.String("string"),
LanguageCode: pulumi.String("string"),
Preference: pulumi.String("string"),
},
},
CustomSchemas: .UserCustomSchemaArray{
&.UserCustomSchemaArgs{
SchemaName: pulumi.String("string"),
SchemaValues: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
},
ChangePasswordAtNextLogin: pulumi.Bool(false),
RecoveryPhone: pulumi.String("string"),
Organizations: .UserOrganizationArray{
&.UserOrganizationArgs{
Type: pulumi.String("string"),
CostCenter: pulumi.String("string"),
CustomType: pulumi.String("string"),
Department: pulumi.String("string"),
Description: pulumi.String("string"),
Domain: pulumi.String("string"),
FullTimeEquivalent: pulumi.Float64(0),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Primary: pulumi.Bool(false),
Symbol: pulumi.String("string"),
Title: pulumi.String("string"),
},
},
Password: pulumi.String("string"),
Phones: .UserPhoneArray{
&.UserPhoneArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
CustomType: pulumi.String("string"),
Primary: pulumi.Bool(false),
},
},
PosixAccounts: .UserPosixAccountArray{
&.UserPosixAccountArgs{
AccountId: pulumi.String("string"),
Gecos: pulumi.String("string"),
Gid: pulumi.String("string"),
HomeDirectory: pulumi.String("string"),
OperatingSystemType: pulumi.String("string"),
Primary: pulumi.Bool(false),
Shell: pulumi.String("string"),
SystemId: pulumi.String("string"),
Uid: pulumi.String("string"),
Username: pulumi.String("string"),
},
},
Aliases: pulumi.StringArray{
pulumi.String("string"),
},
RecoveryEmail: pulumi.String("string"),
OrgUnitPath: pulumi.String("string"),
Relations: .UserRelationArray{
&.UserRelationArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
CustomType: pulumi.String("string"),
},
},
SshPublicKeys: .UserSshPublicKeyArray{
&.UserSshPublicKeyArgs{
Key: pulumi.String("string"),
ExpirationTimeUsec: pulumi.String("string"),
Fingerprint: pulumi.String("string"),
},
},
Suspended: pulumi.Bool(false),
Timeouts: &.UserTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
Archived: pulumi.Bool(false),
})
Copy
var userResource = new User("userResource", UserArgs.builder()
    .name(UserNameArgs.builder()
        .familyName("string")
        .fullName("string")
        .givenName("string")
        .build())
    .primaryEmail("string")
    .hashFunction("string")
    .websites(UserWebsiteArgs.builder()
        .type("string")
        .value("string")
        .customType("string")
        .primary(false)
        .build())
    .locations(UserLocationArgs.builder()
        .type("string")
        .area("string")
        .buildingId("string")
        .customType("string")
        .deskCode("string")
        .floorName("string")
        .floorSection("string")
        .build())
    .emails(UserEmailArgs.builder()
        .type("string")
        .address("string")
        .customType("string")
        .primary(false)
        .build())
    .externalIds(UserExternalIdArgs.builder()
        .type("string")
        .value("string")
        .customType("string")
        .build())
    .addresses(UserAddressArgs.builder()
        .type("string")
        .poBox("string")
        .customType("string")
        .extendedAddress("string")
        .formatted("string")
        .locality("string")
        .country("string")
        .postalCode("string")
        .primary(false)
        .region("string")
        .sourceIsStructured(false)
        .streetAddress("string")
        .countryCode("string")
        .build())
    .ims(UserImArgs.builder()
        .protocol("string")
        .type("string")
        .customProtocol("string")
        .customType("string")
        .im("string")
        .primary(false)
        .build())
    .includeInGlobalAddressList(false)
    .ipAllowlist(false)
    .isAdmin(false)
    .keywords(UserKeywordArgs.builder()
        .type("string")
        .value("string")
        .customType("string")
        .build())
    .languages(UserLanguageArgs.builder()
        .customLanguage("string")
        .languageCode("string")
        .preference("string")
        .build())
    .customSchemas(UserCustomSchemaArgs.builder()
        .schemaName("string")
        .schemaValues(Map.of("string", "string"))
        .build())
    .changePasswordAtNextLogin(false)
    .recoveryPhone("string")
    .organizations(UserOrganizationArgs.builder()
        .type("string")
        .costCenter("string")
        .customType("string")
        .department("string")
        .description("string")
        .domain("string")
        .fullTimeEquivalent(0)
        .location("string")
        .name("string")
        .primary(false)
        .symbol("string")
        .title("string")
        .build())
    .password("string")
    .phones(UserPhoneArgs.builder()
        .type("string")
        .value("string")
        .customType("string")
        .primary(false)
        .build())
    .posixAccounts(UserPosixAccountArgs.builder()
        .accountId("string")
        .gecos("string")
        .gid("string")
        .homeDirectory("string")
        .operatingSystemType("string")
        .primary(false)
        .shell("string")
        .systemId("string")
        .uid("string")
        .username("string")
        .build())
    .aliases("string")
    .recoveryEmail("string")
    .orgUnitPath("string")
    .relations(UserRelationArgs.builder()
        .type("string")
        .value("string")
        .customType("string")
        .build())
    .sshPublicKeys(UserSshPublicKeyArgs.builder()
        .key("string")
        .expirationTimeUsec("string")
        .fingerprint("string")
        .build())
    .suspended(false)
    .timeouts(UserTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .archived(false)
    .build());
Copy
user_resource = googleworkspace.User("userResource",
    name={
        "family_name": "string",
        "full_name": "string",
        "given_name": "string",
    },
    primary_email="string",
    hash_function="string",
    websites=[{
        "type": "string",
        "value": "string",
        "custom_type": "string",
        "primary": False,
    }],
    locations=[{
        "type": "string",
        "area": "string",
        "building_id": "string",
        "custom_type": "string",
        "desk_code": "string",
        "floor_name": "string",
        "floor_section": "string",
    }],
    emails=[{
        "type": "string",
        "address": "string",
        "custom_type": "string",
        "primary": False,
    }],
    external_ids=[{
        "type": "string",
        "value": "string",
        "custom_type": "string",
    }],
    addresses=[{
        "type": "string",
        "po_box": "string",
        "custom_type": "string",
        "extended_address": "string",
        "formatted": "string",
        "locality": "string",
        "country": "string",
        "postal_code": "string",
        "primary": False,
        "region": "string",
        "source_is_structured": False,
        "street_address": "string",
        "country_code": "string",
    }],
    ims=[{
        "protocol": "string",
        "type": "string",
        "custom_protocol": "string",
        "custom_type": "string",
        "im": "string",
        "primary": False,
    }],
    include_in_global_address_list=False,
    ip_allowlist=False,
    is_admin=False,
    keywords=[{
        "type": "string",
        "value": "string",
        "custom_type": "string",
    }],
    languages=[{
        "custom_language": "string",
        "language_code": "string",
        "preference": "string",
    }],
    custom_schemas=[{
        "schema_name": "string",
        "schema_values": {
            "string": "string",
        },
    }],
    change_password_at_next_login=False,
    recovery_phone="string",
    organizations=[{
        "type": "string",
        "cost_center": "string",
        "custom_type": "string",
        "department": "string",
        "description": "string",
        "domain": "string",
        "full_time_equivalent": 0,
        "location": "string",
        "name": "string",
        "primary": False,
        "symbol": "string",
        "title": "string",
    }],
    password="string",
    phones=[{
        "type": "string",
        "value": "string",
        "custom_type": "string",
        "primary": False,
    }],
    posix_accounts=[{
        "account_id": "string",
        "gecos": "string",
        "gid": "string",
        "home_directory": "string",
        "operating_system_type": "string",
        "primary": False,
        "shell": "string",
        "system_id": "string",
        "uid": "string",
        "username": "string",
    }],
    aliases=["string"],
    recovery_email="string",
    org_unit_path="string",
    relations=[{
        "type": "string",
        "value": "string",
        "custom_type": "string",
    }],
    ssh_public_keys=[{
        "key": "string",
        "expiration_time_usec": "string",
        "fingerprint": "string",
    }],
    suspended=False,
    timeouts={
        "create": "string",
        "update": "string",
    },
    archived=False)
Copy
const userResource = new googleworkspace.User("userResource", {
    name: {
        familyName: "string",
        fullName: "string",
        givenName: "string",
    },
    primaryEmail: "string",
    hashFunction: "string",
    websites: [{
        type: "string",
        value: "string",
        customType: "string",
        primary: false,
    }],
    locations: [{
        type: "string",
        area: "string",
        buildingId: "string",
        customType: "string",
        deskCode: "string",
        floorName: "string",
        floorSection: "string",
    }],
    emails: [{
        type: "string",
        address: "string",
        customType: "string",
        primary: false,
    }],
    externalIds: [{
        type: "string",
        value: "string",
        customType: "string",
    }],
    addresses: [{
        type: "string",
        poBox: "string",
        customType: "string",
        extendedAddress: "string",
        formatted: "string",
        locality: "string",
        country: "string",
        postalCode: "string",
        primary: false,
        region: "string",
        sourceIsStructured: false,
        streetAddress: "string",
        countryCode: "string",
    }],
    ims: [{
        protocol: "string",
        type: "string",
        customProtocol: "string",
        customType: "string",
        im: "string",
        primary: false,
    }],
    includeInGlobalAddressList: false,
    ipAllowlist: false,
    isAdmin: false,
    keywords: [{
        type: "string",
        value: "string",
        customType: "string",
    }],
    languages: [{
        customLanguage: "string",
        languageCode: "string",
        preference: "string",
    }],
    customSchemas: [{
        schemaName: "string",
        schemaValues: {
            string: "string",
        },
    }],
    changePasswordAtNextLogin: false,
    recoveryPhone: "string",
    organizations: [{
        type: "string",
        costCenter: "string",
        customType: "string",
        department: "string",
        description: "string",
        domain: "string",
        fullTimeEquivalent: 0,
        location: "string",
        name: "string",
        primary: false,
        symbol: "string",
        title: "string",
    }],
    password: "string",
    phones: [{
        type: "string",
        value: "string",
        customType: "string",
        primary: false,
    }],
    posixAccounts: [{
        accountId: "string",
        gecos: "string",
        gid: "string",
        homeDirectory: "string",
        operatingSystemType: "string",
        primary: false,
        shell: "string",
        systemId: "string",
        uid: "string",
        username: "string",
    }],
    aliases: ["string"],
    recoveryEmail: "string",
    orgUnitPath: "string",
    relations: [{
        type: "string",
        value: "string",
        customType: "string",
    }],
    sshPublicKeys: [{
        key: "string",
        expirationTimeUsec: "string",
        fingerprint: "string",
    }],
    suspended: false,
    timeouts: {
        create: "string",
        update: "string",
    },
    archived: false,
});
Copy
type: googleworkspace:User
properties:
    addresses:
        - country: string
          countryCode: string
          customType: string
          extendedAddress: string
          formatted: string
          locality: string
          poBox: string
          postalCode: string
          primary: false
          region: string
          sourceIsStructured: false
          streetAddress: string
          type: string
    aliases:
        - string
    archived: false
    changePasswordAtNextLogin: false
    customSchemas:
        - schemaName: string
          schemaValues:
            string: string
    emails:
        - address: string
          customType: string
          primary: false
          type: string
    externalIds:
        - customType: string
          type: string
          value: string
    hashFunction: string
    ims:
        - customProtocol: string
          customType: string
          im: string
          primary: false
          protocol: string
          type: string
    includeInGlobalAddressList: false
    ipAllowlist: false
    isAdmin: false
    keywords:
        - customType: string
          type: string
          value: string
    languages:
        - customLanguage: string
          languageCode: string
          preference: string
    locations:
        - area: string
          buildingId: string
          customType: string
          deskCode: string
          floorName: string
          floorSection: string
          type: string
    name:
        familyName: string
        fullName: string
        givenName: string
    orgUnitPath: string
    organizations:
        - costCenter: string
          customType: string
          department: string
          description: string
          domain: string
          fullTimeEquivalent: 0
          location: string
          name: string
          primary: false
          symbol: string
          title: string
          type: string
    password: string
    phones:
        - customType: string
          primary: false
          type: string
          value: string
    posixAccounts:
        - accountId: string
          gecos: string
          gid: string
          homeDirectory: string
          operatingSystemType: string
          primary: false
          shell: string
          systemId: string
          uid: string
          username: string
    primaryEmail: string
    recoveryEmail: string
    recoveryPhone: string
    relations:
        - customType: string
          type: string
          value: string
    sshPublicKeys:
        - expirationTimeUsec: string
          fingerprint: string
          key: string
    suspended: false
    timeouts:
        create: string
        update: string
    websites:
        - customType: string
          primary: false
          type: string
          value: string
Copy

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

Name This property is required. UserName
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
PrimaryEmail This property is required. string
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
Addresses List<UserAddress>
A list of the user's addresses. The maximum allowed data size is 10Kb.
Aliases List<string>
asps.list of the user's alias email addresses.
Archived bool
Indicates if user is archived.
ChangePasswordAtNextLogin bool
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
CustomSchemas List<UserCustomSchema>
Custom fields of the user.
Emails List<UserEmail>
A list of the user's email addresses. The maximum allowed data size is 10Kb.
ExternalIds List<UserExternalId>
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
HashFunction string
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
Ims List<UserIm>
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
IncludeInGlobalAddressList bool
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
IpAllowlist bool
If true, the user's IP address is added to the allow list.
IsAdmin bool
Indicates a user with super admininistrator privileges.
Keywords List<UserKeyword>
A list of the user's keywords. The maximum allowed data size is 1Kb.
Languages List<UserLanguage>
A list of the user's languages. The maximum allowed data size is 1Kb.
Locations List<UserLocation>
A list of the user's locations. The maximum allowed data size is 10Kb.
OrgUnitPath string
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
Organizations List<UserOrganization>
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
Password string
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
Phones List<UserPhone>
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
PosixAccounts List<UserPosixAccount>
A list of POSIX account information for the user.
RecoveryEmail string
Recovery email of the user.
RecoveryPhone string
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
Relations List<UserRelation>
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
SshPublicKeys List<UserSshPublicKey>
A list of SSH public keys. The maximum allowed data size is 10Kb.
Suspended bool
Indicates if user is suspended.
Timeouts UserTimeouts
Websites List<UserWebsite>
A list of the user's websites. The maximum allowed data size is 2Kb.
Name This property is required. UserNameArgs
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
PrimaryEmail This property is required. string
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
Addresses []UserAddressArgs
A list of the user's addresses. The maximum allowed data size is 10Kb.
Aliases []string
asps.list of the user's alias email addresses.
Archived bool
Indicates if user is archived.
ChangePasswordAtNextLogin bool
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
CustomSchemas []UserCustomSchemaArgs
Custom fields of the user.
Emails []UserEmailArgs
A list of the user's email addresses. The maximum allowed data size is 10Kb.
ExternalIds []UserExternalIdArgs
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
HashFunction string
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
Ims []UserImArgs
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
IncludeInGlobalAddressList bool
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
IpAllowlist bool
If true, the user's IP address is added to the allow list.
IsAdmin bool
Indicates a user with super admininistrator privileges.
Keywords []UserKeywordArgs
A list of the user's keywords. The maximum allowed data size is 1Kb.
Languages []UserLanguageArgs
A list of the user's languages. The maximum allowed data size is 1Kb.
Locations []UserLocationArgs
A list of the user's locations. The maximum allowed data size is 10Kb.
OrgUnitPath string
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
Organizations []UserOrganizationArgs
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
Password string
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
Phones []UserPhoneArgs
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
PosixAccounts []UserPosixAccountArgs
A list of POSIX account information for the user.
RecoveryEmail string
Recovery email of the user.
RecoveryPhone string
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
Relations []UserRelationArgs
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
SshPublicKeys []UserSshPublicKeyArgs
A list of SSH public keys. The maximum allowed data size is 10Kb.
Suspended bool
Indicates if user is suspended.
Timeouts UserTimeoutsArgs
Websites []UserWebsiteArgs
A list of the user's websites. The maximum allowed data size is 2Kb.
name This property is required. UserName
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
primaryEmail This property is required. String
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
addresses List<UserAddress>
A list of the user's addresses. The maximum allowed data size is 10Kb.
aliases List<String>
asps.list of the user's alias email addresses.
archived Boolean
Indicates if user is archived.
changePasswordAtNextLogin Boolean
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
customSchemas List<UserCustomSchema>
Custom fields of the user.
emails List<UserEmail>
A list of the user's email addresses. The maximum allowed data size is 10Kb.
externalIds List<UserExternalId>
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hashFunction String
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims List<UserIm>
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
includeInGlobalAddressList Boolean
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ipAllowlist Boolean
If true, the user's IP address is added to the allow list.
isAdmin Boolean
Indicates a user with super admininistrator privileges.
keywords List<UserKeyword>
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages List<UserLanguage>
A list of the user's languages. The maximum allowed data size is 1Kb.
locations List<UserLocation>
A list of the user's locations. The maximum allowed data size is 10Kb.
orgUnitPath String
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations List<UserOrganization>
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password String
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones List<UserPhone>
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posixAccounts List<UserPosixAccount>
A list of POSIX account information for the user.
recoveryEmail String
Recovery email of the user.
recoveryPhone String
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations List<UserRelation>
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
sshPublicKeys List<UserSshPublicKey>
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended Boolean
Indicates if user is suspended.
timeouts UserTimeouts
websites List<UserWebsite>
A list of the user's websites. The maximum allowed data size is 2Kb.
name This property is required. UserName
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
primaryEmail This property is required. string
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
addresses UserAddress[]
A list of the user's addresses. The maximum allowed data size is 10Kb.
aliases string[]
asps.list of the user's alias email addresses.
archived boolean
Indicates if user is archived.
changePasswordAtNextLogin boolean
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
customSchemas UserCustomSchema[]
Custom fields of the user.
emails UserEmail[]
A list of the user's email addresses. The maximum allowed data size is 10Kb.
externalIds UserExternalId[]
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hashFunction string
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims UserIm[]
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
includeInGlobalAddressList boolean
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ipAllowlist boolean
If true, the user's IP address is added to the allow list.
isAdmin boolean
Indicates a user with super admininistrator privileges.
keywords UserKeyword[]
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages UserLanguage[]
A list of the user's languages. The maximum allowed data size is 1Kb.
locations UserLocation[]
A list of the user's locations. The maximum allowed data size is 10Kb.
orgUnitPath string
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations UserOrganization[]
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password string
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones UserPhone[]
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posixAccounts UserPosixAccount[]
A list of POSIX account information for the user.
recoveryEmail string
Recovery email of the user.
recoveryPhone string
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations UserRelation[]
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
sshPublicKeys UserSshPublicKey[]
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended boolean
Indicates if user is suspended.
timeouts UserTimeouts
websites UserWebsite[]
A list of the user's websites. The maximum allowed data size is 2Kb.
name This property is required. UserNameArgs
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
primary_email This property is required. str
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
addresses Sequence[UserAddressArgs]
A list of the user's addresses. The maximum allowed data size is 10Kb.
aliases Sequence[str]
asps.list of the user's alias email addresses.
archived bool
Indicates if user is archived.
change_password_at_next_login bool
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
custom_schemas Sequence[UserCustomSchemaArgs]
Custom fields of the user.
emails Sequence[UserEmailArgs]
A list of the user's email addresses. The maximum allowed data size is 10Kb.
external_ids Sequence[UserExternalIdArgs]
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hash_function str
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims Sequence[UserImArgs]
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
include_in_global_address_list bool
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ip_allowlist bool
If true, the user's IP address is added to the allow list.
is_admin bool
Indicates a user with super admininistrator privileges.
keywords Sequence[UserKeywordArgs]
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages Sequence[UserLanguageArgs]
A list of the user's languages. The maximum allowed data size is 1Kb.
locations Sequence[UserLocationArgs]
A list of the user's locations. The maximum allowed data size is 10Kb.
org_unit_path str
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations Sequence[UserOrganizationArgs]
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password str
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones Sequence[UserPhoneArgs]
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posix_accounts Sequence[UserPosixAccountArgs]
A list of POSIX account information for the user.
recovery_email str
Recovery email of the user.
recovery_phone str
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations Sequence[UserRelationArgs]
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
ssh_public_keys Sequence[UserSshPublicKeyArgs]
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended bool
Indicates if user is suspended.
timeouts UserTimeoutsArgs
websites Sequence[UserWebsiteArgs]
A list of the user's websites. The maximum allowed data size is 2Kb.
name This property is required. Property Map
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
primaryEmail This property is required. String
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
addresses List<Property Map>
A list of the user's addresses. The maximum allowed data size is 10Kb.
aliases List<String>
asps.list of the user's alias email addresses.
archived Boolean
Indicates if user is archived.
changePasswordAtNextLogin Boolean
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
customSchemas List<Property Map>
Custom fields of the user.
emails List<Property Map>
A list of the user's email addresses. The maximum allowed data size is 10Kb.
externalIds List<Property Map>
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hashFunction String
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims List<Property Map>
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
includeInGlobalAddressList Boolean
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ipAllowlist Boolean
If true, the user's IP address is added to the allow list.
isAdmin Boolean
Indicates a user with super admininistrator privileges.
keywords List<Property Map>
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages List<Property Map>
A list of the user's languages. The maximum allowed data size is 1Kb.
locations List<Property Map>
A list of the user's locations. The maximum allowed data size is 10Kb.
orgUnitPath String
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations List<Property Map>
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password String
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones List<Property Map>
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posixAccounts List<Property Map>
A list of POSIX account information for the user.
recoveryEmail String
Recovery email of the user.
recoveryPhone String
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations List<Property Map>
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
sshPublicKeys List<Property Map>
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended Boolean
Indicates if user is suspended.
timeouts Property Map
websites List<Property Map>
A list of the user's websites. The maximum allowed data size is 2Kb.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

AgreedToTerms bool
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
CreationTime string
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
CustomerId string
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
DeletionTime string
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
Etag string
ETag of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsDelegatedAdmin bool
Indicates if the user is a delegated administrator.
IsEnforcedIn2StepVerification bool
Is 2-step verification enforced.
IsEnrolledIn2StepVerification bool
Is enrolled in 2-step verification.
IsMailboxSetup bool
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
LastLoginTime string
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
NonEditableAliases List<string>
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
SuspensionReason string
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
ThumbnailPhotoEtag string
ETag of the user's photo
ThumbnailPhotoUrl string
Photo Url of the user.
AgreedToTerms bool
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
CreationTime string
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
CustomerId string
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
DeletionTime string
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
Etag string
ETag of the resource.
Id string
The provider-assigned unique ID for this managed resource.
IsDelegatedAdmin bool
Indicates if the user is a delegated administrator.
IsEnforcedIn2StepVerification bool
Is 2-step verification enforced.
IsEnrolledIn2StepVerification bool
Is enrolled in 2-step verification.
IsMailboxSetup bool
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
LastLoginTime string
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
NonEditableAliases []string
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
SuspensionReason string
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
ThumbnailPhotoEtag string
ETag of the user's photo
ThumbnailPhotoUrl string
Photo Url of the user.
agreedToTerms Boolean
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
creationTime String
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customerId String
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletionTime String
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
etag String
ETag of the resource.
id String
The provider-assigned unique ID for this managed resource.
isDelegatedAdmin Boolean
Indicates if the user is a delegated administrator.
isEnforcedIn2StepVerification Boolean
Is 2-step verification enforced.
isEnrolledIn2StepVerification Boolean
Is enrolled in 2-step verification.
isMailboxSetup Boolean
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
lastLoginTime String
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
nonEditableAliases List<String>
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
suspensionReason String
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnailPhotoEtag String
ETag of the user's photo
thumbnailPhotoUrl String
Photo Url of the user.
agreedToTerms boolean
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
creationTime string
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customerId string
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletionTime string
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
etag string
ETag of the resource.
id string
The provider-assigned unique ID for this managed resource.
isDelegatedAdmin boolean
Indicates if the user is a delegated administrator.
isEnforcedIn2StepVerification boolean
Is 2-step verification enforced.
isEnrolledIn2StepVerification boolean
Is enrolled in 2-step verification.
isMailboxSetup boolean
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
lastLoginTime string
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
nonEditableAliases string[]
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
suspensionReason string
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnailPhotoEtag string
ETag of the user's photo
thumbnailPhotoUrl string
Photo Url of the user.
agreed_to_terms bool
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
creation_time str
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customer_id str
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletion_time str
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
etag str
ETag of the resource.
id str
The provider-assigned unique ID for this managed resource.
is_delegated_admin bool
Indicates if the user is a delegated administrator.
is_enforced_in2_step_verification bool
Is 2-step verification enforced.
is_enrolled_in2_step_verification bool
Is enrolled in 2-step verification.
is_mailbox_setup bool
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
last_login_time str
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
non_editable_aliases Sequence[str]
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
suspension_reason str
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnail_photo_etag str
ETag of the user's photo
thumbnail_photo_url str
Photo Url of the user.
agreedToTerms Boolean
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
creationTime String
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customerId String
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletionTime String
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
etag String
ETag of the resource.
id String
The provider-assigned unique ID for this managed resource.
isDelegatedAdmin Boolean
Indicates if the user is a delegated administrator.
isEnforcedIn2StepVerification Boolean
Is 2-step verification enforced.
isEnrolledIn2StepVerification Boolean
Is enrolled in 2-step verification.
isMailboxSetup Boolean
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
lastLoginTime String
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
nonEditableAliases List<String>
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
suspensionReason String
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnailPhotoEtag String
ETag of the user's photo
thumbnailPhotoUrl String
Photo Url of the user.

Look up Existing User Resource

Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        addresses: Optional[Sequence[UserAddressArgs]] = None,
        agreed_to_terms: Optional[bool] = None,
        aliases: Optional[Sequence[str]] = None,
        archived: Optional[bool] = None,
        change_password_at_next_login: Optional[bool] = None,
        creation_time: Optional[str] = None,
        custom_schemas: Optional[Sequence[UserCustomSchemaArgs]] = None,
        customer_id: Optional[str] = None,
        deletion_time: Optional[str] = None,
        emails: Optional[Sequence[UserEmailArgs]] = None,
        etag: Optional[str] = None,
        external_ids: Optional[Sequence[UserExternalIdArgs]] = None,
        hash_function: Optional[str] = None,
        ims: Optional[Sequence[UserImArgs]] = None,
        include_in_global_address_list: Optional[bool] = None,
        ip_allowlist: Optional[bool] = None,
        is_admin: Optional[bool] = None,
        is_delegated_admin: Optional[bool] = None,
        is_enforced_in2_step_verification: Optional[bool] = None,
        is_enrolled_in2_step_verification: Optional[bool] = None,
        is_mailbox_setup: Optional[bool] = None,
        keywords: Optional[Sequence[UserKeywordArgs]] = None,
        languages: Optional[Sequence[UserLanguageArgs]] = None,
        last_login_time: Optional[str] = None,
        locations: Optional[Sequence[UserLocationArgs]] = None,
        name: Optional[UserNameArgs] = None,
        non_editable_aliases: Optional[Sequence[str]] = None,
        org_unit_path: Optional[str] = None,
        organizations: Optional[Sequence[UserOrganizationArgs]] = None,
        password: Optional[str] = None,
        phones: Optional[Sequence[UserPhoneArgs]] = None,
        posix_accounts: Optional[Sequence[UserPosixAccountArgs]] = None,
        primary_email: Optional[str] = None,
        recovery_email: Optional[str] = None,
        recovery_phone: Optional[str] = None,
        relations: Optional[Sequence[UserRelationArgs]] = None,
        ssh_public_keys: Optional[Sequence[UserSshPublicKeyArgs]] = None,
        suspended: Optional[bool] = None,
        suspension_reason: Optional[str] = None,
        thumbnail_photo_etag: Optional[str] = None,
        thumbnail_photo_url: Optional[str] = None,
        timeouts: Optional[UserTimeoutsArgs] = None,
        websites: Optional[Sequence[UserWebsiteArgs]] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
resources:  _:    type: googleworkspace:User    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:
Addresses List<UserAddress>
A list of the user's addresses. The maximum allowed data size is 10Kb.
AgreedToTerms bool
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
Aliases List<string>
asps.list of the user's alias email addresses.
Archived bool
Indicates if user is archived.
ChangePasswordAtNextLogin bool
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
CreationTime string
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
CustomSchemas List<UserCustomSchema>
Custom fields of the user.
CustomerId string
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
DeletionTime string
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
Emails List<UserEmail>
A list of the user's email addresses. The maximum allowed data size is 10Kb.
Etag string
ETag of the resource.
ExternalIds List<UserExternalId>
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
HashFunction string
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
Ims List<UserIm>
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
IncludeInGlobalAddressList bool
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
IpAllowlist bool
If true, the user's IP address is added to the allow list.
IsAdmin bool
Indicates a user with super admininistrator privileges.
IsDelegatedAdmin bool
Indicates if the user is a delegated administrator.
IsEnforcedIn2StepVerification bool
Is 2-step verification enforced.
IsEnrolledIn2StepVerification bool
Is enrolled in 2-step verification.
IsMailboxSetup bool
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
Keywords List<UserKeyword>
A list of the user's keywords. The maximum allowed data size is 1Kb.
Languages List<UserLanguage>
A list of the user's languages. The maximum allowed data size is 1Kb.
LastLoginTime string
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
Locations List<UserLocation>
A list of the user's locations. The maximum allowed data size is 10Kb.
Name UserName
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
NonEditableAliases List<string>
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
OrgUnitPath string
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
Organizations List<UserOrganization>
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
Password string
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
Phones List<UserPhone>
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
PosixAccounts List<UserPosixAccount>
A list of POSIX account information for the user.
PrimaryEmail string
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
RecoveryEmail string
Recovery email of the user.
RecoveryPhone string
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
Relations List<UserRelation>
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
SshPublicKeys List<UserSshPublicKey>
A list of SSH public keys. The maximum allowed data size is 10Kb.
Suspended bool
Indicates if user is suspended.
SuspensionReason string
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
ThumbnailPhotoEtag string
ETag of the user's photo
ThumbnailPhotoUrl string
Photo Url of the user.
Timeouts UserTimeouts
Websites List<UserWebsite>
A list of the user's websites. The maximum allowed data size is 2Kb.
Addresses []UserAddressArgs
A list of the user's addresses. The maximum allowed data size is 10Kb.
AgreedToTerms bool
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
Aliases []string
asps.list of the user's alias email addresses.
Archived bool
Indicates if user is archived.
ChangePasswordAtNextLogin bool
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
CreationTime string
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
CustomSchemas []UserCustomSchemaArgs
Custom fields of the user.
CustomerId string
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
DeletionTime string
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
Emails []UserEmailArgs
A list of the user's email addresses. The maximum allowed data size is 10Kb.
Etag string
ETag of the resource.
ExternalIds []UserExternalIdArgs
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
HashFunction string
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
Ims []UserImArgs
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
IncludeInGlobalAddressList bool
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
IpAllowlist bool
If true, the user's IP address is added to the allow list.
IsAdmin bool
Indicates a user with super admininistrator privileges.
IsDelegatedAdmin bool
Indicates if the user is a delegated administrator.
IsEnforcedIn2StepVerification bool
Is 2-step verification enforced.
IsEnrolledIn2StepVerification bool
Is enrolled in 2-step verification.
IsMailboxSetup bool
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
Keywords []UserKeywordArgs
A list of the user's keywords. The maximum allowed data size is 1Kb.
Languages []UserLanguageArgs
A list of the user's languages. The maximum allowed data size is 1Kb.
LastLoginTime string
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
Locations []UserLocationArgs
A list of the user's locations. The maximum allowed data size is 10Kb.
Name UserNameArgs
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
NonEditableAliases []string
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
OrgUnitPath string
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
Organizations []UserOrganizationArgs
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
Password string
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
Phones []UserPhoneArgs
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
PosixAccounts []UserPosixAccountArgs
A list of POSIX account information for the user.
PrimaryEmail string
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
RecoveryEmail string
Recovery email of the user.
RecoveryPhone string
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
Relations []UserRelationArgs
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
SshPublicKeys []UserSshPublicKeyArgs
A list of SSH public keys. The maximum allowed data size is 10Kb.
Suspended bool
Indicates if user is suspended.
SuspensionReason string
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
ThumbnailPhotoEtag string
ETag of the user's photo
ThumbnailPhotoUrl string
Photo Url of the user.
Timeouts UserTimeoutsArgs
Websites []UserWebsiteArgs
A list of the user's websites. The maximum allowed data size is 2Kb.
addresses List<UserAddress>
A list of the user's addresses. The maximum allowed data size is 10Kb.
agreedToTerms Boolean
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
aliases List<String>
asps.list of the user's alias email addresses.
archived Boolean
Indicates if user is archived.
changePasswordAtNextLogin Boolean
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
creationTime String
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customSchemas List<UserCustomSchema>
Custom fields of the user.
customerId String
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletionTime String
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
emails List<UserEmail>
A list of the user's email addresses. The maximum allowed data size is 10Kb.
etag String
ETag of the resource.
externalIds List<UserExternalId>
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hashFunction String
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims List<UserIm>
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
includeInGlobalAddressList Boolean
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ipAllowlist Boolean
If true, the user's IP address is added to the allow list.
isAdmin Boolean
Indicates a user with super admininistrator privileges.
isDelegatedAdmin Boolean
Indicates if the user is a delegated administrator.
isEnforcedIn2StepVerification Boolean
Is 2-step verification enforced.
isEnrolledIn2StepVerification Boolean
Is enrolled in 2-step verification.
isMailboxSetup Boolean
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
keywords List<UserKeyword>
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages List<UserLanguage>
A list of the user's languages. The maximum allowed data size is 1Kb.
lastLoginTime String
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
locations List<UserLocation>
A list of the user's locations. The maximum allowed data size is 10Kb.
name UserName
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
nonEditableAliases List<String>
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
orgUnitPath String
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations List<UserOrganization>
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password String
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones List<UserPhone>
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posixAccounts List<UserPosixAccount>
A list of POSIX account information for the user.
primaryEmail String
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
recoveryEmail String
Recovery email of the user.
recoveryPhone String
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations List<UserRelation>
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
sshPublicKeys List<UserSshPublicKey>
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended Boolean
Indicates if user is suspended.
suspensionReason String
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnailPhotoEtag String
ETag of the user's photo
thumbnailPhotoUrl String
Photo Url of the user.
timeouts UserTimeouts
websites List<UserWebsite>
A list of the user's websites. The maximum allowed data size is 2Kb.
addresses UserAddress[]
A list of the user's addresses. The maximum allowed data size is 10Kb.
agreedToTerms boolean
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
aliases string[]
asps.list of the user's alias email addresses.
archived boolean
Indicates if user is archived.
changePasswordAtNextLogin boolean
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
creationTime string
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customSchemas UserCustomSchema[]
Custom fields of the user.
customerId string
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletionTime string
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
emails UserEmail[]
A list of the user's email addresses. The maximum allowed data size is 10Kb.
etag string
ETag of the resource.
externalIds UserExternalId[]
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hashFunction string
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims UserIm[]
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
includeInGlobalAddressList boolean
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ipAllowlist boolean
If true, the user's IP address is added to the allow list.
isAdmin boolean
Indicates a user with super admininistrator privileges.
isDelegatedAdmin boolean
Indicates if the user is a delegated administrator.
isEnforcedIn2StepVerification boolean
Is 2-step verification enforced.
isEnrolledIn2StepVerification boolean
Is enrolled in 2-step verification.
isMailboxSetup boolean
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
keywords UserKeyword[]
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages UserLanguage[]
A list of the user's languages. The maximum allowed data size is 1Kb.
lastLoginTime string
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
locations UserLocation[]
A list of the user's locations. The maximum allowed data size is 10Kb.
name UserName
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
nonEditableAliases string[]
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
orgUnitPath string
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations UserOrganization[]
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password string
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones UserPhone[]
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posixAccounts UserPosixAccount[]
A list of POSIX account information for the user.
primaryEmail string
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
recoveryEmail string
Recovery email of the user.
recoveryPhone string
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations UserRelation[]
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
sshPublicKeys UserSshPublicKey[]
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended boolean
Indicates if user is suspended.
suspensionReason string
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnailPhotoEtag string
ETag of the user's photo
thumbnailPhotoUrl string
Photo Url of the user.
timeouts UserTimeouts
websites UserWebsite[]
A list of the user's websites. The maximum allowed data size is 2Kb.
addresses Sequence[UserAddressArgs]
A list of the user's addresses. The maximum allowed data size is 10Kb.
agreed_to_terms bool
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
aliases Sequence[str]
asps.list of the user's alias email addresses.
archived bool
Indicates if user is archived.
change_password_at_next_login bool
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
creation_time str
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
custom_schemas Sequence[UserCustomSchemaArgs]
Custom fields of the user.
customer_id str
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletion_time str
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
emails Sequence[UserEmailArgs]
A list of the user's email addresses. The maximum allowed data size is 10Kb.
etag str
ETag of the resource.
external_ids Sequence[UserExternalIdArgs]
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hash_function str
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims Sequence[UserImArgs]
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
include_in_global_address_list bool
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ip_allowlist bool
If true, the user's IP address is added to the allow list.
is_admin bool
Indicates a user with super admininistrator privileges.
is_delegated_admin bool
Indicates if the user is a delegated administrator.
is_enforced_in2_step_verification bool
Is 2-step verification enforced.
is_enrolled_in2_step_verification bool
Is enrolled in 2-step verification.
is_mailbox_setup bool
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
keywords Sequence[UserKeywordArgs]
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages Sequence[UserLanguageArgs]
A list of the user's languages. The maximum allowed data size is 1Kb.
last_login_time str
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
locations Sequence[UserLocationArgs]
A list of the user's locations. The maximum allowed data size is 10Kb.
name UserNameArgs
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
non_editable_aliases Sequence[str]
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
org_unit_path str
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations Sequence[UserOrganizationArgs]
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password str
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones Sequence[UserPhoneArgs]
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posix_accounts Sequence[UserPosixAccountArgs]
A list of POSIX account information for the user.
primary_email str
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
recovery_email str
Recovery email of the user.
recovery_phone str
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations Sequence[UserRelationArgs]
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
ssh_public_keys Sequence[UserSshPublicKeyArgs]
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended bool
Indicates if user is suspended.
suspension_reason str
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnail_photo_etag str
ETag of the user's photo
thumbnail_photo_url str
Photo Url of the user.
timeouts UserTimeoutsArgs
websites Sequence[UserWebsiteArgs]
A list of the user's websites. The maximum allowed data size is 2Kb.
addresses List<Property Map>
A list of the user's addresses. The maximum allowed data size is 10Kb.
agreedToTerms Boolean
This property is true if the user has completed an initial login and accepted the Terms of Service agreement.
aliases List<String>
asps.list of the user's alias email addresses.
archived Boolean
Indicates if user is archived.
changePasswordAtNextLogin Boolean
Indicates if the user is forced to change their password at next login. This setting doesn't apply when the user signs in via a third-party identity provider.
creationTime String
The time the user's account was created. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
customSchemas List<Property Map>
Custom fields of the user.
customerId String
The customer ID to retrieve all account users. You can use the alias my_customer to represent your account's customerId. As a reseller administrator, you can use the resold customer account's customerId. To get a customerId, use the account's primary domain in the domain parameter of a users.list request.
deletionTime String
The time the user's account was deleted. The value is in ISO 8601 date and time format The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example 2010-04-05T17:30:04+01:00.
emails List<Property Map>
A list of the user's email addresses. The maximum allowed data size is 10Kb.
etag String
ETag of the resource.
externalIds List<Property Map>
A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size is 2Kb.
hashFunction String
Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.
ims List<Property Map>
The user's Instant Messenger (IM) accounts. A user account can have multiple ims properties. But, only one of these ims properties can be the primary IM contact. The maximum allowed data size is 2Kb.
includeInGlobalAddressList Boolean
Defaults to true. Indicates if the user's profile is visible in the Google Workspace global address list when the contact sharing feature is enabled for the domain.
ipAllowlist Boolean
If true, the user's IP address is added to the allow list.
isAdmin Boolean
Indicates a user with super admininistrator privileges.
isDelegatedAdmin Boolean
Indicates if the user is a delegated administrator.
isEnforcedIn2StepVerification Boolean
Is 2-step verification enforced.
isEnrolledIn2StepVerification Boolean
Is enrolled in 2-step verification.
isMailboxSetup Boolean
Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
keywords List<Property Map>
A list of the user's keywords. The maximum allowed data size is 1Kb.
languages List<Property Map>
A list of the user's languages. The maximum allowed data size is 1Kb.
lastLoginTime String
The last time the user logged into the user's account. The value is in ISO 8601 date and time format. The time is the complete date plus hours, minutes, and seconds in the form YYYY-MM-DDThh:mm:ssTZD. For example, 2010-04-05T17:30:04+01:00.
locations List<Property Map>
A list of the user's locations. The maximum allowed data size is 10Kb.
name Property Map
Holds the given and family names of the user, and the read-only fullName value. The maximum number of characters in the givenName and in the familyName values is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.). Maximum allowed data size for this field is 1Kb.
nonEditableAliases List<String>
asps.list of the user's non-editable alias email addresses. These are typically outside the account's primary domain or sub-domain.
orgUnitPath String
The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
organizations List<Property Map>
A list of organizations the user belongs to. The maximum allowed data size is 10Kb.
password String
Stores the password for the user account. A password can contain any combination of ASCII characters. A minimum of 8 characters is required. The maximum length is 100 characters. As the API does not return the value of password, this field is write-only, and the value stored in the state will be what is provided in the configuration. The field is required on create and will be empty on import.
phones List<Property Map>
A list of the user's phone numbers. The maximum allowed data size is 1Kb.
posixAccounts List<Property Map>
A list of POSIX account information for the user.
primaryEmail String
The user's primary email address. The primaryEmail must be unique and cannot be an alias of another user.
recoveryEmail String
Recovery email of the user.
recoveryPhone String
Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: +16506661212.
relations List<Property Map>
A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.
sshPublicKeys List<Property Map>
A list of SSH public keys. The maximum allowed data size is 10Kb.
suspended Boolean
Indicates if user is suspended.
suspensionReason String
Has the reason a user account is suspended either by the administrator or by Google at the time of suspension. The property is returned only if the suspended property is true.
thumbnailPhotoEtag String
ETag of the user's photo
thumbnailPhotoUrl String
Photo Url of the user.
timeouts Property Map
websites List<Property Map>
A list of the user's websites. The maximum allowed data size is 2Kb.

Supporting Types

UserAddress
, UserAddressArgs

Type This property is required. string
The address type. Acceptable values: custom, home, other, work.
Country string
Country
CountryCode string
The country code. Uses the ISO 3166-1 standard.
CustomType string
If the address type is custom, this property contains the custom value.
ExtendedAddress string
For extended addresses, such as an address that includes a sub-region.
Formatted string
A full and unstructured postal address. This is not synced with the structured address fields.
Locality string
The town or city of the address.
PoBox string
The post office box, if present.
PostalCode string
The ZIP or postal code, if applicable.
Primary bool
If this is the user's primary address. The addresses list may contain only one primary address.
Region string
The abbreviated province or state.
SourceIsStructured bool
Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported.
StreetAddress string
The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.
Type This property is required. string
The address type. Acceptable values: custom, home, other, work.
Country string
Country
CountryCode string
The country code. Uses the ISO 3166-1 standard.
CustomType string
If the address type is custom, this property contains the custom value.
ExtendedAddress string
For extended addresses, such as an address that includes a sub-region.
Formatted string
A full and unstructured postal address. This is not synced with the structured address fields.
Locality string
The town or city of the address.
PoBox string
The post office box, if present.
PostalCode string
The ZIP or postal code, if applicable.
Primary bool
If this is the user's primary address. The addresses list may contain only one primary address.
Region string
The abbreviated province or state.
SourceIsStructured bool
Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported.
StreetAddress string
The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.
type This property is required. String
The address type. Acceptable values: custom, home, other, work.
country String
Country
countryCode String
The country code. Uses the ISO 3166-1 standard.
customType String
If the address type is custom, this property contains the custom value.
extendedAddress String
For extended addresses, such as an address that includes a sub-region.
formatted String
A full and unstructured postal address. This is not synced with the structured address fields.
locality String
The town or city of the address.
poBox String
The post office box, if present.
postalCode String
The ZIP or postal code, if applicable.
primary Boolean
If this is the user's primary address. The addresses list may contain only one primary address.
region String
The abbreviated province or state.
sourceIsStructured Boolean
Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported.
streetAddress String
The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.
type This property is required. string
The address type. Acceptable values: custom, home, other, work.
country string
Country
countryCode string
The country code. Uses the ISO 3166-1 standard.
customType string
If the address type is custom, this property contains the custom value.
extendedAddress string
For extended addresses, such as an address that includes a sub-region.
formatted string
A full and unstructured postal address. This is not synced with the structured address fields.
locality string
The town or city of the address.
poBox string
The post office box, if present.
postalCode string
The ZIP or postal code, if applicable.
primary boolean
If this is the user's primary address. The addresses list may contain only one primary address.
region string
The abbreviated province or state.
sourceIsStructured boolean
Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported.
streetAddress string
The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.
type This property is required. str
The address type. Acceptable values: custom, home, other, work.
country str
Country
country_code str
The country code. Uses the ISO 3166-1 standard.
custom_type str
If the address type is custom, this property contains the custom value.
extended_address str
For extended addresses, such as an address that includes a sub-region.
formatted str
A full and unstructured postal address. This is not synced with the structured address fields.
locality str
The town or city of the address.
po_box str
The post office box, if present.
postal_code str
The ZIP or postal code, if applicable.
primary bool
If this is the user's primary address. The addresses list may contain only one primary address.
region str
The abbreviated province or state.
source_is_structured bool
Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported.
street_address str
The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.
type This property is required. String
The address type. Acceptable values: custom, home, other, work.
country String
Country
countryCode String
The country code. Uses the ISO 3166-1 standard.
customType String
If the address type is custom, this property contains the custom value.
extendedAddress String
For extended addresses, such as an address that includes a sub-region.
formatted String
A full and unstructured postal address. This is not synced with the structured address fields.
locality String
The town or city of the address.
poBox String
The post office box, if present.
postalCode String
The ZIP or postal code, if applicable.
primary Boolean
If this is the user's primary address. The addresses list may contain only one primary address.
region String
The abbreviated province or state.
sourceIsStructured Boolean
Indicates if the user-supplied address was formatted. Formatted addresses are not currently supported.
streetAddress String
The street address, such as 1600 Amphitheatre Parkway. Whitespace within the string is ignored; however, newlines are significant.

UserCustomSchema
, UserCustomSchemaArgs

SchemaName This property is required. string
The name of the schema.
SchemaValues This property is required. Dictionary<string, string>
JSON encoded map that represents key/value pairs that correspond to the given schema.
SchemaName This property is required. string
The name of the schema.
SchemaValues This property is required. map[string]string
JSON encoded map that represents key/value pairs that correspond to the given schema.
schemaName This property is required. String
The name of the schema.
schemaValues This property is required. Map<String,String>
JSON encoded map that represents key/value pairs that correspond to the given schema.
schemaName This property is required. string
The name of the schema.
schemaValues This property is required. {[key: string]: string}
JSON encoded map that represents key/value pairs that correspond to the given schema.
schema_name This property is required. str
The name of the schema.
schema_values This property is required. Mapping[str, str]
JSON encoded map that represents key/value pairs that correspond to the given schema.
schemaName This property is required. String
The name of the schema.
schemaValues This property is required. Map<String>
JSON encoded map that represents key/value pairs that correspond to the given schema.

UserEmail
, UserEmailArgs

Type This property is required. string
The type of the email account. Acceptable values: custom, home, other, work.
Address string
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
CustomType string
If the value of type is custom, this property contains the custom type string.
Primary bool
Defaults to false. Indicates if this is the user's primary email. Only one entry can be marked as primary.
Type This property is required. string
The type of the email account. Acceptable values: custom, home, other, work.
Address string
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
CustomType string
If the value of type is custom, this property contains the custom type string.
Primary bool
Defaults to false. Indicates if this is the user's primary email. Only one entry can be marked as primary.
type This property is required. String
The type of the email account. Acceptable values: custom, home, other, work.
address String
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
customType String
If the value of type is custom, this property contains the custom type string.
primary Boolean
Defaults to false. Indicates if this is the user's primary email. Only one entry can be marked as primary.
type This property is required. string
The type of the email account. Acceptable values: custom, home, other, work.
address string
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
customType string
If the value of type is custom, this property contains the custom type string.
primary boolean
Defaults to false. Indicates if this is the user's primary email. Only one entry can be marked as primary.
type This property is required. str
The type of the email account. Acceptable values: custom, home, other, work.
address str
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
custom_type str
If the value of type is custom, this property contains the custom type string.
primary bool
Defaults to false. Indicates if this is the user's primary email. Only one entry can be marked as primary.
type This property is required. String
The type of the email account. Acceptable values: custom, home, other, work.
address String
The user's email address. Also serves as the email ID. This value can be the user's primary email address or an alias.
customType String
If the value of type is custom, this property contains the custom type string.
primary Boolean
Defaults to false. Indicates if this is the user's primary email. Only one entry can be marked as primary.

UserExternalId
, UserExternalIdArgs

Type This property is required. string
The type of external ID. If set to custom, customType must also be set. Acceptable values: account, custom, customer, login_id, network, organization.
Value This property is required. string
The value of the ID.
CustomType string
If the external ID type is custom, this property contains the custom value and must be set.
Type This property is required. string
The type of external ID. If set to custom, customType must also be set. Acceptable values: account, custom, customer, login_id, network, organization.
Value This property is required. string
The value of the ID.
CustomType string
If the external ID type is custom, this property contains the custom value and must be set.
type This property is required. String
The type of external ID. If set to custom, customType must also be set. Acceptable values: account, custom, customer, login_id, network, organization.
value This property is required. String
The value of the ID.
customType String
If the external ID type is custom, this property contains the custom value and must be set.
type This property is required. string
The type of external ID. If set to custom, customType must also be set. Acceptable values: account, custom, customer, login_id, network, organization.
value This property is required. string
The value of the ID.
customType string
If the external ID type is custom, this property contains the custom value and must be set.
type This property is required. str
The type of external ID. If set to custom, customType must also be set. Acceptable values: account, custom, customer, login_id, network, organization.
value This property is required. str
The value of the ID.
custom_type str
If the external ID type is custom, this property contains the custom value and must be set.
type This property is required. String
The type of external ID. If set to custom, customType must also be set. Acceptable values: account, custom, customer, login_id, network, organization.
value This property is required. String
The value of the ID.
customType String
If the external ID type is custom, this property contains the custom value and must be set.

UserIm
, UserImArgs

Protocol This property is required. string
An IM protocol identifies the IM network. The value can be a custom network or the standard network. Acceptable values: aim, custom_protocol, gtalk, icq, jabber, msn, net_meeting, qq, skype, yahoo.
Type This property is required. string
Acceptable values: custom, home, other, work.
CustomProtocol string
If the protocol value is custom_protocol, this property holds the custom protocol's string.
CustomType string
If the IM type is custom, this property holds the custom type string.
Im string
The user's IM network ID.
Primary bool
If this is the user's primary IM. Only one entry in the IM list can have a value of true.
Protocol This property is required. string
An IM protocol identifies the IM network. The value can be a custom network or the standard network. Acceptable values: aim, custom_protocol, gtalk, icq, jabber, msn, net_meeting, qq, skype, yahoo.
Type This property is required. string
Acceptable values: custom, home, other, work.
CustomProtocol string
If the protocol value is custom_protocol, this property holds the custom protocol's string.
CustomType string
If the IM type is custom, this property holds the custom type string.
Im string
The user's IM network ID.
Primary bool
If this is the user's primary IM. Only one entry in the IM list can have a value of true.
protocol This property is required. String
An IM protocol identifies the IM network. The value can be a custom network or the standard network. Acceptable values: aim, custom_protocol, gtalk, icq, jabber, msn, net_meeting, qq, skype, yahoo.
type This property is required. String
Acceptable values: custom, home, other, work.
customProtocol String
If the protocol value is custom_protocol, this property holds the custom protocol's string.
customType String
If the IM type is custom, this property holds the custom type string.
im String
The user's IM network ID.
primary Boolean
If this is the user's primary IM. Only one entry in the IM list can have a value of true.
protocol This property is required. string
An IM protocol identifies the IM network. The value can be a custom network or the standard network. Acceptable values: aim, custom_protocol, gtalk, icq, jabber, msn, net_meeting, qq, skype, yahoo.
type This property is required. string
Acceptable values: custom, home, other, work.
customProtocol string
If the protocol value is custom_protocol, this property holds the custom protocol's string.
customType string
If the IM type is custom, this property holds the custom type string.
im string
The user's IM network ID.
primary boolean
If this is the user's primary IM. Only one entry in the IM list can have a value of true.
protocol This property is required. str
An IM protocol identifies the IM network. The value can be a custom network or the standard network. Acceptable values: aim, custom_protocol, gtalk, icq, jabber, msn, net_meeting, qq, skype, yahoo.
type This property is required. str
Acceptable values: custom, home, other, work.
custom_protocol str
If the protocol value is custom_protocol, this property holds the custom protocol's string.
custom_type str
If the IM type is custom, this property holds the custom type string.
im str
The user's IM network ID.
primary bool
If this is the user's primary IM. Only one entry in the IM list can have a value of true.
protocol This property is required. String
An IM protocol identifies the IM network. The value can be a custom network or the standard network. Acceptable values: aim, custom_protocol, gtalk, icq, jabber, msn, net_meeting, qq, skype, yahoo.
type This property is required. String
Acceptable values: custom, home, other, work.
customProtocol String
If the protocol value is custom_protocol, this property holds the custom protocol's string.
customType String
If the IM type is custom, this property holds the custom type string.
im String
The user's IM network ID.
primary Boolean
If this is the user's primary IM. Only one entry in the IM list can have a value of true.

UserKeyword
, UserKeywordArgs

Type This property is required. string
Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. Acceptable values: custom, mission, occupation, outlook
Value This property is required. string
Keyword.
CustomType string
Custom Type.
Type This property is required. string
Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. Acceptable values: custom, mission, occupation, outlook
Value This property is required. string
Keyword.
CustomType string
Custom Type.
type This property is required. String
Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. Acceptable values: custom, mission, occupation, outlook
value This property is required. String
Keyword.
customType String
Custom Type.
type This property is required. string
Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. Acceptable values: custom, mission, occupation, outlook
value This property is required. string
Keyword.
customType string
Custom Type.
type This property is required. str
Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. Acceptable values: custom, mission, occupation, outlook
value This property is required. str
Keyword.
custom_type str
Custom Type.
type This property is required. String
Each entry can have a type which indicates standard type of that entry. For example, keyword could be of type occupation or outlook. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value. Acceptable values: custom, mission, occupation, outlook
value This property is required. String
Keyword.
customType String
Custom Type.

UserLanguage
, UserLanguageArgs

CustomLanguage string
Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set.
LanguageCode string
Defaults to en. Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
Preference string
Defaults to preferred. If present, controls whether the specified languageCode is the user's preferred language. Allowed values are preferred and not_preferred.
CustomLanguage string
Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set.
LanguageCode string
Defaults to en. Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
Preference string
Defaults to preferred. If present, controls whether the specified languageCode is the user's preferred language. Allowed values are preferred and not_preferred.
customLanguage String
Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set.
languageCode String
Defaults to en. Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
preference String
Defaults to preferred. If present, controls whether the specified languageCode is the user's preferred language. Allowed values are preferred and not_preferred.
customLanguage string
Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set.
languageCode string
Defaults to en. Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
preference string
Defaults to preferred. If present, controls whether the specified languageCode is the user's preferred language. Allowed values are preferred and not_preferred.
custom_language str
Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set.
language_code str
Defaults to en. Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
preference str
Defaults to preferred. If present, controls whether the specified languageCode is the user's preferred language. Allowed values are preferred and not_preferred.
customLanguage String
Other language. A user can provide their own language name if there is no corresponding Google III language code. If this is set, LanguageCode can't be set.
languageCode String
Defaults to en. Language Code. Should be used for storing Google III LanguageCode string representation for language. Illegal values cause SchemaException.
preference String
Defaults to preferred. If present, controls whether the specified languageCode is the user's preferred language. Allowed values are preferred and not_preferred.

UserLocation
, UserLocationArgs

Type This property is required. string
The location type. Acceptable values: custom, default, desk
Area string
Textual location. This is most useful for display purposes to concisely describe the location. For example, Mountain View, CA or Near Seattle.
BuildingId string
Building identifier.
CustomType string
If the location type is custom, this property contains the custom value.
DeskCode string
Most specific textual code of individual desk location.
FloorName string
Floor name/number.
FloorSection string
Floor section. More specific location within the floor. For example, if a floor is divided into sections A, B, and C, this field would identify one of those values.
Type This property is required. string
The location type. Acceptable values: custom, default, desk
Area string
Textual location. This is most useful for display purposes to concisely describe the location. For example, Mountain View, CA or Near Seattle.
BuildingId string
Building identifier.
CustomType string
If the location type is custom, this property contains the custom value.
DeskCode string
Most specific textual code of individual desk location.
FloorName string
Floor name/number.
FloorSection string
Floor section. More specific location within the floor. For example, if a floor is divided into sections A, B, and C, this field would identify one of those values.
type This property is required. String
The location type. Acceptable values: custom, default, desk
area String
Textual location. This is most useful for display purposes to concisely describe the location. For example, Mountain View, CA or Near Seattle.
buildingId String
Building identifier.
customType String
If the location type is custom, this property contains the custom value.
deskCode String
Most specific textual code of individual desk location.
floorName String
Floor name/number.
floorSection String
Floor section. More specific location within the floor. For example, if a floor is divided into sections A, B, and C, this field would identify one of those values.
type This property is required. string
The location type. Acceptable values: custom, default, desk
area string
Textual location. This is most useful for display purposes to concisely describe the location. For example, Mountain View, CA or Near Seattle.
buildingId string
Building identifier.
customType string
If the location type is custom, this property contains the custom value.
deskCode string
Most specific textual code of individual desk location.
floorName string
Floor name/number.
floorSection string
Floor section. More specific location within the floor. For example, if a floor is divided into sections A, B, and C, this field would identify one of those values.
type This property is required. str
The location type. Acceptable values: custom, default, desk
area str
Textual location. This is most useful for display purposes to concisely describe the location. For example, Mountain View, CA or Near Seattle.
building_id str
Building identifier.
custom_type str
If the location type is custom, this property contains the custom value.
desk_code str
Most specific textual code of individual desk location.
floor_name str
Floor name/number.
floor_section str
Floor section. More specific location within the floor. For example, if a floor is divided into sections A, B, and C, this field would identify one of those values.
type This property is required. String
The location type. Acceptable values: custom, default, desk
area String
Textual location. This is most useful for display purposes to concisely describe the location. For example, Mountain View, CA or Near Seattle.
buildingId String
Building identifier.
customType String
If the location type is custom, this property contains the custom value.
deskCode String
Most specific textual code of individual desk location.
floorName String
Floor name/number.
floorSection String
Floor section. More specific location within the floor. For example, if a floor is divided into sections A, B, and C, this field would identify one of those values.

UserName
, UserNameArgs

FamilyName This property is required. string
The user's last name.
FullName string
The user's full name formed by concatenating the first and last name values.
GivenName string
The user's first name.
FamilyName This property is required. string
The user's last name.
FullName string
The user's full name formed by concatenating the first and last name values.
GivenName string
The user's first name.
familyName This property is required. String
The user's last name.
fullName String
The user's full name formed by concatenating the first and last name values.
givenName String
The user's first name.
familyName This property is required. string
The user's last name.
fullName string
The user's full name formed by concatenating the first and last name values.
givenName string
The user's first name.
family_name This property is required. str
The user's last name.
full_name str
The user's full name formed by concatenating the first and last name values.
given_name str
The user's first name.
familyName This property is required. String
The user's last name.
fullName String
The user's full name formed by concatenating the first and last name values.
givenName String
The user's first name.

UserOrganization
, UserOrganizationArgs

Type This property is required. string
The type of organization. Acceptable values: domain_only, school, unknown, work.
CostCenter string
The cost center of the user's organization.
CustomType string
If the value of type is custom, this property contains the custom value.
Department string
Specifies the department within the organization, such as sales or engineering.
Description string
The description of the organization.
Domain string
The domain the organization belongs to.
FullTimeEquivalent double
The full-time equivalent millipercent within the organization (100000 = 100%)
Location string
The physical location of the organization. This does not need to be a fully qualified address.
Name string
The name of the organization.
Primary bool
Indicates if this is the user's primary organization. A user may only have one primary organization.
Symbol string
Text string symbol of the organization. For example, the text symbol for Google is GOOG.
Title string
The user's title within the organization. For example, member or engineer.
Type This property is required. string
The type of organization. Acceptable values: domain_only, school, unknown, work.
CostCenter string
The cost center of the user's organization.
CustomType string
If the value of type is custom, this property contains the custom value.
Department string
Specifies the department within the organization, such as sales or engineering.
Description string
The description of the organization.
Domain string
The domain the organization belongs to.
FullTimeEquivalent float64
The full-time equivalent millipercent within the organization (100000 = 100%)
Location string
The physical location of the organization. This does not need to be a fully qualified address.
Name string
The name of the organization.
Primary bool
Indicates if this is the user's primary organization. A user may only have one primary organization.
Symbol string
Text string symbol of the organization. For example, the text symbol for Google is GOOG.
Title string
The user's title within the organization. For example, member or engineer.
type This property is required. String
The type of organization. Acceptable values: domain_only, school, unknown, work.
costCenter String
The cost center of the user's organization.
customType String
If the value of type is custom, this property contains the custom value.
department String
Specifies the department within the organization, such as sales or engineering.
description String
The description of the organization.
domain String
The domain the organization belongs to.
fullTimeEquivalent Double
The full-time equivalent millipercent within the organization (100000 = 100%)
location String
The physical location of the organization. This does not need to be a fully qualified address.
name String
The name of the organization.
primary Boolean
Indicates if this is the user's primary organization. A user may only have one primary organization.
symbol String
Text string symbol of the organization. For example, the text symbol for Google is GOOG.
title String
The user's title within the organization. For example, member or engineer.
type This property is required. string
The type of organization. Acceptable values: domain_only, school, unknown, work.
costCenter string
The cost center of the user's organization.
customType string
If the value of type is custom, this property contains the custom value.
department string
Specifies the department within the organization, such as sales or engineering.
description string
The description of the organization.
domain string
The domain the organization belongs to.
fullTimeEquivalent number
The full-time equivalent millipercent within the organization (100000 = 100%)
location string
The physical location of the organization. This does not need to be a fully qualified address.
name string
The name of the organization.
primary boolean
Indicates if this is the user's primary organization. A user may only have one primary organization.
symbol string
Text string symbol of the organization. For example, the text symbol for Google is GOOG.
title string
The user's title within the organization. For example, member or engineer.
type This property is required. str
The type of organization. Acceptable values: domain_only, school, unknown, work.
cost_center str
The cost center of the user's organization.
custom_type str
If the value of type is custom, this property contains the custom value.
department str
Specifies the department within the organization, such as sales or engineering.
description str
The description of the organization.
domain str
The domain the organization belongs to.
full_time_equivalent float
The full-time equivalent millipercent within the organization (100000 = 100%)
location str
The physical location of the organization. This does not need to be a fully qualified address.
name str
The name of the organization.
primary bool
Indicates if this is the user's primary organization. A user may only have one primary organization.
symbol str
Text string symbol of the organization. For example, the text symbol for Google is GOOG.
title str
The user's title within the organization. For example, member or engineer.
type This property is required. String
The type of organization. Acceptable values: domain_only, school, unknown, work.
costCenter String
The cost center of the user's organization.
customType String
If the value of type is custom, this property contains the custom value.
department String
Specifies the department within the organization, such as sales or engineering.
description String
The description of the organization.
domain String
The domain the organization belongs to.
fullTimeEquivalent Number
The full-time equivalent millipercent within the organization (100000 = 100%)
location String
The physical location of the organization. This does not need to be a fully qualified address.
name String
The name of the organization.
primary Boolean
Indicates if this is the user's primary organization. A user may only have one primary organization.
symbol String
Text string symbol of the organization. For example, the text symbol for Google is GOOG.
title String
The user's title within the organization. For example, member or engineer.

UserPhone
, UserPhoneArgs

Type This property is required. string
The type of phone number. Acceptable values: assistant, callback, car, company_main , custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.
Value This property is required. string
A human-readable phone number. It may be in any telephone number format.
CustomType string
If the phone number type is custom, this property contains the custom value and must be set.
Primary bool
Indicates if this is the user's primary phone number. A user may only have one primary phone number.
Type This property is required. string
The type of phone number. Acceptable values: assistant, callback, car, company_main , custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.
Value This property is required. string
A human-readable phone number. It may be in any telephone number format.
CustomType string
If the phone number type is custom, this property contains the custom value and must be set.
Primary bool
Indicates if this is the user's primary phone number. A user may only have one primary phone number.
type This property is required. String
The type of phone number. Acceptable values: assistant, callback, car, company_main , custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.
value This property is required. String
A human-readable phone number. It may be in any telephone number format.
customType String
If the phone number type is custom, this property contains the custom value and must be set.
primary Boolean
Indicates if this is the user's primary phone number. A user may only have one primary phone number.
type This property is required. string
The type of phone number. Acceptable values: assistant, callback, car, company_main , custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.
value This property is required. string
A human-readable phone number. It may be in any telephone number format.
customType string
If the phone number type is custom, this property contains the custom value and must be set.
primary boolean
Indicates if this is the user's primary phone number. A user may only have one primary phone number.
type This property is required. str
The type of phone number. Acceptable values: assistant, callback, car, company_main , custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.
value This property is required. str
A human-readable phone number. It may be in any telephone number format.
custom_type str
If the phone number type is custom, this property contains the custom value and must be set.
primary bool
Indicates if this is the user's primary phone number. A user may only have one primary phone number.
type This property is required. String
The type of phone number. Acceptable values: assistant, callback, car, company_main , custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.
value This property is required. String
A human-readable phone number. It may be in any telephone number format.
customType String
If the phone number type is custom, this property contains the custom value and must be set.
primary Boolean
Indicates if this is the user's primary phone number. A user may only have one primary phone number.

UserPosixAccount
, UserPosixAccountArgs

AccountId string
A POSIX account field identifier.
Gecos string
The GECOS (user information) for this account.
Gid string
The default group ID.
HomeDirectory string
The path to the home directory for this account.
OperatingSystemType string
The operating system type for this account. Acceptable values: linux, unspecified, windows.
Primary bool
If this is user's primary account within the SystemId.
Shell string
The path to the login shell for this account.
SystemId string
System identifier for which account Username or Uid apply to.
Uid string
The POSIX compliant user ID.
Username string
The username of the account.
AccountId string
A POSIX account field identifier.
Gecos string
The GECOS (user information) for this account.
Gid string
The default group ID.
HomeDirectory string
The path to the home directory for this account.
OperatingSystemType string
The operating system type for this account. Acceptable values: linux, unspecified, windows.
Primary bool
If this is user's primary account within the SystemId.
Shell string
The path to the login shell for this account.
SystemId string
System identifier for which account Username or Uid apply to.
Uid string
The POSIX compliant user ID.
Username string
The username of the account.
accountId String
A POSIX account field identifier.
gecos String
The GECOS (user information) for this account.
gid String
The default group ID.
homeDirectory String
The path to the home directory for this account.
operatingSystemType String
The operating system type for this account. Acceptable values: linux, unspecified, windows.
primary Boolean
If this is user's primary account within the SystemId.
shell String
The path to the login shell for this account.
systemId String
System identifier for which account Username or Uid apply to.
uid String
The POSIX compliant user ID.
username String
The username of the account.
accountId string
A POSIX account field identifier.
gecos string
The GECOS (user information) for this account.
gid string
The default group ID.
homeDirectory string
The path to the home directory for this account.
operatingSystemType string
The operating system type for this account. Acceptable values: linux, unspecified, windows.
primary boolean
If this is user's primary account within the SystemId.
shell string
The path to the login shell for this account.
systemId string
System identifier for which account Username or Uid apply to.
uid string
The POSIX compliant user ID.
username string
The username of the account.
account_id str
A POSIX account field identifier.
gecos str
The GECOS (user information) for this account.
gid str
The default group ID.
home_directory str
The path to the home directory for this account.
operating_system_type str
The operating system type for this account. Acceptable values: linux, unspecified, windows.
primary bool
If this is user's primary account within the SystemId.
shell str
The path to the login shell for this account.
system_id str
System identifier for which account Username or Uid apply to.
uid str
The POSIX compliant user ID.
username str
The username of the account.
accountId String
A POSIX account field identifier.
gecos String
The GECOS (user information) for this account.
gid String
The default group ID.
homeDirectory String
The path to the home directory for this account.
operatingSystemType String
The operating system type for this account. Acceptable values: linux, unspecified, windows.
primary Boolean
If this is user's primary account within the SystemId.
shell String
The path to the login shell for this account.
systemId String
System identifier for which account Username or Uid apply to.
uid String
The POSIX compliant user ID.
username String
The username of the account.

UserRelation
, UserRelationArgs

Type This property is required. string
The type of relation. Acceptable values: admin_assistant, assistant, brother, child, custom, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse.
Value This property is required. string
The name of the person the user is related to.
CustomType string
If the value of type is custom, this property contains the custom type string.
Type This property is required. string
The type of relation. Acceptable values: admin_assistant, assistant, brother, child, custom, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse.
Value This property is required. string
The name of the person the user is related to.
CustomType string
If the value of type is custom, this property contains the custom type string.
type This property is required. String
The type of relation. Acceptable values: admin_assistant, assistant, brother, child, custom, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse.
value This property is required. String
The name of the person the user is related to.
customType String
If the value of type is custom, this property contains the custom type string.
type This property is required. string
The type of relation. Acceptable values: admin_assistant, assistant, brother, child, custom, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse.
value This property is required. string
The name of the person the user is related to.
customType string
If the value of type is custom, this property contains the custom type string.
type This property is required. str
The type of relation. Acceptable values: admin_assistant, assistant, brother, child, custom, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse.
value This property is required. str
The name of the person the user is related to.
custom_type str
If the value of type is custom, this property contains the custom type string.
type This property is required. String
The type of relation. Acceptable values: admin_assistant, assistant, brother, child, custom, domestic_partner, dotted_line_manager, exec_assistant, father, friend, manager, mother, parent, partner, referred_by, relative, sister, spouse.
value This property is required. String
The name of the person the user is related to.
customType String
If the value of type is custom, this property contains the custom type string.

UserSshPublicKey
, UserSshPublicKeyArgs

Key This property is required. string
An SSH public key.
ExpirationTimeUsec string
An expiration time in microseconds since epoch.
Fingerprint string
A SHA-256 fingerprint of the SSH public key.
Key This property is required. string
An SSH public key.
ExpirationTimeUsec string
An expiration time in microseconds since epoch.
Fingerprint string
A SHA-256 fingerprint of the SSH public key.
key This property is required. String
An SSH public key.
expirationTimeUsec String
An expiration time in microseconds since epoch.
fingerprint String
A SHA-256 fingerprint of the SSH public key.
key This property is required. string
An SSH public key.
expirationTimeUsec string
An expiration time in microseconds since epoch.
fingerprint string
A SHA-256 fingerprint of the SSH public key.
key This property is required. str
An SSH public key.
expiration_time_usec str
An expiration time in microseconds since epoch.
fingerprint str
A SHA-256 fingerprint of the SSH public key.
key This property is required. String
An SSH public key.
expirationTimeUsec String
An expiration time in microseconds since epoch.
fingerprint String
A SHA-256 fingerprint of the SSH public key.

UserTimeouts
, UserTimeoutsArgs

Create string
Update string
Create string
Update string
create String
update String
create string
update string
create str
update str
create String
update String

UserWebsite
, UserWebsiteArgs

Type This property is required. string
The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type Custom types must have a customType value. Acceptable values: app_install_page, blog, custom, ftp , home, home_page, other, profile, reservations, resume, work.
Value This property is required. string
The URL of the website.
CustomType string
The custom type. Only used if the type is custom.
Primary bool
If this is user's primary website or not.
Type This property is required. string
The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type Custom types must have a customType value. Acceptable values: app_install_page, blog, custom, ftp , home, home_page, other, profile, reservations, resume, work.
Value This property is required. string
The URL of the website.
CustomType string
The custom type. Only used if the type is custom.
Primary bool
If this is user's primary website or not.
type This property is required. String
The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type Custom types must have a customType value. Acceptable values: app_install_page, blog, custom, ftp , home, home_page, other, profile, reservations, resume, work.
value This property is required. String
The URL of the website.
customType String
The custom type. Only used if the type is custom.
primary Boolean
If this is user's primary website or not.
type This property is required. string
The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type Custom types must have a customType value. Acceptable values: app_install_page, blog, custom, ftp , home, home_page, other, profile, reservations, resume, work.
value This property is required. string
The URL of the website.
customType string
The custom type. Only used if the type is custom.
primary boolean
If this is user's primary website or not.
type This property is required. str
The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type Custom types must have a customType value. Acceptable values: app_install_page, blog, custom, ftp , home, home_page, other, profile, reservations, resume, work.
value This property is required. str
The URL of the website.
custom_type str
The custom type. Only used if the type is custom.
primary bool
If this is user's primary website or not.
type This property is required. String
The type or purpose of the website. For example, a website could be labeled as home or blog. Alternatively, an entry can have a custom type Custom types must have a customType value. Acceptable values: app_install_page, blog, custom, ftp , home, home_page, other, profile, reservations, resume, work.
value This property is required. String
The URL of the website.
customType String
The custom type. Only used if the type is custom.
primary Boolean
If this is user's primary website or not.

Import

$ pulumi import googleworkspace:index/user:User dwight 123456789012345678901
Copy

or with email as id

$ pulumi import googleworkspace:index/user:User dwight dwight.schrute@example.com
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
googleworkspace hashicorp/terraform-provider-googleworkspace
License
Notes
This Pulumi package is based on the googleworkspace Terraform Provider.
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace