--- id: patch-user-role sidebar_label: Update a user role pairing by id hide_title: true hide_table_of_contents: true api: {"operationId":"patchUserRole","description":"Update a user role pairing by id","tags":["User Roles"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"user_id":{"description":"The user_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"The role_id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"parameters":[{"name":"id","in":"path","description":"ID of the object to retrieve or update","required":true,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"user_role":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"user_id":{"description":"the user id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"role_id":{"description":"the role id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"patch","path":"/user_roles/{id}","jsonRequestBodyExample":{"user_role":{"user_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e","role_id":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}},"info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Update a user role pairing by id","description":{"content":"Update a user role pairing by id","type":"text/plain"},"url":{"path":["user_roles",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the object to retrieve or update","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "patch api-method" info_path: nerm/api/nerm-lifecycle-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 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 DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem"; ## Update a user role pairing by id Update a user role pairing by id
Path Parameters
Request Body required
    user_role object
Expected response to a valid request
Schema
    user_role object
    = 32 characters` and `<= 32 characters`"} defaultValue={undefined}>
Bad Request - unable to complete.
Schema
    oneOf
Internal Server Error - returned on unhandled exceptions.
Schema