developer.sailpoint.com/docs/api/nerm/v1/patch-role.api.mdx

---
id: patch-role
sidebar_label: Update an existing role
hide_title: true
hide_table_of_contents: true
api: eJy9Vl+P4jYQ/yqWn1opLOzC9q5IfeCuW5Wqt3diub5s0cokA/gusVPbYYkivntn7ASyhKNdVSpIYHvG8/c3M664zsEIJ7WaJnzMc+HizUynwCOegI2NzImGlM95IhwwoRjspHVSrZkJfE6sLR8/ctpavoi4gb8KsO6dTko+rvxWGkDxzhQQ8VgrB8oRSeR5KmOvvv/Fkp6K23gDmaCVK3NAzXr5BWKHinJDxjqJWkgsaf9HrkA9cFln0HLkAlVkZPQ9IP9KplA7fQ8ijsFav12cBmG+AUaSmF413sNOZDlZciJqH3ElsvO6D1cecq2sNrYTbVJE10mRw3VhwQSNKFeYeCO3FNCD7KVGmlAdOQ/gmNOMAk//9c2IrURq/Umh6rO2XcSOetZGF3kriqjYiLKjg9xlNW/EpYPMXvZaJE+e/ckHaL9HVU46TyJZvSGd+eNcGGRxYAhgVR1QLhPSowJcNx17pj83UQuYIDcNoBlAnhcexxHThiWQomwedRDageDBiZU2mUDo8qLwVhydur4Z/ZC8XQ57Ir75sTcaXN/23l7fjnoJiNFoOBJvhiuBfvnysJT2gM+bwYD+Xnpwt8vRbkhYw+pzx7YilXTmq4v/z4Ukk38TDwMi+ajS8oCh4vy9TKrfQa0xe+PhDW7Frr19KaUdZVsXzJN5fY1dQvR/R+0Bs6NzGX0nEjYLiWM9Krpl6pMaa5Lu4Oo16dQKPq58QZymrDFoqjxWfqOr++jbfH8Ql1dzZ4yP0SI4cXvOiSnaZ5RI2QOYLfYjfwfdweIqjEK4aoWubYRKUtzALgZ/077KucsoBFLZtWzCMuzZYg0snC9pPFEHCPwv4KCNKZnV2FY2xPWMVrFnozHb+yaFRNOHcUhGUJ8Z874fcf1KJns8tD4KoTMVJkX6xrncjvv9Cl0Vyt0jUPZXCtOFunUJcIXp7otc4uWtMJJAEEB3YA+urUSRUlGJOINYd4eDZw/zQVgr1xR7AlNhHfplyJEF2RcXRrrSG7gEYcBMCvLjcdEmP1Dogx1tpkMmyCle90Q/ajwTnoTFL00HmOuvoNAM/P2p1IUJS07xpCzPjo+CuyYZnd5zOo3rht8ak8fZF1pDU9GPJ/W5IL1SrTRJpzSF0F1fDa4GrQK4v5t9YJNP07MDuCGyGF89Sz+EfZzDCwGfQgnLdCJXJaNs6sJSv0bPkcqkYj4IoLYSwZUhyqgMEPiA/ZyMqn37MJ37GOXaukyoFuXbL64XplbH2rr0SAsBdrBz/TwVkvpCQG1Vo7t5wEV8jD0bAbJBi+i4qpbCwmeT7vd0jGk0hKnFEcQeYYm0tMbM+MfFBSu/m9Xz9nv2+ll91pGmm6vSl1Za0A6XX6EM7wXsa+gQjhVELhkbCO+DSb05XT9e7DQoaqHhxiSmpnaRd9HqH58m8/e/UqnUT2GEC10y4plmJf6O+Z/4xY0OrdLXBJ1XPBVqXWBLQ54gmD5/A5xSBlA=
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 an existing role' (patch-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 an existing role</h1>

<MethodEndpoint method={"patch"} path={"/roles/{id}"}></MethodEndpoint>



Update an existing role

## 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"}>role</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`NeprofileRole`, `NeaccessRole`]"} schema={{"type":"string","enum":["NeprofileRole","NeaccessRole"],"description":"The type of role","example":"NeprofileRole"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Sponsors","description":"The name of the user role"}}></SchemaItem><SchemaItem collapsible={false} name={"archived"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Set to true to archive, false to unarchive","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"groups"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Role groups","items":{"type":"string","example":"ad_group_name"}}}></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"}>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,"example":"sponsors_role"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Sponsors"}}></SchemaItem><SchemaItem collapsible={false} name={"groups"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string","example":"ad_group_name"}}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"role\": {\n    \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"uid\": \"sponsors_role\",\n    \"name\": \"Sponsors\",\n    \"groups\": [\n      \"ad_group_name\"\n    ]\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>