mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
11 KiB
Plaintext
45 lines
11 KiB
Plaintext
---
|
|
id: patch-roles
|
|
sidebar_label: Update multiple roles
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJytVttu2zAM/RVBz2nS3V4C7CEbOiwF2hVttpcuGBibibXakkfJaQMj/z5SysVNsg4D1gKJTR6Kt0MqrXY1EgTj7DjXQ11DyIpbV6LXPZ2jz8jUomTV1zqHgKpqymDqElXjkQQVYOH18F5TtJr2NOGvBn344PKVHrbx1RDy6YEa7OnM2YA2iArqujRZ9D746cVLq31WYAXyFFY1sl83+4lZYEc1SazBsBc5Nrrbw4AIVowyASv/d/Ok3aF8IGMXjELbVJLNNTJ+bkqUYrD8GiHL0Pv4Oj2szaRAJScpN1eUDPAJKi4TK58fte5pC9Vp3zuTu9pZ7+i4CeJIzMVRKFITkkc+FygrzFIqvTt75lgH9uicOwwqOCUdke+NZU/NofRR0tiNrBuXwNnPglxTn6r9cx+Srtpgj/tyImvIf0T4j1ig9ZpdBROiSs46eyOydZQTeilR6uXr83P5eu794qnmvmOuttCYp1pCaUQWKar/gY3O4pc5M+OYWN0YPffhz4hLN9Pracrg7amgP0CublNs6kx6MCtj3JmTEgXs/9+IxzaW41JMX4r7m6CimwsioeU2iXenkhhzfGShVHdIS6ZntOF0CENDljviLKdWgM1LfsGnDKOl/6fkXp5uFJfHkY1UxSMMC1RJPmMGxjFK+GcT6IhWyrsKQyGoR45KPZJjyu5IKDq325oSBISCXwe0WaA+FsDHHjRUsqoIofbDwaDlLMGGayb6um+5U+zWrRD73OkB1IaNl0BG+p+GZgdPWc2B17CMTFZh5o7XRISnTQHem4WUXXjU+MApkeQwlfiyhkxYxQBnCIQ0aiSF+2lXfSdVT3F0QbsmSFKSbYTJ0okglqSHT44qkGAn7gEth8Gf71euofSopZTS4Nv9vXGx7cNuz+9ZfLiZ0zbtrsz9Hkw3znZf3R9sGE6SXRs7d+JIOpWq96p/3j/v0P/64vZKjW7GJ7fxVqkysGoWN3IsdbouFLNcVS4385WShrrGy0Li5FmrjFWxDmiXhqlVMcdkCJj2yAtLgtokdzWexDLVzocKbEdzeCvTqbu73c/Vn6/xVN2AT2FQl2BkIyTSthted674guMQQdvOwONXKtdrEXP/SMg03bM3cokNEHKmhLTxARmiP6aAzibiVuBlE6+Aw6GXtZQsRpksihex085M3owmHz8LBzc/Q7gJYkTwyEL5HOrv/M8vLq2fSDaRt7oEu2h4TTAmHSx/vwHccC91
|
|
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 multiple roles' (patch-roles)"
|
|
---
|
|
|
|
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 multiple roles</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/roles"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Update multiple users
|
|
|
|
## 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"}>roles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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"}}><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Roles"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>roles</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></TabItem><TabItem label={"Job"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"info"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"job has started"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>job_status</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"job_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"3ce88e47ad6dba2ddf349d21"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"queued"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"int"} qualifierMessage={undefined} schema={{"type":"int","example":200}}></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={"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> |