1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. getUsers
Viewing docs for googleworkspace 0.7.0
published on Wednesday, Jan 15, 2025 by hashicorp
Schema (JSON)
hashicorp/terraform-provider-googleworkspace

googleworkspace.getUsers

googleworkspace logo
Viewing docs for googleworkspace 0.7.0
published on Wednesday, Jan 15, 2025 by hashicorp
Schema (JSON)
hashicorp/terraform-provider-googleworkspace

    Example Usage

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

const my-domain-users = googleworkspace.getUsers({});
export const numUsers = my_domain_users.then(my_domain_users => my_domain_users.users).length;

    import pulumi
import pulumi_googleworkspace as googleworkspace

my_domain_users = googleworkspace.get_users()
pulumi.export("numUsers", len(my_domain_users.users))

    package main

import (
	"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 {
		my_domain_users, err := googleworkspace.GetUsers(ctx, &googleworkspace.GetUsersArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("numUsers", pulumi.Int(len(my_domain_users.Users)))
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Googleworkspace = Pulumi.Googleworkspace;

return await Deployment.RunAsync(() => 
{
    var my_domain_users = Googleworkspace.GetUsers.Invoke();

    return new Dictionary<string, object?>
    {
        ["numUsers"] = my_domain_users.Apply(my_domain_users => my_domain_users.Apply(getUsersResult => getUsersResult.Users)).Length,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.GoogleworkspaceFunctions;
import com.pulumi.googleworkspace.inputs.GetUsersArgs;
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) {
        final var my-domain-users = GoogleworkspaceFunctions.getUsers();

        ctx.export("numUsers", my_domain_users.users().length());
    }
}

    Example coming soon!

    Using getUsers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

    > Note: This function is named GetUsers in the Go SDK.

    public static class GetUsers 
{
    public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)

    fn::invoke:
  function: googleworkspace:index/getUsers:getUsers
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    id String
    The ID of this resource.

    getUsers Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Users List<GetUsersUser>
    A list of User resources.
    Id string
    The ID of this resource.
    Users []GetUsersUser
    A list of User resources.
    id String
    The ID of this resource.
    users List<GetUsersUser>
    A list of User resources.
    id string
    The ID of this resource.
    users GetUsersUser[]
    A list of User resources.
    id str
    The ID of this resource.
    users Sequence[GetUsersUser]
    A list of User resources.
    id String
    The ID of this resource.
    users List<Property Map>
    A list of User resources.

    Supporting Types

    GetUsersUser

    Addresses List<GetUsersUserAddress>
    AgreedToTerms bool
    Aliases List<string>
    Archived bool
    ChangePasswordAtNextLogin bool
    CreationTime string
    CustomSchemas List<GetUsersUserCustomSchema>
    CustomerId string
    DeletionTime string
    Emails List<GetUsersUserEmail>
    Etag string
    ExternalIds List<GetUsersUserExternalId>
    HashFunction string
    Id string
    Ims List<GetUsersUserIm>
    IncludeInGlobalAddressList bool
    IpAllowlist bool
    IsAdmin bool
    IsDelegatedAdmin bool
    IsEnforcedIn2StepVerification bool
    IsEnrolledIn2StepVerification bool
    IsMailboxSetup bool
    Keywords List<GetUsersUserKeyword>
    Languages List<GetUsersUserLanguage>
    LastLoginTime string
    Locations List<GetUsersUserLocation>
    Names List<GetUsersUserName>
    NonEditableAliases List<string>
    OrgUnitPath string
    Organizations List<GetUsersUserOrganization>
    Password string
    Phones List<GetUsersUserPhone>
    PosixAccounts List<GetUsersUserPosixAccount>
    PrimaryEmail string
    RecoveryEmail string
    RecoveryPhone string
    Relations List<GetUsersUserRelation>
    SshPublicKeys List<GetUsersUserSshPublicKey>
    Suspended bool
    SuspensionReason string
    ThumbnailPhotoEtag string
    ThumbnailPhotoUrl string
    Websites List<GetUsersUserWebsite>
    Addresses []GetUsersUserAddress
    AgreedToTerms bool
    Aliases []string
    Archived bool
    ChangePasswordAtNextLogin bool
    CreationTime string
    CustomSchemas []GetUsersUserCustomSchema
    CustomerId string
    DeletionTime string
    Emails []GetUsersUserEmail
    Etag string
    ExternalIds []GetUsersUserExternalId
    HashFunction string
    Id string
    Ims []GetUsersUserIm
    IncludeInGlobalAddressList bool
    IpAllowlist bool
    IsAdmin bool
    IsDelegatedAdmin bool
    IsEnforcedIn2StepVerification bool
    IsEnrolledIn2StepVerification bool
    IsMailboxSetup bool
    Keywords []GetUsersUserKeyword
    Languages []GetUsersUserLanguage
    LastLoginTime string
    Locations []GetUsersUserLocation
    Names []GetUsersUserName
    NonEditableAliases []string
    OrgUnitPath string
    Organizations []GetUsersUserOrganization
    Password string
    Phones []GetUsersUserPhone
    PosixAccounts []GetUsersUserPosixAccount
    PrimaryEmail string
    RecoveryEmail string
    RecoveryPhone string
    Relations []GetUsersUserRelation
    SshPublicKeys []GetUsersUserSshPublicKey
    Suspended bool
    SuspensionReason string
    ThumbnailPhotoEtag string
    ThumbnailPhotoUrl string
    Websites []GetUsersUserWebsite
    addresses List<GetUsersUserAddress>
    agreedToTerms Boolean
    aliases List<String>
    archived Boolean
    changePasswordAtNextLogin Boolean
    creationTime String
    customSchemas List<GetUsersUserCustomSchema>
    customerId String
    deletionTime String
    emails List<GetUsersUserEmail>
    etag String
    externalIds List<GetUsersUserExternalId>
    hashFunction String
    id String
    ims List<GetUsersUserIm>
    includeInGlobalAddressList Boolean
    ipAllowlist Boolean
    isAdmin Boolean
    isDelegatedAdmin Boolean
    isEnforcedIn2StepVerification Boolean
    isEnrolledIn2StepVerification Boolean
    isMailboxSetup Boolean
    keywords List<GetUsersUserKeyword>
    languages List<GetUsersUserLanguage>
    lastLoginTime String
    locations List<GetUsersUserLocation>
    names List<GetUsersUserName>
    nonEditableAliases List<String>
    orgUnitPath String
    organizations List<GetUsersUserOrganization>
    password String
    phones List<GetUsersUserPhone>
    posixAccounts List<GetUsersUserPosixAccount>
    primaryEmail String
    recoveryEmail String
    recoveryPhone String
    relations List<GetUsersUserRelation>
    sshPublicKeys List<GetUsersUserSshPublicKey>
    suspended Boolean
    suspensionReason String
    thumbnailPhotoEtag String
    thumbnailPhotoUrl String
    websites List<GetUsersUserWebsite>
    addresses GetUsersUserAddress[]
    agreedToTerms boolean
    aliases string[]
    archived boolean
    changePasswordAtNextLogin boolean
    creationTime string
    customSchemas GetUsersUserCustomSchema[]
    customerId string
    deletionTime string
    emails GetUsersUserEmail[]
    etag string
    externalIds GetUsersUserExternalId[]
    hashFunction string
    id string
    ims GetUsersUserIm[]
    includeInGlobalAddressList boolean
    ipAllowlist boolean
    isAdmin boolean
    isDelegatedAdmin boolean
    isEnforcedIn2StepVerification boolean
    isEnrolledIn2StepVerification boolean
    isMailboxSetup boolean
    keywords GetUsersUserKeyword[]
    languages GetUsersUserLanguage[]
    lastLoginTime string
    locations GetUsersUserLocation[]
    names GetUsersUserName[]
    nonEditableAliases string[]
    orgUnitPath string
    organizations GetUsersUserOrganization[]
    password string
    phones GetUsersUserPhone[]
    posixAccounts GetUsersUserPosixAccount[]
    primaryEmail string
    recoveryEmail string
    recoveryPhone string
    relations GetUsersUserRelation[]
    sshPublicKeys GetUsersUserSshPublicKey[]
    suspended boolean
    suspensionReason string
    thumbnailPhotoEtag string
    thumbnailPhotoUrl string
    websites GetUsersUserWebsite[]
    addresses Sequence[GetUsersUserAddress]
    agreed_to_terms bool
    aliases Sequence[str]
    archived bool
    change_password_at_next_login bool
    creation_time str
    custom_schemas Sequence[GetUsersUserCustomSchema]
    customer_id str
    deletion_time str
    emails Sequence[GetUsersUserEmail]
    etag str
    external_ids Sequence[GetUsersUserExternalId]
    hash_function str
    id str
    ims Sequence[GetUsersUserIm]
    include_in_global_address_list bool
    ip_allowlist bool
    is_admin bool
    is_delegated_admin bool
    is_enforced_in2_step_verification bool
    is_enrolled_in2_step_verification bool
    is_mailbox_setup bool
    keywords Sequence[GetUsersUserKeyword]
    languages Sequence[GetUsersUserLanguage]
    last_login_time str
    locations Sequence[GetUsersUserLocation]
    names Sequence[GetUsersUserName]
    non_editable_aliases Sequence[str]
    org_unit_path str
    organizations Sequence[GetUsersUserOrganization]
    password str
    phones Sequence[GetUsersUserPhone]
    posix_accounts Sequence[GetUsersUserPosixAccount]
    primary_email str
    recovery_email str
    recovery_phone str
    relations Sequence[GetUsersUserRelation]
    ssh_public_keys Sequence[GetUsersUserSshPublicKey]
    suspended bool
    suspension_reason str
    thumbnail_photo_etag str
    thumbnail_photo_url str
    websites Sequence[GetUsersUserWebsite]
    addresses List<Property Map>
    agreedToTerms Boolean
    aliases List<String>
    archived Boolean
    changePasswordAtNextLogin Boolean
    creationTime String
    customSchemas List<Property Map>
    customerId String
    deletionTime String
    emails List<Property Map>
    etag String
    externalIds List<Property Map>
    hashFunction String
    id String
    ims List<Property Map>
    includeInGlobalAddressList Boolean
    ipAllowlist Boolean
    isAdmin Boolean
    isDelegatedAdmin Boolean
    isEnforcedIn2StepVerification Boolean
    isEnrolledIn2StepVerification Boolean
    isMailboxSetup Boolean
    keywords List<Property Map>
    languages List<Property Map>
    lastLoginTime String
    locations List<Property Map>
    names List<Property Map>
    nonEditableAliases List<String>
    orgUnitPath String
    organizations List<Property Map>
    password String
    phones List<Property Map>
    posixAccounts List<Property Map>
    primaryEmail String
    recoveryEmail String
    recoveryPhone String
    relations List<Property Map>
    sshPublicKeys List<Property Map>
    suspended Boolean
    suspensionReason String
    thumbnailPhotoEtag String
    thumbnailPhotoUrl String
    websites List<Property Map>

    GetUsersUserAddress

    Country string
    CountryCode string
    CustomType string
    ExtendedAddress string
    Formatted string
    Locality string
    PoBox string
    PostalCode string
    Primary bool
    Region string
    SourceIsStructured bool
    StreetAddress string
    Type string
    Country string
    CountryCode string
    CustomType string
    ExtendedAddress string
    Formatted string
    Locality string
    PoBox string
    PostalCode string
    Primary bool
    Region string
    SourceIsStructured bool
    StreetAddress string
    Type string
    country String
    countryCode String
    customType String
    extendedAddress String
    formatted String
    locality String
    poBox String
    postalCode String
    primary Boolean
    region String
    sourceIsStructured Boolean
    streetAddress String
    type String
    country string
    countryCode string
    customType string
    extendedAddress string
    formatted string
    locality string
    poBox string
    postalCode string
    primary boolean
    region string
    sourceIsStructured boolean
    streetAddress string
    type string
    country String
    countryCode String
    customType String
    extendedAddress String
    formatted String
    locality String
    poBox String
    postalCode String
    primary Boolean
    region String
    sourceIsStructured Boolean
    streetAddress String
    type String

    GetUsersUserCustomSchema

    SchemaName string
    SchemaValues Dictionary<string, string>
    SchemaName string
    SchemaValues map[string]string
    schemaName String
    schemaValues Map<String,String>
    schemaName string
    schemaValues {[key: string]: string}
    schema_name str
    schema_values Mapping[str, str]
    schemaName String
    schemaValues Map<String>

    GetUsersUserEmail

    Address string
    CustomType string
    Primary bool
    Type string
    Address string
    CustomType string
    Primary bool
    Type string
    address String
    customType String
    primary Boolean
    type String
    address string
    customType string
    primary boolean
    type string
    address String
    customType String
    primary Boolean
    type String

    GetUsersUserExternalId

    CustomType string
    Type string
    Value string
    CustomType string
    Type string
    Value string
    customType String
    type String
    value String
    customType string
    type string
    value string
    customType String
    type String
    value String

    GetUsersUserIm

    CustomProtocol string
    CustomType string
    Im string
    Primary bool
    Protocol string
    Type string
    CustomProtocol string
    CustomType string
    Im string
    Primary bool
    Protocol string
    Type string
    customProtocol String
    customType String
    im String
    primary Boolean
    protocol String
    type String
    customProtocol string
    customType string
    im string
    primary boolean
    protocol string
    type string
    customProtocol String
    customType String
    im String
    primary Boolean
    protocol String
    type String

    GetUsersUserKeyword

    CustomType string
    Type string
    Value string
    CustomType string
    Type string
    Value string
    customType String
    type String
    value String
    customType string
    type string
    value string
    customType String
    type String
    value String

    GetUsersUserLanguage

    GetUsersUserLocation

    Area string
    BuildingId string
    CustomType string
    DeskCode string
    FloorName string
    FloorSection string
    Type string
    Area string
    BuildingId string
    CustomType string
    DeskCode string
    FloorName string
    FloorSection string
    Type string
    area String
    buildingId String
    customType String
    deskCode String
    floorName String
    floorSection String
    type String
    area string
    buildingId string
    customType string
    deskCode string
    floorName string
    floorSection string
    type string
    area String
    buildingId String
    customType String
    deskCode String
    floorName String
    floorSection String
    type String

    GetUsersUserName

    FamilyName string
    FullName string
    GivenName string
    FamilyName string
    FullName string
    GivenName string
    familyName String
    fullName String
    givenName String
    familyName string
    fullName string
    givenName string
    familyName String
    fullName String
    givenName String

    GetUsersUserOrganization

    CostCenter string
    CustomType string
    Department string
    Description string
    Domain string
    FullTimeEquivalent double
    Location string
    Name string
    Primary bool
    Symbol string
    Title string
    Type string
    CostCenter string
    CustomType string
    Department string
    Description string
    Domain string
    FullTimeEquivalent float64
    Location string
    Name string
    Primary bool
    Symbol string
    Title string
    Type string
    costCenter String
    customType String
    department String
    description String
    domain String
    fullTimeEquivalent Double
    location String
    name String
    primary Boolean
    symbol String
    title String
    type String
    costCenter string
    customType string
    department string
    description string
    domain string
    fullTimeEquivalent number
    location string
    name string
    primary boolean
    symbol string
    title string
    type string
    costCenter String
    customType String
    department String
    description String
    domain String
    fullTimeEquivalent Number
    location String
    name String
    primary Boolean
    symbol String
    title String
    type String

    GetUsersUserPhone

    CustomType string
    Primary bool
    Type string
    Value string
    CustomType string
    Primary bool
    Type string
    Value string
    customType String
    primary Boolean
    type String
    value String
    customType string
    primary boolean
    type string
    value string
    customType String
    primary Boolean
    type String
    value String

    GetUsersUserPosixAccount

    AccountId string
    Gecos string
    Gid string
    HomeDirectory string
    OperatingSystemType string
    Primary bool
    Shell string
    SystemId string
    Uid string
    Username string
    AccountId string
    Gecos string
    Gid string
    HomeDirectory string
    OperatingSystemType string
    Primary bool
    Shell string
    SystemId string
    Uid string
    Username string
    accountId String
    gecos String
    gid String
    homeDirectory String
    operatingSystemType String
    primary Boolean
    shell String
    systemId String
    uid String
    username String
    accountId string
    gecos string
    gid string
    homeDirectory string
    operatingSystemType string
    primary boolean
    shell string
    systemId string
    uid string
    username string
    accountId String
    gecos String
    gid String
    homeDirectory String
    operatingSystemType String
    primary Boolean
    shell String
    systemId String
    uid String
    username String

    GetUsersUserRelation

    CustomType string
    Type string
    Value string
    CustomType string
    Type string
    Value string
    customType String
    type String
    value String
    customType string
    type string
    value string
    customType String
    type String
    value String

    GetUsersUserSshPublicKey

    GetUsersUserWebsite

    CustomType string
    Primary bool
    Type string
    Value string
    CustomType string
    Primary bool
    Type string
    Value string
    customType String
    primary Boolean
    type String
    value String
    customType string
    primary boolean
    type string
    value string
    customType String
    primary Boolean
    type String
    value String

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    Viewing docs for googleworkspace 0.7.0
    published on Wednesday, Jan 15, 2025 by hashicorp
    Schema (JSON)
    hashicorp/terraform-provider-googleworkspace
      Try Pulumi Cloud free. Your team will thank you.