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

45 lines
7.7 KiB
Plaintext

---
id: get-role
sidebar_label: Find role by id
hide_title: true
hide_table_of_contents: true
api: eJyVVdtuGzcQ/RWCTy2gm225TQX0wUWdQkWTFLbbl0AwRrsjickuuRmSihaL/ffOkJItV65T+8FaknM5M+dw2GnXIEEwzs5LPdNrDDeuQj3QJfqCTCMnvD+3K6dWjhQo32BhVqZQ0SMpytYB1l7PPmpZer0Y6AYIagxIst1pywsOY0q2NRKwgbA5zfKrcisVNqjc8hMWQQWnCAMZ3OJAxaaEwL+MosSKY7M/4ZdoCBl6oIgD7YsN1qBnnQ5tIxk9e9s1WzL4GgLvxJhQ4A7qphKTs/PpD+Wb5cUQivOfhtPJ2eXwzdnldFgiTKcXU/jxYgW67xeSzTfOeq6QE5xPJvLztILrHXcnYKkOplICqC1URva+RPSBkxfOBrRB/KFpKlMkBsafvATpTqvI7WDHhoSvYDKE1PxvWnG5/6MfhFB+sFWbO9kPdHzerzb2D7RrZm92cc5L2B0vn0Y57nJqhyN/n0Bz/CyJ0wSPLrd7F7Fek4uNP7IHImhFTQFr/3IcKO+T+31K2fccLpiQjpLY+/Q30NPnGP0FSnWTiVNDFS0sq0Rq4SR6wNFr6HQWP6zShfg3ZQdAc5u08ru49oP/tvtbrFKaa6LUo0Uu4vK5IuaMjyxU6hZpy7c2+XA5fLkiWZars1zaBmxZ8QJ3BSZP/6riXlYhSspTZFeqRu9hjSrvL5m8NAGy/RM5OKJWecdjZSNWXxmV+kqO2e4PFMqZ2w8ygSBTZqbHaSyNO1P2vOlTD/JcilTx+SaExs/G444LBRves0z6kWWyOLNrEUdM9hgaw85bICMSyJJ7MM+FrSBWcqWgqLFwJ+PtLpkrUaEC781aOi9Sij5wVSRlLARfEcmENgFcIhDSVZQ6Pi6Oj2+l8RnHsdEDD1KU3k9EWWcj3skfbw/3/859Rssw+P/PrYuUP7V00/DUl4jSrlzC2WgymhzJ8P31zTt19ef8tFam8HCoCrBqifJgpHqhKJhzxWpTtSvNqlXSVRe9TE1GwKfKWJXAoN0aprhmrkWMLD/kqSqg9k/Ku/ldwto4H2qwRydvDScQ5tWyVWnGPYHYPSr7289bbmnAXRg3FRi5m1k73V5jh6dvoGecimnaMB7Z7rolePyLqr6XbR4kJMwuHqWUeC6Nl2+W7goqjy9g/e5m/+Z9r17/Xj5byGGi2jYJvIqy4s/P2OY3m2cLF8SjnfUjYPPBVSFj4sjlZDyIXB9u5G/XQtQ/uiPkjA==
sidebar_class_name: "get 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 'Find role by id' (get-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"}>Find role by id</h1>
<MethodEndpoint method={"get"} path={"/roles/{id}"}></MethodEndpoint>
Info for a specific user 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><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>