mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
8.5 KiB
Plaintext
45 lines
8.5 KiB
Plaintext
---
|
|
id: post-user-manager
|
|
sidebar_label: Create a new user-manager relationship
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzFVttuEzEQ/RXLz7mUtA0QiYcWFSmIUtQGXkqEJruziWHXXnxps1rl35mxkzZRSpW+QCqla/uM53LOzKaVpkYLXhk9zuVI1sb5rw7tJWiYo5UdmaPLrKoZQefvLYJHAULjvQgE7FYJKSyW8Rq3UDWZeZg7ObqVjBFrjJPTjrT4O6Dz5yZv5KiNS2WRfHsbsCMzoz1qz0dQ16XK4qX9n47dt9JlC6yAn3xTIwVkZj8x8+SwtpyJV+j4lN3+WLs9EK3yLaDzVuk5AQtjK6BwZAgEWHXk+tLD4IT3ypcM2a7qKn64Fq6miqUgBkdH/G+33hfLmgLGXGygwhuq/h2UivdiKeV/qtohFeAcIb/SZZMIpqTD03aV0p9Qz/1Cjo4HXObl9nL/ln9LWXfwQNrJUzydQy6uEx2iK4KGWRmpykxVl+ix9xKSjMargppnn4BNZGMdFfCRTVedv+O+MSq6ubDWUAOupimJ06eSGFN8VkMpbtDeUdtGG0rHog9WkwiNptQWoPOSFrjMMFq6FyX3vKaQXe5HdiYqdI6IEGl/RtQJv0CR8B2JS+BCE/TGWNsIZyr0C0bdU1Ti3hrierWhkM/MZtxxDMA6k/0d/Xeki2VwkYlgS0IsvK/dqN9vKVfQ/jNUuOpp4oucmwaxR3z3oVZkfAdWsQpiWo/wlFsBoWTJQVZhZvam7CTChSa8AOfUnIvPagrOU2JxgEw5vixY5ZsY4AzBoj0LnMntdPv4hmuf4tgGPVDBSXG2EUbrBKKd9PBh0x8T8ws1hUHf7xoTbHqMHcM0Xz8O9osNG/sj5aFv5XEBb06L4Un39PWr192T0+GgOzsusu4gezs8LoZDKGAod5v3MBsOSOnCsDvmL9X0Ve+od7TVGp8vri/F2ZfxfvFJVptDkYEWM+Q3XSQAsox0KKgDRGVyVTSCaTbB8XymktCpUFrE6qC+UyS7ivTHDUItgTS/OSgddSAvx5MYK4uQstw6OfgtuxN5+9iEL3hPJw14XPp+XYLieZLE3q7b4naXQxLWgruG9tt2Bg6/2nK14m2i37IWp4/ij1IkA5reTD/J9Bc2HF4KtDth7wwvA0exNzl4tiWLs4ynzbPY6VZjf7m6mbCC178yiCy2sXDPbyT6Hsnv9EcLk0ZY/CnC+60sQc8DpUqYdC9//gBu5ymh
|
|
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 new user-manager relationship' (post-user-manager)"
|
|
---
|
|
|
|
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 new user-manager relationship</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/user_manager"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Create a new user-manager relationship
|
|
|
|
## 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>user_manager</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"user_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"manager_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><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"}>user_manager</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}}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} schema={{"type":"string","minLength":32,"maxLength":32,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"user_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem><SchemaItem collapsible={false} name={"manager_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"user_manager\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"manager_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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> |