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,602 @@
---
id: providers-microsoft-entra-partial-update
title: "providers_microsoft_entra_partial_update"
description: "MicrosoftEntraProvider Viewset"
sidebar_label: "providers_microsoft_entra_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztWFtT4zYU/isavbSdCTELLLvlqZRltszshQF2XxjGo9gnsTay5JVkIM34v/cc2YmdYEhoafvQPiTjy7lfvnPkOTcFWOGl0WcpP+KFNbcyBeviXCbWODP2MWhvRVwI66VQcVmkwgMf8BRcYmVBrMj4cUF+StTnjRj2VcKdA4/kyC9y8CiaH13PuSSmQvgMX2l8gXcyxWuXZJALfjTnflaEp9rDBCyv1jUes1LL7yWwhoLdCkV3KdorxzOpJ8xn0rGlZSyYxha2DVGbhe+ltICee1tCdTPgXkzIwDYQ/KYmA+d/NemMLEsMatSeLkVRKJmE+EXfHNk1f+iCGX2DxG8bskuwGGf5O/o8IDMwP16CI3l1oJZynbfoJVLlUn8APcFgHr2qlkyzOEfzkMJ1eIS1YoYs0kPu+mSNjc0F+sbLEhNS9YmLJ9aUxV8Quh6J80YDW2hgpYOUIRcLqlhioY5xqD6kGJKQRElMQ4wSN8ekoXWAovwW9Jhgsa1suE9UmUKMRmPj4N+tTCAWSWJK3dU1MkaB0GT6WCpshQeBfCRg2CKlUmKkoCnUASddcQoKOwo11XGcc9BlTtWbmlgbrP4gq6ai3ipdATqlil7X56Un4fxz6ScGH13OdPIu8B3XwlFlMPYf1Vm1ROfCY1ul/T1zUfcnMhAL5ri00s8CzojSZwQIU7y7qUIvu8JoVzfU3u7uv9rQxbQH6chGkX7WalZnuw3C2TvKQz8K/Jf63uSYQtC9fbyq4T14VmeLLbmYMzgZhGd3wKba3LEMf94wSKXHF8CW6V3NA2oWzsmJhjQeiWSaZEJrUHGnZGKnyslmq84w01YLxTqsjNI6qAMgNfty8cEN/5QJjw2JtenZcvzgWCpdocSMfULeXq23YEfGwZbCL8CXVjdxRPEr3Bukx4UqrVDPV1LzbdSFO4iIc4MA9Txn5CJngZc9Jv6JmbR5Cj09d/6fNH/rpGl3westm2xbPOhWxXoNdNHsYXE2YD+gQdGtjbWG7O+gm9bx/snEw7hcrXYK/8GLTsWvOPvSGuJOrTU9Wy3GaSxBpTHQ+2dMrSoMg7RvGhJSpgjoqFao866+zlLRmlZb9mg89l8wHu9B40KQsOPzs0cCkmIVyB4EfNLbbvk2AjoF0Ch9ws0aGjOT1ueyJAtnNlpxebQ8DEVrp8JoLtMqouZDKFoc7UqriEkUMrrdjzgtXYuV7JJiVDvZWcyW7mTeF4szYIAxEDaU6YBTlC/aY9jpvcgLBe2hqG32ni3omu+PxdvX48ODnddvXr3ZOXh9uLcz2h8nO3vJz4f748NDMRaHFK9Hd57tRXQmQGvUGvB3oKnF+/bhBpivl8JVYN/OvH40XwXUXvDtkmA2pB6bkLemvNpkBihyNc/e7t7B8O1w7+GiLKZ0PF9wNQuQk5TSYYBE7VFzwPw8tALPQCnzy8QsNQ2lIUuwDQG3+U4hfDy7Ij9DEVJBuaMomkiflaMhQm3UERG1VyNlRhGq0tGHs5PTT5en9QZsnM+F7ghfdgJbdgILncCa7yOs//tIBz02fyppusHDvY9wLZNhJgaH5k1Ldr9P0HF0pSnxyVGYEVSNGbpA9PP5SDj4YlVV0WNsJEsHJLy8FXg8CQMfexcXQbrGahwL5eAJL368aADnJ/YSX2J6fV5MAU0zIAglqBrwKczq70XVDVJluIMhSpD59YuT2sidK2JvGR+AdjVYcBwnCRT+SdqbDj6eH1+d/IbUo+aDUB5QmVtxRysh/gcrTYhaALvwbM6V0JNSTIi2FhrGVEkZbVe3GvMGiwtyqzcOmNFAcWWmoDGri7B4uqfIVNUfXAf+aQ==
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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"providers_microsoft_entra_partial_update"}
>
</Heading>
<MethodEndpoint
method={"patch"}
path={"/providers/microsoft_entra/{id}/"}
>
</MethodEndpoint>
MicrosoftEntraProvider 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 Microsoft Entra 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={"client_id"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_secret"}
required={false}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"tenant_id"}
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>
</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={"client_id"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_secret"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"tenant_id"}
required={true}
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>
</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 \"client_id\": \"string\",\n \"client_secret\": \"string\",\n \"tenant_id\": \"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}"}
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>