mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
8.4 KiB
Plaintext
45 lines
8.4 KiB
Plaintext
---
|
|
id: post-user-role
|
|
sidebar_label: Assign a new role to a user
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzFVttu00AQ/ZXVPufSpm0KkXgIqEhB0KI25aVEaGKPkwV71+ylTWTl35nZbRpDSikv4EiJd+es53LOjNNIU6MFr4ye5HIka+P8tUN7aUqUHZmjy6yq2UzGsXNqoQUIjXfCEkJ4Q6tAeMJ6WDg5upG8jFYnZx1p8XtA51+bfC1HTVwqi+TK24AdmRntUXs2QV2XKouh9L86dthIly2xAr7z6xopBDP/ipknb7XlwL0iL2Rln1/Y5zOhKm8BnbdKLwhYGFsBxSJDIMCGgqcnPg9LYK88+5cP5dvEi0vgaqNdcj84OOCfnwt7tqopVMzFFpoKewul4r1YQfk/ivWc3DlByC90uU6kUsbh8XOV0u9RL/xSjo4GtIRVe7n/lH/FVHfwwNXxY/S8hlxcJhZEVwQN8yT9zFR1iR57f8ON0XhRUJ/sl34b1kRH4t/x0U3n97hPjIpuzqw11snNLCVx8lgSE4rPaijFFdpb6tB4htKx6IPVpD2jKbUl6LykBa4yjCfdXyX3tJqQXe5HNhYVOgcLFGl/TrwJv0SR8B2JK+BCE/TKWLsWzlTol4y6o6jEnTVE9GZLIdvMdpZxDMAKk/2d7DvSxRq4SEOwJZmX3tdu1O83lChofw4VbnqayCLPZo3YI7L7UCs6fAtWsQRiTjt4SqyAULLYIKswM3sjdBrhQhNeQBynVGyWUnCesrKcxozjy4JVfh0DnCNYtOPAadzM2uYrLnyKow164IGT4mwjjNYJRDvp5u22M6bmG2oKg75frU2w6Tb2CnN8uZvhZ1sqfhkjD70qjwp4cVIMj7snp4en3eOT4aA7Pyqy7iB7OTwqhkMoYChbDfu8AxyK0oVhX8xcquZh76B30OqI87PLD2L8cbJfdlLT1igy0GKO/NqKpYcsI/kJEr6oTK6KtWCCTXA8jakYZBVKi1gX1LeK1FaR7LgvqBOQpjUHpaMC5IfJNMbK2qtAtyxPvzx/CrfZNdyf3rmJZ48r369LUDwwkqCbe93ftHgi5Sy5J2izaebg8NqWmw1vE7+WxTbbqTtqjQ7QVCZXrMNvSBD5JoXWnbJrhpeBQ9ibCzy50olxxrPkSeys1bYfL66mLNH7fwzECZ+xcMeqoe+R/EwfWpg0oOLfCt5vZAl6EWiQECY9l68ff98NPA==
|
|
sidebar_class_name: "post 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 'Assign a new role to a user' (post-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"}>Assign a new role to a user</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/user_role"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Assign a new role to a user
|
|
|
|
## 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"}>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> |