mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
9.2 KiB
Plaintext
45 lines
9.2 KiB
Plaintext
---
|
|
id: patch-user-manager
|
|
sidebar_label: Update a user-manager relationship by id
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzFVttu4zYQ/RWCTy1gxfE1WQP7kN2mqItmd5FLX7JGMZZGNnclUiUpx4Lgf+8MacdOnQ2Sl9YGbFE8I57hOTNUK02FFrwyeprJiazAp8s7h/YKNCzQyo7M0KVWVQwhwF2VgUcBoiZQUkaUsFiEZ7ilqsS8ESqjQA8LJyf3kpFii3Ry1pEW/67R+Q8ma+SkDUNlkZb3tsaOTI32qD1PQVUVKg2P7n5zTKCVLl1iCXzlmwqJkpl/w9TTgpXlZLxCx7O87F/bZV+JJtp7oPNW6QUBc2NLIDqyrgmw6cjtQ18HJ7xXvmDI4b5uwodYgIUSPe/M5L6VmgaEDPundBRkeSTC9BdhcuGXKGI2whuSgAjgCjuiDhJ1hLEiw4KeLTtHe3y0iT+g35G4hrIK9Hv94Tg7nw8SSPvvkuFpb5Sc90bDJEMYDgdDOBvkQHkFgV1FZog72z895b+nGVyuK+KNmdhBOQUQKygU3wv+kP+TFV4jK+cI2WddNHFHScn6+bhS6T9QL0jFyaDP3lkfDo+f8t/6MOk/OnH4nE4fIBPXUQ6RiFrDvAhSpYZN4fHkLSIZjZ/zYPN/C7BjNtXBAb9z6KbzY9yfjArLXFprqHY2s5jE6LkkpsTPaijEDdoV9aIQQ+lQydRWkwmNptSWoLOCBrhOMUS6NyX3sqeQlzxmdiFKdI6EEPH+nKQLdR3xh9V3Y6xthDPULJaMeiBW4sEa0nqzk5DnzGMbZxLcPSaye1gArtuqbEOTLuxG7Du1LQi39L5yk263pZRB+0/UjDYnmmQjDqZBPCHZu1ApCl6BVWyGkN0eHlPMoS7YeZCWmJqj9nUb4IJ7nQDn1II1YFPVzlN+oTnOmF9aW+WbQHCOYNFe1JzP/exw+oYliDwOQY+KcFJy2/F4HEF0J178uiuTW/MdNdGg3/eNqW28DIXDal/vD63LnSjHneWxfCU1w/NRPh4mo7PeWTIcjfvJfJCnST99Nx7k4zHkMJZPa/h1MUxI6dzwcqxf3NPeyenJ6UGFfLq8vhIXX6bHm0/u2k2KFLSYI5/lQQBIU7KjoEIQpclU3giW2dSO2zRtCc0KpUXYHdQrRe4ryYZcJ1QZSG2cSW3PsKvpbeBaGecpy4OZN7xDPOHe7qvxTe8h0Qce175bFaC4tUTDt9sCuX+io6OYCUWSx5bEnafbdg4O72yx2fBtcoJlW872dRBMminH1yRlDoXDF+j/dL09kH8Wbz/Mn01oexN0E6qzqHlEl9+xiS8U1CIpITpv2KlENk58jJSSWw7fBx71Ou7GMeIi5f74InZ20Iq+XNx+/I2rbfu2R8biIAsPfIjS70R+pS8NTOy64ZWQ77eyAL2oSRLCxAfz5x8aR6pz
|
|
sidebar_class_name: "patch 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 'Update a user-manager relationship by id' (patch-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"}>Update a user-manager relationship by id</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/user_managers/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Update a user-manager relationship by id
|
|
|
|
## Request
|
|
|
|
<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={{"name":"id","in":"path","description":"ID of the object to retrieve, update, or delete","required":true,"schema":{"type":"string","format":"uuid","example":"1246d8b3-ac29-4015-8154-dea4434a73fa"}}}></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={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> |