first pass

This commit is contained in:
Tana M Berry
2024-10-22 15:10:13 -05:00
parent 63c3da169a
commit 7a6d44d0df
878 changed files with 474272 additions and 31 deletions

View File

@@ -0,0 +1,624 @@
---
id: providers-google-workspace-update
title: "providers_google_workspace_update"
description: "GoogleWorkspaceProvider Viewset"
sidebar_label: "providers_google_workspace_update"
hide_title: true
hide_table_of_contents: true
api: eJztWFlv20YQ/isLvrQFZDGRj6R+ipsYhYEchp2kD4FBrMgRtdFql9nDtirwv3dmlxJpmZKdA22B9sEyj53rm5lvdrlMdAWGO6HVWZEcJ5XR16IAY7NS61JCdqPNzFY8h8xXBXeQDJICbG5ERTIo8XtY98dq2XmjgH0UcGPB4fqKGz4Hh0qT40/LRJBUxd0UXyl8gXeiwGubT2HOk+Nl4hZVeKoclGCSetPkCfNKfPHAmhXsmku6K0A5MVkIVTI3FZZF19jaN7ZybojmDHzxwgAG7YyH+mqQOF6Shy0GyVVcBtb9posFuZZrNKkcXfKqkiIP0KWfLTm2vB+DHn+G3D0atEswgkvxJ0Y9ID8wN06AJYURqrVi6wzGiavmQr0GVSKcx0/rtdAim6N/uMJ2ZLgxfIEiwsHc9umaaDPnGFziPaak7lOXlUb76juUbkJx3lhgKwvMWygYSrFgiuUGIsihAHHFMCqRUGI9Fpn1EeNdpjEpQm6AhXf8dnU3OjxApWgq1BCXFElNNYnO9Ua1ATvc5tIX2CSWegd/rgW2DM9z7VXXtbHWEriiCCZCYk/cw3MLbtgrXko+ltAU7CAhWxnh4MhShHOZgPJzquJCZ0pjGwRdcRU1mbcVqIIqe9OeE46UJ++8KzU+ulyo/FWQO4nK0WRw9m+2WcCEe+kiUFnIZFZo/KcezEvdbfNPd9K7U29feTVkddU6vaWJLyJjYPvU91gGwYDcG+EWgQq5d1NyaIZ3V3VgG1tpZWPJjZ48+Wcpp5r1sDE5yYt3Si5iTC0eZ68oXf089R9iplzPMYegehlpIyfgWEwXW0sxq3F6ccdugM2UvmFT/HOaQSEcvgC2zu/dPKBlbq0oFdbsmOezfMqVApl1aiaz0pcPe3WGmTaKS9YRZZTWQQRAKPbh4rUdfpML28bYxoRvJX6yrBC2knzB3qJsr9VrMGNt4ZHKL8B5oxocUf0d6Qe0Z5X0hsuvNxLlHrSF+ySezTXSz9cFI1Y5C7Jsm/pvnJrfPCf/n4z/lsm4OQsf16iP5ZQu6w2+d85u9kAzUwY0jzZ6vb85H57RcTjf7SRC9OCHjtyPOFeLSJ+nxuiePT3iNxEgiwzo/VdMxDoMmqJv0hILFzgs0CyX5117dYtL61r0bCse+z9yCwIKNxs5Ozk/2wJIgakXPey6M9puWTcKuhUQje4IM9LuVIfzr48nVuK6JF2fBNPN03C6FEWdUgsjoa1Ott5IkuKVSK/304Q2dKvt3iVBFGPsbPrW0Uydq1ZH4ECGwE2o0kFCIF+0h9DTWz6vJLQnwpYyejZYn5L9CX9+ODk62Dt89vTZ3sHh0WhvvD/J90b5r0f7k6MjPuFHBNfW7dTjVfQMl8DELyD6PESOSHYMjzaSB2ZG3HbenRKP87J/NNxl514m3yTw7cTbKVmhJjokuSnFNvOBt2zUPHoyOhg+H47utcsbPqNPGSupZiNmRcAyUK5yPI7wOKmxjkBK/aLUa0tDockTbFnAY0Wnat6cvSc0QsVS9dnjNC2Fm/oxpSntqEjbq7HU45TCTF+fvTx9e3kad+LaujlXHeXrvmGxb9i6b1j/V6QOxTzig1LTNA5uXYobQxGGYQhl2bRu9yMOZnSjefHRcdg4UNVO0XsSWC7H3MIHI+uaHmPDGTqk4eU1xxNS2F5gj+NelK6RKyZYwLAjjp8vGl76hf2QD1a9Ua+mhaJZEbQSpQ2SGSzid7X6CldNcR+IdEL+xxcvo5d770m8FbxH7vVgJXGS51C5nWuvOjx6/oHKa9x8NZsH7k4Mv6FNKf4GH3UALXBieLZMJFel5yWtjSrDMPOU0XafGKlxsLqgoHpRwISGFe/1DBQmdQWKo3vCpa7/AsFyZzQ=
sidebar_class_name: "put 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_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
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><strong
className={"openapi-schema__required"}
>
required
</strong>
</summary><div
style={{"textAlign":"left","marginLeft":"1rem"}}
>
</div><ul
style={{"marginLeft":"1rem"}}
>
<SchemaItem
collapsible={false}
name={"name"}
required={true}
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={true}
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={true}
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={true}
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>