---
id: providers-google-workspace-retrieve
title: "providers_google_workspace_retrieve"
description: "GoogleWorkspaceProvider Viewset"
sidebar_label: "providers_google_workspace_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJy9V9tu2zgQ/RVCL7sLGFaQZoGFnzbYBoWBtA2StvtQBAItjmXWNKny4sRr6N87Q8q2Ysu5tME+JNaFczszc2a0zkwNlntp9Fhko6y2ZikFWFdUxlQKijtj567mJRQWvJWwhGyQCXCllTVJocy7ePLfzcGrVgX7IuHOgcfzNbd8AR7VZqOv60ySVM39DF9pfIF3UuC1K2ew4NlonflVHZ9qDxXYrNk3ec6Clt8DsPYEW3JFdwK0l9OV1BXzM+lYco1tfWMb54ZozsL3IC1g2N4GaG4HmecVebhDIcOHDspgpV9F13nwM7Ixx7tbErHgaqMdOHL79OSEfkqDXmlPl7yulSwjvvk3R76vD8M0k29Q+mfjegNWciX/Q2AG5Com0MvkQD3vQY+c5OKjVqsUKcYpvaIT47cEbUrBVsxhmnVFL1rdq2KBYeAz1znFreUrVC09LNyh9CCbGrvgiEEWAia36VNXVNaE+heU7iN21VpgGwssOBAMpVg0xUpEIuYi1AIvdDUkJaVZYA7bjO2b3MsJeJbSxbZSzBmsNu7ZHbC5Nndshn/eMBDS4wtg2/w+zANa5s7JSoMoJryclzOuNaiiUzOFU6F62qsxZtpqrlhHlFFaBwkAqdnn60s3/CkX+svjoCN3Er85JqSrFV+xDyjba3UJdmIcPFP5NfhgdYsjqn8g/YT2olbBcvVyI0nuSVvIa7xYGIGovSgYuclZlGXH1OM7qLjH/LiQyuixtkBekQofLPj9JegKGXZ0+ucZlTjyHPEWV9RXDXEttkpPj+EruC9VEFBg6eAcwH9LifTPy9KEBy0yMUYB1yQylQqjOejnI32LlBOU4hPioDZMslVQrJ4sJaTWGeiwID4WptAGCb1Fk07RuAiuBi2Io/ftbQjuY/CVwUc3K12+jXLnSTmajM7+zzYFTHlQPgFVxGwVwuCP7slE0x1RX5/ZqM/llC7rPSyPR73sK8jDHmhnyoDm0V6v9zfn7Q6+I1MP4Tige0L07FVH7hecqyLR54W15nDAasRvKkGJAuj9CyZiEweN6Ju0xMIChwWa5eqqa6/Z4bJzLXl2FI83r7mCgMZlo2TnV+MjgAhMvexh10ej7ZZ1q6BbAcnoI2Em2p0Z2lirdsMkrsvy7eaW7++v+VqKJqcWRkLbbKLBKpLitcyXb/Ks6ax7NwRRirGz9G2jmXlfb1bWSIbAbaxSLAA9NfFkG89OPBa/S1GcnpyeDf8anh5g/p7PaX/dSLXT3MlFreIspdTyNAcS3aMzoJT5uzJbS0NpKAOYd8DdNBZu2rPfjz+hihQ2heBGeV5JPwuTIfJB3lGR764mykxyav/8cvzPxYebi7TOGecXXHeUb8FnCXy2BZ8d+3joVOozviNa7D3c+xz3Cxk5NQazbiugu7sjxe/VAD4axflD5TZD/0lgvZ5wB5+tahp6jF8VlnZ9vFxyXLTjlMJSwZWGrrHkpsiS8Egcv1+35f0He5XvlN6oN6SjiXKiVuqMQTaHVfqcam7x1AzXCaxK8j+9OC9LqH1H5IAdqAe2zfXugsqFKqE791OpDzYXpL3XHUQ2nvhk5qAR3Y13nu7Jwab5Ae7YIMs=
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_retrieve"}
>
</Heading>

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



GoogleWorkspaceProvider 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"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"id","schema":{"type":"integer"},"description":"A unique integer value identifying this Google Workspace Provider.","required":true}}
      >
        
      </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={false}
                        name={"pk"}
                        required={true}
                        schemaName={"ID (integer)"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","readOnly":true,"title":"ID"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"property_mappings"}
                        required={false}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"property_mappings_group"}
                        required={false}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid"},"description":"Property mappings used for group creation/updating."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"component"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Get object component so that we know how to edit the object","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"assigned_backchannel_application_slug"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Internal application name, used in URLs.","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"assigned_backchannel_application_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Application's display Name.","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"verbose_name_plural"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return object's plural verbose_name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"meta_model_name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Return internal model name","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"delegated_subject"}
                        required={true}
                        schemaName={"email"}
                        qualifierMessage={"**Possible values:** `<= 254 characters`"}
                        schema={{"type":"string","format":"email","maxLength":254}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"credentials"}
                        required={true}
                        schemaName={""}
                        qualifierMessage={undefined}
                        schema={{}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"scopes"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"exclude_users_service_account"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"filter_group"}
                        required={false}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","nullable":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"user_delete_action"}
                        required={false}
                        schemaName={"OutgoingSyncDeleteAction (string)"}
                        qualifierMessage={"**Possible values:** [`do_nothing`, `delete`, `suspend`]"}
                        schema={{"enum":["do_nothing","delete","suspend"],"type":"string","title":"OutgoingSyncDeleteAction"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"group_delete_action"}
                        required={false}
                        schemaName={"OutgoingSyncDeleteAction (string)"}
                        qualifierMessage={"**Possible values:** [`do_nothing`, `delete`, `suspend`]"}
                        schema={{"enum":["do_nothing","delete","suspend"],"type":"string","title":"OutgoingSyncDeleteAction"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"default_group_email_domain"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pk\": 0,\n  \"name\": \"string\",\n  \"property_mappings\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"property_mappings_group\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"component\": \"string\",\n  \"assigned_backchannel_application_slug\": \"string\",\n  \"assigned_backchannel_application_name\": \"string\",\n  \"verbose_name\": \"string\",\n  \"verbose_name_plural\": \"string\",\n  \"meta_model_name\": \"string\",\n  \"delegated_subject\": \"user@example.com\",\n  \"credentials\": {},\n  \"scopes\": \"string\",\n  \"exclude_users_service_account\": true,\n  \"filter_group\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"user_delete_action\": \"do_nothing\",\n  \"group_delete_action\": \"do_nothing\",\n  \"default_group_email_domain\": \"string\"\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>