---
id: providers-google-workspace-users-list
title: "providers_google_workspace_users_list"
description: "GoogleWorkspaceProviderUser Viewset"
sidebar_label: "providers_google_workspace_users_list"
hide_title: true
hide_table_of_contents: true
api: eJytV99v2zgM/lcE44B7WBb3ug049GnFrSgKdFtx3Y+HrWcoNmNrVSRPkpN1Qf73IyU7VhInTXf30saSSH6kPpLiMtE1GO6EVldFcpbURs9FAcZmpdalhGyhzb2teQ5ZY2lZCuuSUVKAzY2oSQ6lLv3Zz93Rm1bJR5RgnwQsLJBMzQ2fgUMtydmXZaLwA2W1wZNClXjAwPdGGEAcUy4tjBJByr83YB52TH6uRF6xqQBZMKcZgmOLChTr1DFXATNgG+nsGKVtXsGMJ2fLxD3UZNc6b3W1Gq2h1LyEJ8I4ZyTEVDOboK8L4SqhvGlcFoo7KFoQDGMwiEMoByWYHSCZFT+fiuZdgKGnnecUGgOuMYrhNXusj4PYMNAhaq80y0RxrBcWuMmrJwc0iDHkyezRixuCSjw9CuZ+YfrrFw6ZvxsljpfE5T5rEly0kDdGuAdPct4gGZQT9/h1RyJ4MbVWFiypPD05oX+5RljK0U9e11LkPh/Tb5YistyFoCffIPcZZSh7nQjaWsqJIHX4rIIfLjoV+Jus6BjMhW7s4GauGzUshi4b2LPntOMyI+4Na7WOG5cJVcCPwX1Qxd7dVcyuL8GtyIkOcg9wE86m8dgU3a5wkmzd9HH15nxmRVi4MZwoJBzM7FDojy+Wt1i7uMTENzs3hoTeIeEomWoz446I23jGG+DFeyWRfM40gHDbMj4kjbtE9KH0CDsZeuBJKeX7qafzYc9uUW9dY8kr9EJRSTaYzJ1DVIpspRdYjyTMuXL+gGXoASuNbmq7S+j7AWzbPvb3dPWmAx6SeTdam3D/bokzZn+8OmF5he0pp+6EPYRNYQFmzK7B0cqIFaIUWE65KtjrdJw+S5+nGdMIYuwbG50ilf98+fp1MX797Pnds99wY8Z/XIMqXZWcoYlVV2UeA0ZU+N2iTVtL/sBIaEyuCZshQjGPVUy0lsBV0ofhPBzZVvoGrCipI1lqlFiV8EYqYdtrqnSDjXQCzGF0qWtxdNYrGrOPWK4k3nc4L5R1eAHUZApcdtRree7TzHqUkluXSV0KdZCwBZp57oQvsqqRkk8IfctarHdCHhQPJ3qvL+ib8aLA/LSboT999RJV4h0ZMWkcDKYoCgoKFJc3MQWpvjTDmbeVaduFKHQPZHBQEPEyqiyXxPu3EErZ3UD2do1lOEc3XToMKDobF4VR4v+s7bQlIcr/GO7+yoWVeMtg1I36orlbVaE4oPWaHpte8yaXyfmX/7F3bmr8hEWq8KLswhi9W36VVpl/bWZA+8fU//6hgiiLgbynnX3E6wPVQwvI9sbjxf8Yj0tQWLlzdn5ztScgBbjBHD3obUyQVkHMr2D0gJu4hBNEpWlUKduhglI8SddPsHR4cEmp14OZd9NHYySJ8Vqk8xepz77u4XZLMQpORs+3tTuVc3X3MPQVGN+r7VNEqKn2J1uHevFRQpaDG6cnpy/Hf45Pd4L+lt/7atpKhatjVsxq6Z/tdLdYlMlCWyCTCqTUr0u9tjQW2hdhkQOWbc/c8LJ9e/WB0tq7TS7YszTFnlY1k3GuZ2mkIu1/TaSepGhKpddXf128u73wbtbauhlXkfJ19FmIPltHv+3yQ2NjRNYjJ8j2Bhy+8lJsjcI/yLxLy5YI8Vt8Xee2qIAbxLoKvSCB5XLCLXw0crWi5TAQEEWw/1JT6seWveifOowO+nEPD5vj8JzLBkJ2PwXMk0fSA2jaifgXkRw7jj4CoJuED6Noz2/Oqb8cwq0h9ADC9ZR7DLxoNj3+eDSN9kJ39IFva/9qwtES+Yz9n14KyNwgfZ7nULtIaqchkJZ1Pb28oAJBuR8/L0NxG3U/oiGAq4dIN2aRP/FB34PCTOpccPSNhrCc/wuB72Pf
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"providers_google_workspace_users_list"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/providers/google_workspace_users/"}
>
  
</MethodEndpoint>



GoogleWorkspaceProviderUser Viewset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Query Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"name":"ordering","required":false,"in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"page","required":false,"in":"query","description":"A page number within the paginated result set.","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"page_size","required":false,"in":"query","description":"Number of results to return per page.","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"provider__id","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"name":"search","required":false,"in":"query","description":"A search term.","schema":{"type":"string"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"user__id","schema":{"type":"integer"}}}
      >
        
      </ParamsItem><ParamsItem
        className={"paramsItem"}
        param={{"in":"query","name":"user__username","schema":{"type":"string"}}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                pagination
                              </strong><span
                                className={"openapi-schema__name"}
                              >
                                 object
                              </span><span
                                className={"openapi-schema__divider"}
                              >
                                
                              </span><span
                                className={"openapi-schema__required"}
                              >
                                required
                              </span>
                            </span>
                          </summary><div
                            style={{"marginLeft":"1rem"}}
                          >
                            <SchemaItem
                              collapsible={false}
                              name={"next"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"previous"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"count"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"current"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"total_pages"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"start_index"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"end_index"}
                              required={true}
                              schemaName={"number"}
                              qualifierMessage={undefined}
                              schema={{"type":"number"}}
                            >
                              
                            </SchemaItem>
                          </div>
                        </details>
                      </SchemaItem><SchemaItem
                        collapsible={true}
                        className={"schemaItem"}
                      >
                        <details
                          style={{}}
                          className={"openapi-markdown__details"}
                        >
                          <summary
                            style={{}}
                          >
                            <span
                              className={"openapi-schema__container"}
                            >
                              <strong
                                className={"openapi-schema__property"}
                              >
                                results
                              </strong><span
                                className={"openapi-schema__name"}
                              >
                                 object[]
                              </span><span
                                className={"openapi-schema__divider"}
                              >
                                
                              </span><span
                                className={"openapi-schema__required"}
                              >
                                required
                              </span>
                            </span>
                          </summary><div
                            style={{"marginLeft":"1rem"}}
                          >
                            <li>
                              <div
                                style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
                              >
                                Array [
                              </div>
                            </li><SchemaItem
                              collapsible={false}
                              name={"id"}
                              required={true}
                              schemaName={"uuid"}
                              qualifierMessage={undefined}
                              schema={{"type":"string","format":"uuid","readOnly":true}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"google_id"}
                              required={true}
                              schemaName={"string"}
                              qualifierMessage={undefined}
                              schema={{"type":"string"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"user"}
                              required={true}
                              schemaName={"integer"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={true}
                              className={"schemaItem"}
                            >
                              <details
                                style={{}}
                                className={"openapi-markdown__details"}
                              >
                                <summary
                                  style={{}}
                                >
                                  <span
                                    className={"openapi-schema__container"}
                                  >
                                    <strong
                                      className={"openapi-schema__property"}
                                    >
                                      user_obj
                                    </strong><span
                                      className={"openapi-schema__name"}
                                    >
                                       object
                                    </span><span
                                      className={"openapi-schema__divider"}
                                    >
                                      
                                    </span><span
                                      className={"openapi-schema__required"}
                                    >
                                      required
                                    </span>
                                  </span>
                                </summary><div
                                  style={{"marginLeft":"1rem"}}
                                >
                                  <div
                                    style={{"marginTop":".5rem","marginBottom":".5rem"}}
                                  >
                                    
                                    
                                    Stripped down user serializer to show relevant users for groups
                                    
                                    
                                  </div><SchemaItem
                                    collapsible={false}
                                    name={"pk"}
                                    required={true}
                                    schemaName={"ID (integer)"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"integer","readOnly":true,"title":"ID"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"username"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={"**Possible values:** `<= 150 characters`, Value must match regular expression `^[\\w.@+-]+$`"}
                                    schema={{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"name"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","description":"User's display name."}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"is_active"}
                                    required={false}
                                    schemaName={"Active (boolean)"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"boolean","title":"Active","description":"Designates whether this user should be treated as active. Unselect this instead of deleting accounts."}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"last_login"}
                                    required={false}
                                    schemaName={"date-time"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","format":"date-time","nullable":true}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"email"}
                                    required={false}
                                    schemaName={"email"}
                                    qualifierMessage={"**Possible values:** `<= 254 characters`"}
                                    schema={{"type":"string","format":"email","title":"Email address","maxLength":254}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"attributes"}
                                    required={false}
                                    schemaName={"object"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"object"}}
                                  >
                                    
                                  </SchemaItem><SchemaItem
                                    collapsible={false}
                                    name={"uid"}
                                    required={true}
                                    schemaName={"string"}
                                    qualifierMessage={undefined}
                                    schema={{"type":"string","readOnly":true}}
                                  >
                                    
                                  </SchemaItem>
                                </div>
                              </details>
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"provider"}
                              required={true}
                              schemaName={"integer"}
                              qualifierMessage={undefined}
                              schema={{"type":"integer"}}
                            >
                              
                            </SchemaItem><SchemaItem
                              collapsible={false}
                              name={"attributes"}
                              required={true}
                              schemaName={""}
                              qualifierMessage={undefined}
                              schema={{"readOnly":true}}
                            >
                              
                            </SchemaItem><li>
                              <div
                                style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
                              >
                                ]
                              </div>
                            </li>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pagination\": {\n    \"next\": 0,\n    \"previous\": 0,\n    \"count\": 0,\n    \"current\": 0,\n    \"total_pages\": 0,\n    \"start_index\": 0,\n    \"end_index\": 0\n  },\n  \"results\": [\n    {\n      \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n      \"google_id\": \"string\",\n      \"user\": 0,\n      \"user_obj\": {\n        \"pk\": 0,\n        \"username\": \"string\",\n        \"name\": \"string\",\n        \"is_active\": true,\n        \"last_login\": \"2024-07-29T15:51:28.071Z\",\n        \"email\": \"user@example.com\",\n        \"attributes\": {},\n        \"uid\": \"string\"\n      },\n      \"provider\": 0\n    }\n  ]\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>