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

607 lines
23 KiB
Plaintext

---
id: providers-microsoft-entra-update
title: "providers_microsoft_entra_update"
description: "MicrosoftEntraProvider Viewset"
sidebar_label: "providers_microsoft_entra_update"
hide_title: true
hide_table_of_contents: true
api: eJztWFlv20YQ/isLvrQFZDGxHSf1U93ECAzkMOwkL4FBrMiRtNFyl9nDtiLwv3dmlxIpmZaUNkgf2gcJPOY+vpnlItEVGO6EVhdFcppURt+KAozNSpEbbfXYZaCc4ZmvCu4gGSQF2NyIiliQ4e2S7JyoLht29knAnQWH5BU3vASHIpPTz4tEEFPF3RRfKXyBd6LAa5tPoeTJ6SJx8yo8VQ4mYJJ6U+MZ80p89cAaCnbLJd0VaKcYz4WaMDcVlq0sY8E0trRtiNoMfPXCAHrsjIf6ZpA4PiED2wAkN5EMrPtTF3OyLNeoUTm65FUlRR7iln6xZNfioQt69AVyt2/IrsEILsU39HlAZmBenABL8mKgVnKtM+glUpVCvQE1wWCePq1XTPOsRPOQwnZ4uDF8jizCQWn7ZI21KTn6lniPCan7xGUTo331D4RuRuKy0cCWGpi3UDDkYkEVyw3EGIfqQ4ohCcmlwDRkKHF3TBpaCyjK7UGPCeb7yob7XPoCMjQaGwb/bkUOGc9z7VVX10hrCVyR6WMhsRUeBPKRgGGLeCn5SEJTqIOEdGUFSOwo1BTjuEhA+ZKqt9CZ0lj9QVakot7ytgJVUEVv6nPCkfDkvXcTjY+u5yp/FfjOonBUGYz9qTrrbod+7uR7M58NhnTTdtMq6G+0q9jUqKV+AARoN+TeCDcPYMW9mxKqzPDupg6AYCutbOzKwydP/lVUqGY9cEk28uK9kvPoUhuNi1eUzH4o+S+Bhy4xhaB6wWBdw2twLGaLrbiY1TheuGN3wGZK37Ep/pxmUAiHL4Ct0rueB9TMrRUTBUU24vksn3KlQGadksms9JPdVl1gpo3iknVYGaV1EAMgFPt49cYO/5YJj02ajRHccvxiWSFsJfmcvUPeXq23YEbawp7Cr8B5o5o4ovg17h3Ss0p6w+X3K4l8O3XhIsOzUiPKfZ8zYpmzwMseE79lsO0eZduH1//j6qeNq/2abF88GGwdfy2aPSzO1XDEQdGtjY2G7O+gnWM0zs/1aqfwH//QqfgJZ18RIe7cGN2zGmOcxgJkkQG9/46pVYdhUPRNQ0LKAgEd1XJ52dVXt2FpTYuWPRqPox8Yj9egcCHI2dnlxSMBKbAKRA8CbvW2W76NgE4BNEq3uBmhcarDEdLHYx9tyUm6Ok+lGwfKdCGKOqXWQyBang69kcTEK5HeHqUJrVzLheyaIhRd7KxlK2emzlXLY2QAMeAmFOkgoRhftSe583teVhLac1Xb6j070OfkaMxfPBufHB88e/70+cHxs5PDg9HROD84zH8/ORqfnPAxP6FoPbrx7C+ig/+tURuw3wGmFu3bhztAPq6E67C+n3n9WL4Op73Q2yXBbAg11iFvTXG1yQxAZCPP4ZPD4+GL4dOHazKf0Ql/ydWsP1ZQSocBEJVDzQHxy9AIyRSk1H9M9ErTUGiyBJsQcJfvFMLbiw/kZyhCKih7mqYT4aZ+NESgTTsi0vZqJPUoRVUqfXPx8vzd9Xncf7V1JVcd4atOYKtOYKETWP+nlQ5m7P7K0nSBg3uX4jImwiQMjiyaVux+2qCT7Foz4pPTMBmoCqdoOtEvFiNu4aORdU2PsYEMHYvw8pbjoSSMeexZXP/oGqtwzKWFLV78etXAzG/sR3zE6fV5if2KkD8IJYAaJDOYx09N9Q1STXHzQnQg8+OLl9HIgw/E3jI+gOp6sOQ4y3Oo3Fbamw4qXn6k0ho1X5LKgMSJ4Xe0BuJ/sFGHmAWIC88WieRq4vmEaKPIMJo85bNd1yLSDZYX5FRvFDCfgeKDnoHCnC6D4uie4lLXfwFrZg6/
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 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_microsoft_entra_update"}
>
</Heading>
<MethodEndpoint
method={"put"}
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><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={"client_id"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"client_secret"}
required={true}
schemaName={"string"}
qualifierMessage={"**Possible values:** `non-empty`"}
schema={{"type":"string","minLength":1}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"tenant_id"}
required={true}
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>