Files
developer.sailpoint.com/docs/api/nerm/v1/patch-user-role.api.mdx
2024-03-06 16:17:34 -05:00

45 lines
9.2 KiB
Plaintext

---
id: patch-user-role
sidebar_label: Update a user role pairing by id
hide_title: true
hide_table_of_contents: true
api: eJzFVtuO4zYM/RVBTy0Q557MbIA+ZLdTNEX3grn0ZRoUjE0n2nUkV5JnxjDy70tKue1mdpB5aRMgsUzSOuQ5pNxIU6IFr4yeZXIiS/Dp6s6hvTYFypbM0KVWlWwn612ZgUcBoiIPYclFlKCs0kuxqIXKKMDD0snJvdx7ODlvSYv/Vuj8W5PVctKEpbJIG3pbYUumRnvUnk1QloVKA6DOZ8e7NtKlK1wDX/m6RMJhFp8x9bRbaRm+V7QLWXnPf3jPM10J8MHRec6DHHNj10BYZFWRw4bA0xPP8yVnrzzvL/c13IQP7Q8W1ujRcnkaqWlBbqFmSsfKr04KPvtVmFz4FYqYh/BGWKTd8QFbogp0tISxIsOCni1bJ6U9qd0PsLckPsG6DNh7/eE4u1wMEkj7b5JhtzdKLnujYZIhDIeDIVwMcqC8Aq+uNNrFmva7Xf77NoOrp5JwYyZ2rpwCiAcoFN8LspD/hwLOIZQThOyjLupYTqKxej5urfSfqJdE4WTQpyU8HS9Pn/JfyS/p7wU4fI6et5CJ68iCSESlYVEEhlLDWvDYfg03RuPHPKj7+9LvYM10IP4PDt20fuz3F3uFba6sNdQym3lMYvRcEjPCZzUU4gbtA42dEEPpUKdUVpP2jKbUVqCzghb4lGKIdK9K7mU1IW95imwq1ugcLFHE+wseldzO0f+46W6MtbVwhmbEir0eCZV4tIaI3uwoZJvZj2kGwUNjIjt73btOo7INWVwoRZw1lS3IaeV96SadTkP5gvYfaABt2po4IwCmRmwT5x0oFQU/gFWshJDawT3ml0NVsOYgXWNqTkbWbXAXPN8EOKeWTAArqnKekrOczZzxpZVVvg4AFwgW7bTiZO7nx+Ybrn/Ecey0p4OTktspx+voRHfixW+7Brk1X1ATDPr9pTaVjZehZZjq68P5dLVj5Ltpsm9ZSdPvcpSPh8nooneRDEfjfrIY5GnST9+MB/l4DDmM5VHfnhfAUJTODe/FzMVq9trddveoMT5cXb8X00+z07KTqHZGkYIWC+RTOpQe0pRUKEj/Ym0yldeCCTaV46FMxSCrUFqEuqB+UCS6NamP24MaAmloM6jtifV+dhuwlsb5NegjyxlvB99gbg7Nd9abRWTc45PvlAUoniBR2s22D+4PjDkKmFAYSWlFQNnWNAtweGeLzYZvE+GW1Tc/yD1oMVOOr4m3HAqHL2D+6Xp71v4sXn9OP5vN9iboOjRhUfGKLr9gHd8VaAxSQnSakMYZbDS8i5CSWw4/BJ7MM564MWKa8gx80Xd+NG4+TW/f/c5NtX1/IxVxkIVH1jn9TuTf9KWFiZM1vOTx/UYWoJcVTUDyiQ/mz1cIAJJt
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 role pairing by id' (patch-user-role)"
---
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 role pairing by id</h1>
<MethodEndpoint method={"patch"} path={"/user_roles/{id}"}></MethodEndpoint>
Update a user role pairing 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_role</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={"role_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_role</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={"role_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_role\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"uid\": \"string\",\n \"user_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"role_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>