Files
authentik/website/docs/developer-docs/api/reference/sources-scim-users-used-by-list.api.mdx
Tana M Berry 7a6d44d0df first pass
2024-10-22 15:10:13 -05:00

383 lines
13 KiB
Plaintext

---
id: sources-scim-users-used-by-list
title: "sources_scim_users_used_by_list"
description: "Get a list of all objects that use this object"
sidebar_label: "sources_scim_users_used_by_list"
hide_title: true
hide_table_of_contents: true
api: eJytVU1r3DAQ/StCpxaWdUhyKHtqWpYQaErp16UEI0uza2VlyZHk0MX4v3dGtrNu1lva0Iutz9F7M09PLXc1eBG1szeKr3hwjZcQ8iB1lTcBfKCvyot9bnSIfMEVBOl1TTtw/TVEJhhNMbdhwhjminuQMbBYishwLzZ0GEZxey28qCBiYL760XJNQWoRS5yyOIE9rbAdZAmV4KuWx31NoyF6bbe8ew7gijVWPzTAHoXBr1Zgo97scW1/MBFhPStC45cY3MNDoz0g3+gb6O4WPIot4RnpcxwKIBuv4z7BFE0sKfAOe3e0wUOonQ24FCGen53RTzobcRE1RV0bLVNas/tAQNtjSsJ7sUc4OkIVJuNPuXrOdC7NHjbgwcqeMDBMhdegJgn3VOGoe6gIbDaplVNg8r4CM9P1bnb45Hohe9AtB9tUlFkpghQKENDQyithiX2AmNvGmKGpYCMaE6kCv0fFvo6GBr6hIN/tr9IRawrfddOa/hhPXyS2v3EbICdCd88jYpzuSF/E5vJl9T1Rx+/CaJW2srX3zh/VyDqbbzQYlQPNh7+QzJh5BCuR7fyMUErTscJ8mp7XHfJwgNYjO5mPi/+Yj2uwKFnJrj7dnEiIgii0mRXaabZTQQwBJhUfDv0DTboUEEtHrriF3rrQplY8G0wiO3hk1mrVZYNRZknJ/nG0uMYb2iVqnT1eZLybeMsXStFwMQ8O88SmjLEevZD6BQgPPkHTduPSyoHPYfuC08k9i/Oz88vlm+X5Uc5vxY4MY9zVV44FXdUGyCGptHiL0gWuUu55Cca4t1v3dNJSO6oA1h3QCJNwewO/vfmKIXraRCGssmyrY9kUS+mqbBIiO7QK44oMj7LZh5v3649f1olm7UJEn5gEH5Lf+3pKPn0VK/Zs7oGaqPTf36qhDBF+xqw2iI34Jl7tIIbDi0FlGuWAnVV6xQZFYIu0VyIZ2tK2hQjwzZuuo2FybHplsPkovBYFFRR1o3SgNupvI0yAPxB79XnQ+mv2kudwluZoOMmjUzC6FQu+g33/Rnd3uKoEdHKf4PYTV1JCHSdbjpyB9P90sa7XJBVSwUT2g8wXY4Oiz8LBRKYVX90OLCZzRBepTwC77hdMHw/K
sidebar_class_name: "get 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={"sources_scim_users_used_by_list"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/sources/scim_users/{id}/used_by/"}
>
</MethodEndpoint>
Get a list of all objects that use this 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":"string"},"description":"A unique value identifying this scim source user.","required":true}}
>
</ParamsItem>
</ul>
</div>
</details><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"}}
>
<li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
>
Array [
</div>
</li><SchemaItem
collapsible={false}
name={"app"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"model_name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"pk"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"name"}
required={true}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>
</SchemaItem><SchemaItem
collapsible={false}
name={"action"}
required={true}
schemaName={"UsedByActionEnum (string)"}
qualifierMessage={"**Possible values:** [`cascade`, `cascade_many`, `set_null`, `set_default`]"}
schema={{"enum":["cascade","cascade_many","set_null","set_default"],"type":"string","title":"UsedByActionEnum"}}
>
</SchemaItem><li>
<div
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
>
]
</div>
</li>
</ul>
</details>
</TabItem><TabItem
label={"Example (from schema)"}
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"[\n {\n \"app\": \"string\",\n \"model_name\": \"string\",\n \"pk\": \"string\",\n \"name\": \"string\",\n \"action\": \"cascade\"\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>