mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
8.2 KiB
Plaintext
45 lines
8.2 KiB
Plaintext
---
|
|
id: create-synced-attribute
|
|
sidebar_label: Create a synced attribute
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJy1Vk1v4zYQ/SsEL734M3HarYEevG0KuMAmQez2khrBWBrb3JVIlaSSCIL++86Q8VqxkjRbpDZgS+Qb8s3MmyFraQq04JXR81ROZWIRPC4qnWA6896qdelR9mSKLrGqYByhfg0o4QJMQAvnYevk9EYeTzm56kmL/5To/EeTVnJah1dlkbb1tsSeTIz2qD1PQVFkKgm0hp8d71lLl+wwB37yVYHEwqw/Y+Jp08KyE17RLjSr8fbbtrcqbRk4GtVbMtgYmwNtJMuSAD2JD5AXGUPGJ5Mf0w/r0z4kJz/3J6PxWf/D+GzSTxEmk9MJ/HS6gU44jp39wYn5b7JpKBzKh2WPA9o0PGvRFUa7SPtkNOa/pyufPxTkIq29hwpvBIg7yBSPhXDKd4tc9OMQvX+3eFt4SS3ppc6qfaL/n3AHbhuV4S3zeWPm35naVWQgeFsiJcymWyRE9D9I9J2JXuCB0YtEXxZw/yRImBGT0air24+QiusoT9EXpYZ1FqSbGCbtcfA9ojUaLzfUVLpi3LOb61ARf7Bp03sZ9xejwjbn1hrrZLOKTpw958Sc+FkNmVigvUMrgg25Y9GXVlOojCbXdqDTjF7wIcFg6b7LudfrC3nLLrOZyNE52KKI42vSjPA7FBHfVsfCWFsJZ3L0O0bdEytxbw2JrNmnkOcMd//ChHZSgN/R27BdT25YH5VXMzzuF45sXYiVC+kqbUbL7Lwv3HQ4rCkgoP0F5NgMNCWVGJoKcUCiGEKhyPgOrGKpBN8P8BiADZQZFwQkOSamo+hlgAtNeAHOqS1niCVXOk/eW3Z3xfyS0ipfBYJrBIt2VrK7N6v29IITFHm0Qd/yxU6xtwFG7xFEI/Hh9331Ls0X1ESDfn+pTGnjYygt1sL14UQ836fsmRPsbTVOayq9MbwCpyCGZTwYDUatErg4v/4kZlfzbvxIPvtJkYAWaxSlizGEJCG9CVK6yE2qNpXgTJnS8blEXtGsUFoEB1HfKZJXTjrjQiDpI51bwa2QSvlpvgz+s9hy0K2Zx2sFPHexeEK2PtTXa3eRmCqPD35YZKC4N0RN1o8Sv3lyZLB8p8dnSK9zKoarzI4rhezreg0O/7RZ0/AwZdOytFYHLQdlkQH1bxIIq+4LVsw7etBfMkuGZyWz7XQL7mfRYpZwh3kVu2oV89XlYsmCfLxtUeLYxsI9nyb0O5V/05deTGxb4UrG47XMQG9Lai+Eievy5yuLj37L
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/nerm/v1/nerm-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Create a synced attribute' (create-synced-attribute)"
|
|
---
|
|
|
|
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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Create a synced attribute</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/profile_types/{profile_type_id}/synced_attributes"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create synced attribute
|
|
|
|
## Request
|
|
|
|
<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={"ne_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","example":"1246d8b3-ac29-4015-8154-dea4434a73fa","description":"synced attribute's ID"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>
|
|
|
|
Expected response to a valid request
|
|
|
|
</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"}>synced_attribute</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true,"example":"1246d8b3-ac29-4015-8154-dea4434a73fa","description":"synced attribute's ID"}}></SchemaItem><SchemaItem collapsible={false} name={"profile_type_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true,"example":"1246d8b3-ac29-4015-8154-dea4434a73fa","description":"Profile type ID of synced attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"ne_attribute_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","readOnly":true,"example":"1246d8b3-ac29-4015-8154-dea4434a73fa","description":"Ne attribute ID of synced attribute"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"synced_attribute\": {\n \"id\": \"1246d8b3-ac29-4015-8154-dea4434a73fa\",\n \"profile_type_id\": \"1246d8b3-ac29-4015-8154-dea4434a73fa\",\n \"ne_attribute_id\": \"1246d8b3-ac29-4015-8154-dea4434a73fa\"\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request - unable to complete.
|
|
|
|
</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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"InvalidJson"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"Invalid JSON syntax. Please check your syntax and try again."}}></SchemaItem></TabItem><TabItem label={"ValidationErrors"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":"The <object> failed to create/update"}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"example":{"attribute":"can't be blank"}}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - returned on unhandled exceptions.
|
|
|
|
</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={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"Sorry something went wrong"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |