mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
123 lines
47 KiB
Plaintext
123 lines
47 KiB
Plaintext
---
|
|
id: patch-potential-role
|
|
sidebar_label: Update a potential role
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztHGt32sj1r8xRP2ziWryMIfhDezAmu6Q2UMDd09o5ySANoF0hafVITH347733zugF4rFO2t1Nac/JYunOnft+zIzmWXM94fPQcp2eqV1pHg+NxdANhRNa3B65ttDOtZDPA+3qQeu1ewwfsTvLsZy59v5cM0Vg+JaH42H0ZCHYUoQL12SRZ/JQBIw7TDxZQQjwzIvxMh+xRAE8LD06jw6Om7m27X5GsJklbDNgBgydAj7XtOCJeYWAZ+xjZsaP6pHDlyL+HfBPwqQ/Hp2/nJ31B5PuFWvbNnPDhfAzuB03zKIvnZ09OsCrx33AFgofOX7WLEcKZQGvcBr4KxBBIMV1rgXGQiy5dvWshSuPXoY+SmZ9rvnil8jyBQg19CNRJCkSwpJEyRRSZiFW8cSXno3o3hjVVkU0mvqbJud6XZgtnbcqU91smZcX9fpl7WI2hckK6fSyWvxyajeUF0TLJfdXLyP4vZxQBOG1a66QoM35DdfB6fAV9zzbMshEyz8FrqOTjf4Zf+LrLaa47/MVEGWFYhkQAtsezEibCsKd/iSMUNvkss3ejQf9IWJng9grGA+YKWaWI0w2XbGH0dsOa7QqNaYTNCPw968WYegFV+Vy6Lp2ULJEOCu5/ry8CJd22Z8ZOOK1lhXzAzgemRuoDMTh+eiHoSWIYni1paQinSS+y0IXjRn+nLn+UpBOnGiJ03DTpImX7idBPzybG/hLPTBcD6UFvhoiIakqY8i1ovIgRW0mXyjBuBao0GeAxhcBmg68AR9kIffnImSIE8nGAGGLJQAoJvhsBtqR4g6zTOYMrZydG0j8xO1IkOwckdd2Qm06uC8+s+x4YN8K7ZxHJMORi7nws+MvKpV0RPw+MySxrxgmeZCgAKsMYappFEqNxz67sGzL09brDLbYnmNk2/btrAo5LmBim8h1VucPWqVSBdSVSo3+vdDer9eFUZ7ErRQWBaAssLu8ts5ZbOz07hEN8VEDdZvwW9kW/J3AB3s1BAJJBPAOPJ/cLnFS4uK/50JbzlPsJ6i1jCwlDelg6USbhptAxW5ZBJaYt9Y2jJD1IPgkOZoychbRxnSUEPdNJAHSKWbcDvYhJFPdg4/ep+jyhDJgwI0oGIDSSGIQHTxQv1RbrVLB/+T1NI4MQwgTkjQbiTDynYBMbUdGmnK0R1RoFkYmQQZG8slCTNreHFOYWBIvTjxv80XeBA1fQAlkXq8Og0IWPWitvRvmzogpQuzmQpJWM1rVN5VWpdmo8kvOjUq12ahVL416gzdq5uUbjJGmFYCyVn2KNcc4hxrAUKX7Jm8HC1usSkNL+OQIqa92QfjhqhNL4mYyKJwoLn+UyDD0myLkFuRSIlw4AaDJEJ1G5QKqJTQSzDeMpJQlu3l5rqGv81AivKjJuTL4jhJS+uTglJvegJEx9QhA5YVIA4KEMil28N2RjEO4mkLGBSIyCAJmOfuJqhXKQTwZdgSe0s2g2nZNnNaG8n5jUigLAxVQYzw45a4KbasczWakJq9M6wITUvUCf/AKZCWgGOLGwgG7OVI4CfwL7QKihrTlFylEjQZ3f6E64ulvrEDWDco+N2KEgmJJdYE+nAw4Qgc7AlSC77jgAZFWhYs8ozlfAGvnfojmooJTjrFj6YSywsIx3B7mKN6wqY3UnPDzD5Wm+ndsAuGLXVBiIBU3MEGloQwdVja+vSJdrDNK6pkHXAXdY4cdfE0fcY5SVj8T3ffFrjEWChuFB1QilWa5WqEuAXMrhvFxCEG8WAAJDDW9CLfLHbeqd1WMDaGj70967Vt4Nuz2b3r97+FXZ3A3vO1OuvDzbbt3273J12jZQdv6zK13DPNcAF+/RNw+Pvso6INRpopNxLaf+7JZPyrzSNjDSSc2D73Jmw29Xp9xfWpCU2406o3L+rTRuKy2cG5ZCaZTT6GZFdwpnDs/33cBo8Gk0ijITY8NPSKXKb7YLOL8n66+7DbIL6+kcMa0mipYhslJrzW7aMwuxaVeFW+qel0YIL3Km6Z+WX/TumyZrarRrGpHO1uG20RoqmJ2Itvm01hk2543umNjJaeM1wHl/WjZS/JLz8kv3x22WnSCZbQ8OlvtI7VWaNSeHzlissAM7NrmkY5Eg0BDalS22YSqCSnARwa3jcjGOILLDIBiKsxhfro95Bam2n1uMOORHe5eJNvUrHSHIm8wXG9HiKRXG1qQ3bUVHDLW53wKeoAgCNjBnyyOJulGUJ+X0NyubnjIx4YlHEPgz0BQLo2z4lvLhkGdZOjzZu8ACdLnToCCx2XjW1c2T1fszuJLC6XIYeAtnwr7OHATiCiYJxn2N7GiHqhf6t1gKJ/880N7Mhn1ru8n3XHpdtBpT3qDfuqHmq3mALZkjw89C/Qjf79v347j9pRWtSUJshc9FFty6f3oTL2vDjhKxbl4+nC41zsvAqnVKglMvUb1gZFR8OGw9QgxnPvG4lFj8UCgmIeY1M3IELIrfwFruwPfAYtd7zXZ4yrIQv3MCFnK5os5+P9wnMIqWeWqMUW6xLc2I94oI9A0zRDs7hpwPOx2oJjr/QvqPKr97oCDXMGXh9gmDn9NVpKwoLhcHW2rWlasewjrjLrtCU15P7xRv5TYe93xh8H1pN3r09Ph6L7f/TD5YdQd/zC4vcm9iovVD6PBLYwajgad7ngsC93Nl/GMOe5TMnarJa5uMd3A4zvatitYe5Ovk209TL9QExiR72OfX5yPdonnrt2/pxq8fT8ZfBjd5alO3u61pZTWvWY3TCrJm9B9ifnt60G+pv0VMpEv4dbSxepFa6Md20I9dH0fQpSu1kdRR6q4ldtsbOqaK2ZhOQf+a33Z8mc+Kcp1uo5rHlH8vrUcoc99Trtpgkg2YKBalSUzc32hlv7i+pzg8g0NSKJUZdccamLFX0cxg9L0ufEzdemHCbp3rF9wH0MNgaSVbGQUTCuagk8blVatPmvUOa+9qVebl9PWjF9cVKAVoB5qCebH56KoQMhP/b1wILUYDMOtbf0bBOILDrInAmjy41dnCMeRzYeETdhU9LJQPIXnUOpfd4as3mQ2d+YRPefzDSE4+v14K+UB5xLxwLfmVuHKaew8N9237fvbCTwZQVLpjuEX4traZmo7YK0mmqVLTcnC/SwLDMnAZw5FtrBpq7DEzhTWM2CIq/0BBWjJv4JVAMJkqoSHEWr2ghFZ1Gzmu8ucK5HfPIXslVUSpXPoSeDZkjaNczsPZ23DEF6o3ypJnrGF4KbwX5dYO1mykvtoAYxf0danacrwighmEbgyEGNBsItC5rihZWw09qkoNwuQOKTcZpWCzgGUH7GTa4QRhkFkM+uFibUoEpV+gGYpuTx1k4zQSKQrJ+QGcMFtewVihAxiQGQC3qwwYCocoboCCDxODJdErNy2AlJzJ4mh+I7FLI+CI/xuaEP40Ym15MUnoZyPFq3VHhFLVxbjiAQvaQcbB8c7SbEsYseXR0xOvnvy3ZPvHum7my9HakdYvaXSp7pd+tw7PAL5+pQ8t0ofn6zHcVkMJHf5pSLPcQlJlUjvfpyAY/8sHIQXTx4eWfiK9ZFM5VvEtxN9yOfT+HhMnPpTXSCBJEfJwQwikTCviO6UYlkkkqgutmd76/pTCwzUKSgRIWr6bOVGjIPI/MihWpgH58x0ReB8F7IFh/jIwSOCQEZAnNUxdQ9P+JwqyVMlecpGp2z07WSjUyV58t2T7/4xfXdvJZlQRd6i6iR1alBamnovd9QBgMVnE1nicsk542y1gshYUmNp+cpBm9aq0+qsaYi6yetm46I1qxmNGr9sVpvVab3W1LK5/iH148TJ8j6V0bfUo9p59D9BHRc5YFxB6LpmfvkPxOuLGYY1OnMd180g85I8h6lqx/p27dh3Q+ANEEPt6O9YXrwf3SJ+3LdH9Cg32rnBMluKTu4UYUmJNiy/CTmVjqfS8ZR+Tunnm0k/p9Lx5Lsn3/1j+u6vKh3rh0rH+q8oHesMS6wZlli/ZeloQt2BpdkMlAI8JDv88fd7avVRub36ii8u9HJVZK1VcLLNddkdd1ZxsRTkViKdVFwY3gB2ibB+DEunEOcQIh38QMty5fFya4nnj308/GdbS4v8GBkCvP5Kb8/wCI/0mdjeklksh75KCCgo2C6uvbpgYxZ+EzzD8g8w0DroHAL1V1zjVNr6ovVgNkKOb5Fj1n2SX0axZP33suiUQA8/xcRwMZa63nFcQK6ZcwfaCPHkyfCVlKCnUv1Uqp/S/Sndfxvp/lSqn3z35Lt/TN/9FaW6qoZ2l+oAcHSpDrClCktqqbf0Lcj/umInV1EUkHkz16Ba3UxrcKor5HleeaOPln6ejyd2dXniVVcndoPyc3KpzbqcHIPVCVSKDoJP+XnjY/q1hl91YT0pWYl8GyaIb0J5BljQ7LrEPasUfznhuJ9LhrssT0GsBRELD6hK70QA1h72VHNSIp34Fpq9jJGEXGpIfZOjBaApOpOwF3P8LfsK+hYm0ZzjgV9lgvQYSPSg//guIOiSuo9jgz/g696311/Oi0S0g5ci8e2dDeAZULrBIrLwHtUFpkLfMoK+7oGejgxw7QiN4+F9FmaMBb2kcAsyTVK4lVDbImiAYDV2LbgP3YY8XfPq3Y+T12yOZSyFEbr+iQkL+w5wxCGYEYXJdnzSBAdR5vLdaL4g5tq5szzolmxmg1DYozMWgj3EX+b2IX+MIOCT2HGQoBiDo9K7ekzxSdiYWkuptNE4LdMpgxTLPDfuNaVR6jcsR340hh9/PDo6u7EwuqEjEYxikdpH9uDFfPEMXy8l4k8xNl1i0wlb8HqDCinaB0OeDTcgNki/DUhaL55c4tMz+LA5gyeIdZMGlISiI38Cy4i19mI6cvh0xJen49H5cWFBjs4Piz9hCCDF2ibrMWPhuoH4K2NoOugqD/MIPO3FZH3GSXXyCL1WyZCkyyl1S4eKk+i7BcdwpDHxKWZ8KnhcufZCbvuRNAtx4SNdmfMxxzM9foDEjJCmawQvphkn1HFCXcaJQNGvbt94TXeiIQ/yRhMygE6qf4oEitBMbJS4CiM/oS/TGE19BklYAu9K/nGVBkH1S34RidAJDIRqLNiTM2nwN1O4MPnlhBUvNWxKcJte24WcuyE3SW+yYYp5+PfGL3LcTldkBo69+tpRekck+f3E3d8o4p0izbcYaVQJjSubo/Sawu72zV7H3dm1dZcZFFloysSS6mOyDnSt6sXt1UdcHl8I+BfeUhygTgD6LOocqULKIgLyQvQYihjGwhK0buEJHmLteY5W6y7Jyz3fxdAC3SkhmtM1TD6Ig0OnaeF9FrSyHs/MyRllYYs2g38HkTrn4YK5Qx8sSuxHaCUdA1SObSSeMIZ3P7mqnxyD1umOQHYTGxIUdMtl5ODtGUB2tGQczPWAtZlWYEQyKEJX6YhYFvK6z2RUHCHQjJEF+rpP+MtgMMMlcei2M0Z1YC6wqUCth4PoUYvqy9mUkZGwk0vt8m3DIdxgyfpC2B42shDRobgTmRnuepMtjIDMUZsweOWkGhSUERYvRgTmpflclKqlik7tCt7J4AYhtN4Z5Pd0ZWvRdQ8bd2IlOwHfwoWvKkVib1P2cK0PhRPJfkz69YNW1DPD0KvsVbC72maE27yKFQLAAsSPqJ+fcSUJG8k1PoZog8sUeHFD3CNSwAHzwN/Q0NP1fHtU8mqkrl18TXthOy+ZLeQ7Xgl1Vpn4BT9/po/IU3axHX4xSftukn0BVZvCXePNBnL9jUQnodSGjz6RX5bHWPZdLotMysFyeW/PMIrpyZLLsD3p/ADQU3W57VIuH/n8MzzEf6+0R/i/hh/YyygBQPT8WYsXYwFGIsb//QctPBT5
|
|
sidebar_class_name: "patch api-method"
|
|
info_path: docs/api/beta/identitynow-beta-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 a potential role' (patch-potential-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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Update a potential role</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
The method updates an existing potential role using.
|
|
|
|
The following fields can be modified:
|
|
|
|
* `description`
|
|
|
|
* `name`
|
|
|
|
* `saved`
|
|
|
|
|
|
>**NOTE: All other fields cannot be modified.**
|
|
|
|
|
|
## 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={{"in":"path","name":"sessionId","schema":{"type":"string"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"potentialRoleId","schema":{"type":"string"},"required":true,"description":"The potential role summary id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul 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={"op"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`remove`, `replace`]"} schema={{"type":"string","description":"The operation to be performed","enum":["remove","replace"],"example":"replace"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Succeeded. Returns the potential role summary based on the potentialRoleId provided.
|
|
|
|
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>createdBy</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The session created by details.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the creator","example":"2c918090761a5aac0176215c46a62d58"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the creator","example":"Ashley.Pierce"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"density"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The density of a potential role.","example":75,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of a potential role.","example":"Potential Role for Accounting dept"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of entitlements in a potential role.","example":25,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"excludedEntitlements"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of entitlement ids to be excluded.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]}}></SchemaItem><SchemaItem collapsible={false} name={"freshness"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The freshness of a potential role.","example":75,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities in a potential role.","example":25,"format":"int32"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>identityDistribution</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Identity attribute distribution.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the potential role","example":"department"}}></SchemaItem><SchemaItem collapsible={false} name={"distribution"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"example":[{"attributeValue":"NM Tier 3","count":6}]}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The list of ids in a potential role.","type":"array","items":{"type":"string"},"example":["07a0b4e2","13b4e2a0"]}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the potential role.","example":"Saved Potential Role - 07/10"}}></SchemaItem><SchemaItem collapsible={false} name={"provisionState"} required={false} schemaName={"RoleMiningPotentialRoleProvisionState"} qualifierMessage={"**Possible values:** [`POTENTIAL`, `PENDING`, `COMPLETE`, `FAILED`]"} schema={{"description":"The provisioning state of a potential role.","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"example":"POTENTIAL","title":"RoleMiningPotentialRoleProvisionState"}}></SchemaItem><SchemaItem collapsible={false} name={"quality"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The quality of a potential role.","example":100,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The roleId of a potential role.","example":"07a0b4e2-7a76-44fa-bd0b-c64654b66519"}}></SchemaItem><SchemaItem collapsible={false} name={"saved"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"The potential role's saved status.","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>session</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The session parameters of the potential role.
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the role mining session","example":"9f36f5e5-1e81-4eca-b087-548959d91c71"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The session's saved name","nullable":true,"example":"Saved RM Session - 07/10"}}></SchemaItem><SchemaItem collapsible={false} name={"minNumIdentitiesInPotentialRole"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Minimum number of identities in a potential role","nullable":true,"example":20,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"pruneThreshold"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The prune threshold to be used or null to calculate prescribedPruneThreshold","nullable":true,"example":5,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"saved"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":true,"description":"The session's saved status","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>scope</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The scope of identities for this role mining session
|
|
|
|
</div><SchemaItem collapsible={false} name={"identityIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"The list of identities for this role mining session.","example":["2c918090761a5aac0176215c46a62d58","2c918090761a5aac01722015c46a62d42"]}}></SchemaItem><SchemaItem collapsible={false} name={"criteria"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The \"search\" criteria that produces the list of identities for this role mining session.","nullable":true,"example":"source.name:DataScienceDataset"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeFilterCriteria"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"object"},"description":"The filter criteria for this role mining session.","nullable":true,"example":{"displayName":{"untranslated":"Location: Miami"},"ariaLabel":{"untranslated":"Location: Miami"},"data":{"displayName":{"translateKey":"IDN.IDENTITY_ATTRIBUTES.LOCATION"},"name":"location","operator":"EQUALS","values":["Miami"]}}}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining potential type","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED","title":"RoleMiningRoleType"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"RoleMiningSessionState"} qualifierMessage={"**Possible values:** [`CREATED`, `UPDATED`, `IDENTITIES_OBTAINED`, `PRUNE_THRESHOLD_OBTAINED`, `POTENTIAL_ROLES_PROCESSING`, `POTENTIAL_ROLES_CREATED`]"} schema={{"description":"Role mining session state","type":"string","enum":["CREATED","UPDATED","IDENTITIES_OBTAINED","PRUNE_THRESHOLD_OBTAINED","POTENTIAL_ROLES_PROCESSING","POTENTIAL_ROLES_CREATED"],"example":"CREATED","title":"RoleMiningSessionState"}}></SchemaItem><SchemaItem collapsible={false} name={"scopingMethod"} required={false} schemaName={"RoleMiningSessionScopingMethod"} qualifierMessage={"**Possible values:** [`MANUAL`, `AUTO_RM`]"} schema={{"description":"Scoping method used in current role mining session","type":"string","enum":["MANUAL","AUTO_RM"],"example":"MANUAL","title":"RoleMiningSessionScopingMethod"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RoleMiningRoleType"} qualifierMessage={"**Possible values:** [`SPECIALIZED`, `COMMON`]"} schema={{"description":"Role mining potential type.","type":"string","enum":["SPECIALIZED","COMMON"],"example":"SPECIALIZED","title":"RoleMiningRoleType"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</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":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</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={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</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={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |