mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
45 lines
10 KiB
Plaintext
45 lines
10 KiB
Plaintext
---
|
|
id: create-permission
|
|
sidebar_label: Create a permission
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzVV1Fv2zYQ/iuEnqnYkiXFDtCHtMsAD2sTJNleWmOgpJPNViI1kkpiGP7vvaPiWJm9LHnYijmAIx2P5Hd333ekN0EJtjCydVKr4Cy4XUnLQJWtlsqxQihWGBAOWAumkdail2WVNuxXWUGxLmrg7APadC1LQWtwJlSJproWuTbeFPBA43T/PC9xk37Jq6cV0cGJpQ3OPgeDbYIFDwz82YF173W5Ds42/lUawDWc6YAHhVYOlKMh0ba1LPweo6+WYtkEtlhBI+jJrVvAjXX+FQqH27WGEDkJlkb3m/6zr9E1/CHLgaN1RqolOmJaGoFggq5DB36QWWCyZLpiDp9oGXSBB9G0Na0CVVom0aQKcxFNw2QGWTgTp3GY51GUChFNJlUVbHlgO4/rlRD265f5pJymUIXFJE7CJJ3mYR6PszCdlpALMcuSaHYU8/ynHeY+I/gonH/fp40haZbyDjEwURRgLXOawN6JuoMBTuQULMEMgaJpEhNS1TVIgIjHfMITnvKMny4GAUTHsA1JWcMd1AS1RzDI1ZsAjPkzCHzKZzxCY8SjmEcTHiU8SnmU8eiUR1MezXg85jHOiXk8GQIeHwNMMAjjgHFbBOqk80W6GprpQwqwLYbXky8ej+nf83UvHloMEkq2c8XkM8Ew95JsXkDBD9HK6ziKzaC8VPV6J+qXZNMOe8ae3DGMs3x6moVVkmZhcjopw7zM0jDPkkkK4zzL45II8aPF+xY9/HfEf3GnY4z9X3Who/IK4yeBJcc09V6U7LqXDgtZp0Ree1kVmgJxcPIWQWkFlxW2lkO57IDNlVfrL9Zn9+/9fhe7Y/bCGG2w1os+iPRYEHPEZ5So2Q2YOzDMz8FwDLjOKGwYmLJOrfC8rvEFHgrwM+2bgnu5AwBteYjsnDVYHrEE1ttzqhkVs/cfMuZGG7NmVjfgVuR1j6jYvdFItO2uhDSm6WLRat/qWuFW+DYaXiaQsz4L1heiMzU6rJxr7dlotMFQhXKfRAPbE4Xlwr31GuAEyz0SrQxIuUYSCXxUe/c+tEp0NdFdFA0U+pC/3p0p9GcC4Swp90SmzjqMy1AgC8JXdEa6tQeYgzBgzjsK5PNiOHxDqe9xDJ2eKkFBUbTeDd97J7T0Dz/vtHmrv4FCGPj9bq070z96vVCVr/c3r4tdMf7a/Z/a6esa4PO28dpe8Ngzo0FXGxNIqSpNIKimfZ6jk/HJeKCWTxfXH9n51fxoQ9kN+jtuDqyzfVEeOwddYhtdymrNqPS6s3S8YppwlEnFfMZA3UlkYoOUJM2gSgCPXwKlPDeCj/Nbn1DiZSPUYORDf6sWz0+0ZzA3exH+W9fyR8o4eHCjthbS93avjc2jiA5u5CuSGJo3m1xY+M3U2y2ZkSyGmLvYS8UTFyfg8Y78I1J/gzWF3kcV3tLmT/U9bDPUCPsZ5wW1phd9F4MucHV5c0t8f/zRgGWkOUbc02UDv8+CL/jnf5X4fuepTPZNUAu17LAvoU+/Ln2+A1mJbvw=
|
|
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 'Create a permission' (create-permission)"
|
|
---
|
|
|
|
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"}>Create a permission</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/permissions"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint can create permissions for Lifecycle, Consolidation, and Collaboration
|
|
|
|
## 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"}>permission</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"role_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the role","example":"ef5d413f-ba18-49e6-9a72-bb115aa133ff"}}></SchemaItem><SchemaItem collapsible={false} name={"subject_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","example":"db3d85ef-c324-458b-b206-58debaa96419","description":"The ID of the object that the permission is giving access to"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** [`1`, `2`, `3`, `4`, `5`, `6`, `7`]"} schema={{"type":"integer","format":"int32","enum":[1,2,3,4,5,6,7],"example":1,"description":"The permissions level of access"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** [`0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`, `17`, `18`, `19`, `20`, `21`, `22`, `23`]"} schema={{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"example":0,"description":"The type of permission"}}></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"}>permission</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,"description":"The id of the permission","example":"2e06b876-f456-473d-bd65-b6435e0b6b2d"}}></SchemaItem><SchemaItem collapsible={false} name={"role_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"The id of the role","example":"ef5d413f-ba18-49e6-9a72-bb115aa133ff"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","example":1,"description":"The permissions level of access"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","example":1,"description":"The type of permission"}}></SchemaItem><SchemaItem collapsible={false} name={"subject_id"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","example":"db3d85ef-c324-458b-b206-58debaa96419","description":"The ID of the object that the permission is giving access to"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"permission\": {\n \"id\": \"2e06b876-f456-473d-bd65-b6435e0b6b2d\",\n \"role_id\": \"ef5d413f-ba18-49e6-9a72-bb115aa133ff\",\n \"value\": 1,\n \"subject\": 1,\n \"subject_id\": \"db3d85ef-c324-458b-b206-58debaa96419\"\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> |