Files
authentik/website/docs/developer-docs/api/reference/providers-google-workspace-partial-update.api.mdx
2024-09-13 12:17:54 -05:00

621 lines
24 KiB
Plaintext

---
id: providers-google-workspace-partial-update
title: "providers_google_workspace_partial_update"
description: "GoogleWorkspaceProvider Viewset"
sidebar_label: "providers_google_workspace_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztWN1v2zYQ/1cIvWwDHCvNV7s8NWuDLUA/giTtHoJAoKWzzJomVZJK4hn633dHSpbiyI7TFduA7SEOJfG+73535CLSBRjuhFZnWXQcFUbfigyMTXKtcwnJnTZTW/AUkoIbJ7hMyiLjDqJBlIFNjSiIFil/9ft/b7af14zYZwF3FhzuRwZ8Bg6ZR8fXi0gQVcHdBD8p/IBPIsO1TScw49HxInLzwr9VDnIwUbUq8oSVSnwtgdU72C2X9JSBcmI8FypnbiIsC6qxpW6sUW6I4gx8LYUBNN6ZEqqbQeR4Thq2vohuwjaw7hedzUm1VKNI5WjJi0KK1Lsw/mJJscVjG/ToC6Rua6ddgkFXiz/Q6gHpgTFyAiwxDK5aMrbOoJ24aybUO1A5uvP4RbUkmicz1A932A4NN4bPkUQ4mNk+XmNtZhyNi8oSQ1L1sUtyo8viLzBddcV5LYE1ElhpIWNIxbwolhoITvYJiDuGgYmEHPMxS2wZfLxJNAZFyBVn4RO/b572Dg+QKYryOcQlWVJRTqJyvVatuB3uU1lmkKDuWEP4cyuwdHia6lJ1VRtpLYErsmAsJNbEI3+u8RvWSiklH0moE3YQkayE/OBIUnDnIgJVziiLM50ojWXgeYVdVGSlLUBllNmr8pxwxDz6WLpc46vLuUrferqTwBxFemX/ZpkZjHkpXXBU4iOZZBr/qSfjUrUSzrnD2szWFN5FqHJMeaKxkJZGuLmHK166CeXEFJ9uKo8IttDKhrTY2939Z2GhmPYgJinJs49KzkOytG44e0su7ceS/xB6pHqGMQTVixorMQHHQrjYkopZjR2GO3YHbKr0HZvgn9MMMuHwA7BlfB/GASVza0WuELZGPJ2mE64UyKSTM4mVZf60VmcYaaO4ZB1SRmEdBAcIxT5dvLPDb1JhXatZ6cItxQ+WZcIWks/ZB6TtlXoLZqQtbMn8AlxpVO1HZP+A+gnuSSFLw+XzhQS6J2XhLMOTmUZ8e54xoomZp2Xr2H9jZ/vmXvZ/9/q3dC+CzHYsvd6yULfFlC7qPUyPjVr2JeTjGqh7yoD60Uqt9xfnTeu+NV0v8r34YSWRRw++a8v9jH01C/B5aozumbvRf2MBMkuAvj+jI1a+0WR9nZZQOMNmgWK5PO/K64wsrWpBs7X+2P+eIwgoHDZSdnJ+tsYhGYZe9KDrRmu7aV0z6GZAELrBzAC7E52Fs2M68edKQrsoXp7X4tWza7wQWRVTESOkNefP0kii4oWIb/fjiEa6ZuC7JCcFKztj39KeiXNFc1D1cAjc+DwdROTmi/aoeHrPZ4WE9tzWgkbPiHUd7Y/5q8Px0cHO4csXL3cODo/2dkb743RnL/35aH98dMTH/Igctnag2p5FT3vxWPwags5DRIloQ/toLXmia4TB82Gf2E7L/ubwEJ97sXwVwtdDbydphRprH+Q6GdvIe+SygfPe7t7B8NXwxaOCec+ndOHQUNWjmBXelx50leOhiYdejXkEUurXuV5KGgpNmmDRAh4sOlnz/uyKvOEzlrLPHsdxLtykHFGY4g6LuF2NpB7FZGb87uzN6YfL0zCLa+tmXHWYL+uGhbphy7ph9Z0P67/z6YDNFtc/dfE4uHcxjojCt0Vv0qIu4e6VC0Z2pYjx1bEfISh7J2gFESwWI27hk5FVRa+x8Awd13B5y/Gs5AcNrHWcSmmNqDHGRIYNdvx4USPUT+y7XC/1Wt30DUVdw3MlcBtEU5iHW7DqBndNcCJEWCH9w4c3QcudKyJvCR/BfDVoKE7SFAq3ce9NB1HPT67e/Ia7R/Ut18zjeGT4HQ2o+Ou11N5tHh39u0UkucpLntPewNQ3tpJi2s6MASQHzYLM6vUDhtTvuNJTUBjWxi2OnskzVfUnCjlNhQ==
sidebar_class_name: "patch 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 Markdown from "@theme/Markdown";
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_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
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><MimeTabs
className={"openapi-tabs__mime"}
>
<TabItem
label={"application/json"}
value={"application/json-schema"}
>
<details
style={{}}
className={"openapi-markdown__details mime"}
data-collapsed={false}
open={true}
>
<summary
style={{}}
className={"openapi-markdown__details-summary-mime"}
>
<h3
className={"openapi-markdown__details-summary-header-body"}
>
Body
</h3>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</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={"delegated_subject"}
required={false}
schemaName={"email"}
qualifierMessage={"**Possible values:** `non-empty` and `<= 254 characters`"}
schema={{"type":"string","format":"email","minLength":1,"maxLength":254}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"credentials"}
required={false}
schemaName={""}
qualifierMessage={undefined}
schema={{}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"scopes"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</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={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem>
</ul>
</details>
</TabItem>
</MimeTabs><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>