IntegrationsGoogle workspaceActions
List Google Workspace users
List users in the Workspace directory.
users.list · Google Workspace · v1
Details
Scopes
https://www.googleapis.com/auth/admin.directory.user.readonly
Input
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
customer | string | No | minLength 1 |
query | string | No | — |
page_size | integer | No | minimum 1; maximum 500 |
page_token | string | No | — |
Output
| Name | Type | Required | Constraints |
|---|---|---|---|
(root) | object | Yes | additionalProperties false |
users | array<object> | Yes | — |
users[] | object | Yes | additionalProperties false |
users[].id | string | Yes | — |
users[].primary_email | string | Yes | — |
users[].name | object | No | additionalProperties false |
users[].name.given_name | string | No | — |
users[].name.family_name | string | No | — |
users[].name.full_name | string | No | — |
users[].suspended | boolean | Yes | — |
users[].org_unit_path | string | No | — |
next_page_token | string | No | — |
Raw schema
Input
{
"type": "object",
"additionalProperties": false,
"properties": {
"customer": {
"type": "string",
"minLength": 1
},
"query": {
"type": "string"
},
"page_size": {
"type": "integer",
"minimum": 1,
"maximum": 500
},
"page_token": {
"type": "string"
}
}
}Output
{
"type": "object",
"additionalProperties": false,
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"primary_email": {
"type": "string"
},
"name": {
"type": "object",
"additionalProperties": false,
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"full_name": {
"type": "string"
}
}
},
"suspended": {
"type": "boolean"
},
"org_unit_path": {
"type": "string"
}
},
"required": [
"id",
"primary_email",
"suspended"
]
}
},
"next_page_token": {
"type": "string"
}
},
"required": [
"users"
]
}