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

516 lines
19 KiB
Plaintext

---
id: providers-microsoft-entra-sync-object-create
title: "providers_microsoft_entra_sync_object_create"
description: "Sync/Re-sync a single user/group object"
sidebar_label: "providers_microsoft_entra_sync_object_create"
hide_title: true
hide_table_of_contents: true
api: eJytVk1v2zgQ/SsET1vAsdK0h4VPmy2MIkCyCZJ0L4Vh0NJYZkORKkk58Rr67ztD6sufaIFcbFLkDGfee5zhlpsSrPDS6JuMT3hpzVpmYN28kKk1ziz9HLS3Yu42Op2bxQ9I/Ty1IDzwEc/ApVaWZI7GT7gleYQL2soEc1LnCljlwCa5NVXJojnalcKKAjyewyfft1ySdSn8Cpc0LuBMZjh26QoKwSdb7jdl+Ko95GB5vX/0Nau0/FkBa3awtVA0yzB4udxgJMyvpGN3bVZsSlmxhybfMZ5m4WclLSAM3lZQz0bci5wC7FHhs7gNnP/bZBuKLDV4ovY0FGWpZBrATH44imt7mEKHwSF2DT4MAZNCyf8w0RGdjQx5CS64G7BQmAwUfQRdFRSmqPyK8n0Zp8bCOKy78TcX/Bxf/Eq8UFZNdM5bxAq3e+kVNHHdh/PuyGJKRyH6wziQqj69zkEh9S3oHDmdfKzrIbrf961HR9KaHQvhMULP612HgS50Amllpd8ESXXp4mxWB9pcabSLMF5dXr4jd4/gKuWZWfaib5nE0A84LMA5kcdx41hYKza4UXoo3C+IJR6iTM4aZ+xV+hUTSrGQ05unxRyy8cHpXqKJF0V5jLSlsYVAPHiG9/uCthLZ6GquYL0rNgzHI2AKreAthRgajq01JLdXYXXzF11LvTQhkUVFU228A39Oebcmv6VDW8mFhOxh1LiE2yKLByvC43BReTiKqsgySXEL9TDEqN7X68BLe9gQlS620QDd2U4m02AU3IrsXqtNo9q9gzppnJA/6Syqf1cQ5Pnzu2r6XyxAWTBl04bSXR1po+dLCSqbB8p/Rc0tLRhsipf8+MopTnpA+tBiZCfx+PSOeHwFjVU5ZdcPNycAycALqY6q8HS2Q/IbBwPqm0PPpImfsI+uTOjdxsXeSjWXJ13TSvZaebKVWZ1QaUpisglVYLDrth1XVpEDUcpk/SnhVD3b2vpEcMV8BxW2y2zlfdn2bZovQFhq1xgmAf7Yt87pG14SBSd62vlWtt98BkiHKhOqXESwD3LEKb+I29Xl1efxn+OPByzfiRd6KrRWUStY0ylUKqUkJpEGMaFqiG2+AqXMX7npI5YmlCuZArabcFXik+bu5hldRHAJKDdJkhzLdrXAJItk4CLpRwtlFgkepZPbmy/Tf56mAUyiuhB64Lxjm3Vss8B26EFtPzr+cBtckt94wzWUU7NJSoURUtYhu22jweHDiR4EOyrEL5Ou9+Nf55cuwIqkjPbb7UI4+GZVXdNnVI+l9o7DtcA30oI4RsFm0tEYpbAUysGZ9P54bC7cB/YeT8ajGLRVUFMNDE7pqo74C2ziw7ae4a4VNgJqZxh+XPgSg7x4JvPe8KBo1aPW4jqlvnt272xQHx7un0iAi+bhWoSixK14pbcv/oYgTQAtXPDwbcuV0HmFTQnXo89QpSsiuLv3zT0ftQPK6igMSGjY8WxeQCOpLSqe5gRMXf8PxKJlfw==
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 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_sync_object_create"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/providers/microsoft_entra/{id}/sync/object/"}
>
</MethodEndpoint>
Sync/Re-sync a single user/group object
<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={"sync_object_model"}
required={true}
schemaName={"SyncObjectModelEnum (string)"}
qualifierMessage={"**Possible values:** [`authentik.core.models.User`, `authentik.core.models.Group`]"}
schema={{"enum":["authentik.core.models.User","authentik.core.models.Group"],"type":"string","title":"SyncObjectModelEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"sync_object_id"}
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={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
messages
</strong><span
className={"openapi-schema__name"}
>
object[]
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"timestamp"}
required={true}
schemaName={"date-time"}
qualifierMessage={undefined}
schema={{"type":"string","format":"date-time"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"log_level"}
required={true}
schemaName={"LogLevelEnum (string)"}
qualifierMessage={"**Possible values:** [`critical`, `exception`, `error`, `warn`, `warning`, `info`, `debug`, `notset`]"}
schema={{"enum":["critical","exception","error","warn","warning","info","debug","notset"],"type":"string","title":"LogLevelEnum"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"logger"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"event"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
>
<details
style={{}}
className={"openapi-markdown__details"}
>
<summary
style={{}}
>
<span
className={"openapi-schema__container"}
>
<strong
className={"openapi-schema__property"}
>
attributes
</strong><span
className={"openapi-schema__name"}
>
object
</span><span
className={"openapi-schema__divider"}
>
</span><span
className={"openapi-schema__required"}
>
required
</span>
</span>
</summary><div
style={{"marginLeft":"1rem"}}
>
<SchemaItem
name={"property name*"}
required={false}
schemaName={"any"}
qualifierMessage={undefined}
schema={{"type":"object","additionalProperties":{}}}
collapsible={false}
discriminator={false}
>
</SchemaItem>
</div>
</details>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</div>
</details>
</SchemaItem>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"messages\": [\n {\n \"timestamp\": \"2024-09-13T14:05:42.400Z\",\n \"log_level\": \"critical\",\n \"logger\": \"string\",\n \"event\": \"string\",\n \"attributes\": {}\n }\n ]\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>