Integrations
- Integrations
- 1Password
- Abnormal
- Absolute
- AbuseIPDB
- Adaptive Shield
- Adobe Cloud
- ADP
- Agari Phishing Response
- Airlock
- Airlock Digital
- Akamai Identity Cloud Social
- Alert Logic
- AlgoSec Firewall Analyzer
- AlienVault OTX
- AlienVault USM
- Anodot
- Ansible
- Anvilogic
- Any Run
- Apex One
- ArcSight ESM
- Area 1
- Asana
- Asset Panda
- Atlassian User Management
- Atlassian User Provisioning
- auth0
- Authentik
- Authomize
- Automox
- AWS
- AWS IAM Identity Center
- Axonius
- Azure
- Azure Data Explorer
- Azure DevOps
- Azure Log Analytics
- Azure Storage
- BambooHR
- Big Fix
- BigPanda
- Bitbucket
- Bitdefender
- Bitsight
- Bitwarden
- Black Duck
- Black Kite
- Blink
- BMC Remedy
- Box
- Brinqa
- Cato Networks
- Censys
- Check Point Harmony
- Check Point Infinity Events
- Check Point XDR-XPR
- Check Point Management
- Checkmarx One
- Checkmarx SAST
- Chorus
- Chronicle
- Cisco Advanced Phishing Protection
- Cisco Domain Protection
- Cisco Meraki
- Cisco Talos
- Cisco Umbrella
- Cisco Webex
- Claroty xDome
- ClearPass
- ClickHouse
- ClickUp
- Cloud Custodian
- Cloudflare
- Cobalt
- Compass
- Confluence
- Confluence Data Center
- Coralogix
- Coralogix Incident Management
- Cortex XDR
- Cortex Xpanse
- CredStash
- Cribl
- CrowdStrike
- CyberArk
- Cybersixgill
- CyCognito
- Cyera
- Cylance
- Cyware CTIX
- Darktrace
- Dasera
- Databricks
- Datadog
- DataSet
- Delighted
- Delinea
- Devo
- Discord
- Docusign
- Domo
- Drata
- Dropbox
- Dropbox Business
- Druva
- Duo
- Duo Auth
- Dynatrace
- EasyVista
- EchoTrail
- Egnyte
- Egnyte Secure Govern
- Elasticsearch
- Entro
- Ermetic
- Exabeam
- Exchange Online
- Expel
- F5 BIG IP
- Falcon LogScale
- Falcon Surface
- Flare.io
- Forcepoint DLP
- Forescout
- FortiGate
- Freshservice
- GCP
- Ghostwriter
- Git
- GitHub
- GitLab
- Glean
- Gmail
- Google Calendar
- Google Chat
- Google Docs
- Google Drive
- Google Forms
- Google Looker
- Google Meet
- Google Sheets
- Google Workspace
- Google Workspace
- Actions
- Overview
- Add User To Group
- Add Users To Group
- Create Group
- Create User
- Delete Device
- Delete User
- Directory Tokens Delete
- Get Device
- Get Group
- Get User Info
- Get Users Info
- Google Workspace Custom Action
- List Activities
- List Admin Activities
- List Alerts
- List All Group Members
- List All Users
- List Devices
- List Group Members
- List Groups
- List Organizational Units
- List Roles
- List Users
- Remove User From Group
- Remove Users From Group
- Revoke License
- Role Assignment
- Transfer Drive Ownership
- Update User
- Triggers
- Grafana
- Grip Security
- GYTPOL
- Have I Been Pwned
- HiBob
- HubSpot
- Hunters
- Hybrid Analysis
- Hyperproof
- IBM Cloud
- IBM NS1 Connect
- IBM X Force
- Imperva
- incident.io
- Infoblox Cloud Services Portal
- Integrations
- Intercom
- Intezer
- IP API
- IPinfo
- IPWHOIS
- Ironscales
- Ivanti RiskSense
- Jamf
- JetBrains
- JFrog
- Jira
- Jira Data Center
- Joe Sandbox
- JumpCloud
- Kandji
- Keeper Secrets Manager
- Kenna Security
- KnowBe4
- KnowBe4 Events
- Kubernetes
- Lacework
- LaunchDarkly
- Linear
- Litmos
- LogicMonitor
- LogRhythm
- Manage Engine ServiceDesk Plus
- Mattermost
- Maven
- Microsoft Defender For Cloud
- Microsoft Defender For Cloud Apps
- Microsoft Defender For Endpoints
- Microsoft Defender XDR
- Microsoft E-Discovery
- Microsoft Entra ID
- Microsoft Graph
- Microsoft Intune
- Microsoft Office 365 Management Activity
- Microsoft Outlook
- Microsoft Purview
- Microsoft Sentinel
- Microsoft SQL Server
- Microsoft Teams
- Mimecast
- MISP
- Monday
- MongoDB Atlas
- MxToolbox
- Neo4j
- NetBox
- Netography
- Netskope
- New Relic
- Nightfall AI
- NinjaOne
- Notion
- Nozomi Networks
- Nuclei
- Nucleus
- Nutanix Hypervisor
- Obsidian
- Okta
- OneDrive
- OneLogin
- OneTrust
- OpenAI
- OpenCTI
- Opsgenie
- OPSWAT
- Oracle Cloud
- Oracle HCM
- Orca Security
- OWASP ZAP
- PagerDuty
- Palo Alto Cloud NGFW
- Palo Alto Firewall
- Panther
- Pentera
- Perception Point
- PhishLabs
- PhishLabs Incident Data
- PhishLabs Open Web Monitoring
- Pingdom
- PingID
- PingOne
- PlexTrac
- PortSwigger
- Postman
- Postman SCIM
- Power BI
- PowerShell
- Prisma Access
- Prisma Cloud CSPM
- Prisma Cloud CWP
- Prometheus
- Proofpoint
- Proofpoint ITM
- Proofpoint Protection Server
- Proofpoint Security Awareness Training
- Proofpoint TAP
- Proofpoint Threat Response Auto Pull
- Pub-Sub
- QRadar
- Qualys
- Rapid7
- Rapid7 InsightIDR
- Rapid7 InsightVM Cloud
- Rapid7 Threat Command
- Reco
- Recorded Future
- Red Hat IdM
- Rippling
- runZero
- SafeBase
- Sage HR
- SailPoint
- SailPoint IdentityIQ
- Salesforce
- SAP Ariba
- ScienceLogic
- Securin
- Securin VI
- SecurityScorecard
- Securonix
- SemGrep
- SentinelOne
- ServiceNow
- SharePoint
- Shodan
- Shopify
- Silverfort
- Slack
- Smartsheet
- Snipe-IT
- Snowflake
- Snyk
- SolarWinds Service Desk
- SonarQube
- Sophos
- Split
- Splunk
- Splunk Observability
- Splunk SOAR
- Spur
- StrongDM
- Sumo Logic
- Symantec EDR
- Sysdig
- Tableau
- Tanium
- TeamCity
- TeamViewer
- Telegram
- Tenable
- Tenable Security Center
- Terraform
- Terraform Cloud
- TheHive
- Thinkst Canary
- ThreatQuotient
- Trellix Email Security
- Trello
- Trend Vision One
- Twilio
- UKG HR
- Uptycs
- URLScan
- Vault
- Veracode
- Verkada
- Vertica
- VirusTotal
- VMware Carbon Black
- VMware vSphere
- WeChat
- WhatsApp
- Whois
- WildFire
- Wiz
- Workday
- Workspace ONE UEM
- YesWeHack
- Zendesk
- Zero Networks
- Zoom
- Zscaler Internet Access
- Zscaler Private Access
Actions
List Users
Retrieves a paginated list of either deleted users or all users in a domain.
Basic Parameters
Parameter | Description |
---|---|
Customer ID | The unique ID for the customer’s Google Workspace account. In caseof a multi-domain account, to fetch all groups for a customer, fill this fieldinstead of domain. You can also use the my_customer alias to represent youraccount’s customerId . The customerId is also returned as part of the Usersresource. Either the customer or thedomain parameter must be provided. |
Domain | The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead. Either the customer or the domain parameter must be provided. |
Query | Query string for searching user fields. For more information on constructing user queries, see Search for Users. |
Advanced Parameters
Parameter | Description |
---|---|
Delegated User Override | Perform the action on behalf of another user, overriding the delegated user defined in the connection.If not specified, the delegated user is the one provided in the connection.Has no effect when using an OAuth connection.NOTE: the connection details are not edited by this input. |
Max Results | Maximum number of results to return. |
Page Token | Token to specify next page in the list. |
Example Output
{ "etag": "ETag of the resource.", "kind": "admin#directory#users", "nextPageToken": "Token used to access next page of this result.", "trigger_event": "Event that triggered this response (only used in case of Push Response)", "users": [ { "addresses": "A list of the user's addresses. The maximum allowed data size for this field is 10Kb.", "agreedToTerms": false, "aliases": [ "string" ], "archived": false, "changePasswordAtNextLogin": false, "creationTime": "User's G Suite account creation time. (Read-only)", "customSchemas": {}, "customerId": "Output only. The customer ID to [retrieve all account users](/admin-sdk/directory/v1/guides/manage-users.html#get_all_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](/admin-sdk/directory/v1/reference/users/list) request.", "deletionTime": "date-time", "emails": "A list of the user's email addresses. The maximum allowed data size for this field is 10Kb.", "etag": "Output only. ETag of the resource.", "externalIds": "A list of external IDs for the user, such as an employee or network ID. The maximum allowed data size for this field is 2Kb.", "gender": "The user's gender. The maximum allowed data size for this field is 1Kb.", "hashFunction": "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](https://wikipedia.org/wiki/SHA-1), [MD5](https://wikipedia.org/wiki/MD5), or [crypt](https://en.wikipedia.org/wiki/Crypt_\\(C\\)) hash format.", "id": "The unique ID for the user. A user `id` can be used as a user request URI's `userKey`.", "ims": "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 for this field is 2Kb.", "includeInGlobalAddressList": false, "ipWhitelisted": false, "isAdmin": false, "isDelegatedAdmin": false, "isEnforcedIn2Sv": false, "isEnrolledIn2Sv": false, "isMailboxSetup": false, "keywords": "The user's keywords. The maximum allowed data size for this field is 1Kb.", "kind": "admin#directory#user", "languages": "The user's languages. The maximum allowed data size for this field is 1Kb.", "lastLoginTime": "User's last login time. (Read-only)", "locations": "The user's locations. The maximum allowed data size for this field is 10Kb.", "name": { "familyName": "The user's last name. Required when creating a user account.", "fullName": "The user's full name formed by concatenating the first and last name values.", "givenName": "The user's first name. Required when creating a user account." }, "nonEditableAliases": [ "string" ], "notes": "Notes for the user.", "orgUnitPath": "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": "A list of organizations the user belongs to. The maximum allowed data size for this field is 10Kb.", "password": "User's password", "phones": "A list of the user's phone numbers. The maximum allowed data size for this field is 1Kb.", "posixAccounts": "A list of [POSIX](https://www.opengroup.org/austin/papers/posix_faq.html) account information for the user.", "primaryEmail": "The user's primary email address. This property is required in a request to create a user account. The `primaryEmail` must be unique and cannot be an alias of another user.", "recoveryEmail": "Recovery email of the user.", "recoveryPhone": "Recovery phone of the user. The phone number must be in the E.164 format, starting with the plus sign (+). Example: *+16506661212*.", "relations": "A list of the user's relationships to other users. The maximum allowed data size for this field is 2Kb.", "sshPublicKeys": "A list of SSH public keys.", "suspended": false, "suspensionReason": "Output only. 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": "Output only. ETag of the user's photo (Read-only)", "thumbnailPhotoUrl": "Output only. Photo Url of the user (Read-only)", "websites": "The user's websites. The maximum allowed data size for this field is 2Kb." } ]}
Workflow Library Example
List Users with Google Workspace and Send Results Via Email
Preview this Workflow on desktop
Was this page helpful?