Files
authentik/website/docs/developer-docs/api/reference/providers-google-workspace-create.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

600 lines
24 KiB
Plaintext

---
id: providers-google-workspace-create
title: "providers_google_workspace_create"
description: "GoogleWorkspaceProvider Viewset"
sidebar_label: "providers_google_workspace_create"
hide_title: true
hide_table_of_contents: true
api: eJztWFtv2zYU/isEX/biRKlzaZenZm0wBGibIEm7hyIQaOlYZk2RGkklcQ3/951D2pbsyo6bFtuA7SEOLZ/75TuHmnJTgRVeGn2R81NeWXMvc7AuLYwpFKQPxo5dJTJIMwvCA+/xHFxmZUU8yPF7oPtjQXY1F8A+SXhw4JHei8Lx08+NbH7X4xb+rMH530w+4adTnhntQXs6iqpSMgsmJV8c6Zhyl42gFHTykwpQqxl8gczvbMwNWCmU/AoWWdAO9NlLcCRQixJagp23UhdIVUr9DnThR/z0xWzJNElLtA8pXItHWCsmyCI9lK5L1tDYUqBzvK5lzmdd4tLCmrr6AaHrobiaa2ALDax2kDPkYkEVC/mkINdVjgdd7EchCgrMc566OsZ4m2pMilRrwcJv4nHxrX98hEJRVY7ZxRSQJ/jAZWhcp1drYYfHTNU5pGg71iR+3EssRZFlptZt0wbGKBCaPBhK5cF+E88NcetxXSslBgppvK0BBZCulOLgSVMM55SDrkuq4tyk2vhRlBWp8OBqV4HOqbLX9XnpSTi/rH1h8NHNRGdvA99ZFI4qg7F/s84chqJWPgYqDZlMc4P/9JN5mcX+lZhWMq+d3q1yu8qrFzvwrjF6QxNfR8TA9llRP0+ag6y20iOYfEYIqf2IDBrjt7tZQBtXGe1iyfUPXvyzkFONW2IlWlEEIuzH/FKrSfSpicfFW0pXN079h5ApMyXmEHQnIq3lBDyL6WJLLuYM8yPh2QOwsTYPbIR/3jDIpccfgC3zu5oH1Cyck4XGmh2IbJyNhNag0lbNpE7VxdNWXWCmrRaKtVgZpbUXAyA1+3j9zu0/y4RNY2zVhLOG4xfHcukqJSbsA/J2ar0HOzAOdhR+Db62eh5HFL/C/YT0tFK1Fer7lUS+J3WV4EVaGoSf73NGLnIWeNkm8c+cms+ek/9Pxn/LZFyfhbs16q6Y0ka93o/O2fUemM+UHs2jtV7vbs6nZ3QczqudRBE9Ojj4iSP3E87VPMLnubWmY6fH+A0lqDwF+v07JuIsDJq8a9ISCuc4LFCtUFdtfbMmLo1p0bKN8Tj8mSsIaFw2MnZ2dbEhIDmmXnag61Zv22U9F9CugKh0i5sRdkcm3CuNI7srQWDHk+VVMFm/ZibUvghmdE2kVa62ihhEJZP7w4TTMrdY9W4oPNG/1sK39GTkfUXCAhUBIQgbKrTHKcDXzQX0/FGUlYLmNtjARcdy9ZkfDsWr4+HJ0d7xyxcv946OT/p7g8NhttfPfj05HJ6ciKE4oVBtXKV2F9ExWAIKv4Zo8z7iA98yOBpPnpgXceVcnRC7Wdk9FlaRuRPF18F7M+i2ylXqoQlJnpdhk/mAWS5K7h/0j/Zf7fe/aZX3YoyC2IJrvoQ5GWIZ4FZ7Ecd3nNJYR6CUeV2YpaZ9acgSbFfAK0Wrat5f3FI0QsVS9bnTJCmkH9UDSlPSEpE0p4Eyg4TcTN5dvDn/cHMet3Dsl1LolvBly7DYMmzZMqz7zUwLXnZ5SRObxsOjT3AplGEQBlem865tv8DBjK71LT6ieh1RnyPpdDoQDj5aNZvRY2w1S1czPN4LvBeFpQKvZsiAqxR2JbX6GJCEv4lG792SQUSu6pDndXyc9RYcZ1kGld9Ke9eCoqvLG0rTYP7mqQz4x614oMUOPxG6etyEIAZsCc+mXAld1KIg2igzDISaItPsWhFieosDebWYO3rSshDDEyhuzRg0hqg3d8XTdzQXhf8FBYLrpA==
sidebar_class_name: "post 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_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/providers/google_workspace/"}
>
</MethodEndpoint>
GoogleWorkspaceProvider Viewset
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<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={"201"}
value={"201"}
>
<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>