mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
95 lines
42 KiB
Plaintext
95 lines
42 KiB
Plaintext
---
|
|
id: get-potential-role-summaries
|
|
sidebar_label: Retrieves all potential role summaries
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztPGtzGseWf6WLfIhEMQgQSEJVW1tYwgm5egXQZncll9PMNNDJ0IOnZ2xzVfrve87pnhcvYcWVjRO+2GLm9OnzfvRjnkrBXIQ8koHqeaXz0kREd0EkVCS53w98MYhnMx5KoUuVUsQnunT+UOp1egzfsWuppJqU3lVKntBuKOeIBpAMp1KzmYimgcdCEcWh0iyaCjZPMLMQh+sENxsHIePm4YxwMi20BmRVmHbOQw7IRIiTP5UkzjDn0RReKXgBvywwMFApaXcqZrx0/lSKFnN6GYVI5HOlFIoPsQwFsBmFsVglWqyjgEnEKj7z2dxHdGduvV0TJ6fO2SnnTlN4bYe3ayPHa3ut42az1Tgej2AyS+eHWISLHKFBSHzkaRlzXwMxOloQfhDFjCac+4EnElI3cVUheB7BEzcAaTpaoLgiQPy8zOAAJgd16NiPNIs18ohK0RFXHg89phcq4p+ZGTQSHpOKPfzXMevc9dggAboIfF+4iJHdpXp5dzCNork+PzryxEfho0VVNZf+PJAqqgJhR9JTR3wuj5LJHDfF42T6/Q7lA3Q5lsrDR/WoBuYZA5PS8XyOEvTIYJD4MaAJPuHrsRS+p89ZueyGAgVwCf+UywXd5d5sVNFY+lZFRem9ped/cfkZ4pcl+DZ5upsMGUzBTFQIQn2OGFKhvln0vHIZpCw+VJj+VGFuUF4CuAFi1oPkBEoAhZdCWY3BC19UmB/ZF2NgZarAGVOkE3g9iQAkD6Y2Tvsh5r6MFtuHg2DDKCXAgCSv+EeRMG0foRMmTwoWdlAQA9DAHsHKosfSIQr1ICdFoBHeNdx2/azWrp0mEIiZiQ/w6uL2+vr2Jnl+oFJ8EEIRIWjvgEhDcIwSh4dfL648b3KPYDzWIlrxjlt6DBYfBcamYt+3vgKBNKqyew1a8BdMz4Urwc489klGU1C1nMmozGDYnE+kAunA+DCIJ1PCY824CmFAiD/Zmw7JQ2ZBKIAvE2ZtRloRcmoAtTUihVnFRIT5WA2PjhvwAFPNLJ7ROE+MOfAKf28UPglrRfbXEHRUPBtBdArGaYACiZrU+83IrtH6A9Kb8c/mb8KSyhJ+bZSmG8RqVZq9MSujb5SZjMBGwYznwTz2jWEKVv5vZxhE3HcucHQZxT0PlBZsKrgHGiCrRsA1GplywBjEvsdGwioHs8Q49QL09LLxsDL7JFB4EwUy9KqUCKVycRywoSkjclAykMKIEeZyxaYQD+AxaI2EhfByNucuRDvgBqJ/KLBMgFgLE6sgQivRAmctE5L/IM7LSBNR+5H7sTBSQGggO9YJNd+ETW2IcqMACj2uSjlLoZHPz+8Qm1GpxgGNWg3/W6qkYtcVAmRYZX1b3nLmSx2hul9X5LqBwmE4F5/PfekSc0e/aZzwaZUDHoYcbVlGYqZzz4PRbyA4rJpDFHQkDRtQxK6pHZcs30PyV+v0QoITNddteaeeMxqfjp3m+KzujBp87JydnbVGtbbXbjeOsfQ0PvbSlJQkX5407UhM2+EwQwXOM883K30xXlXWpYjA2EBDoyCO1s/0j5QdTBTJiGDwjenl7pbFCVDSw0fRgiLe2si82khl0c+ORgeAepgvkVpdF9dzGQGmp+G+gKAVvY6CHIJX0FBv5UTwA1Qmc4h2UaxfVtDQNAcAa0ttiL8JIjZBTOzTVLpTitwQWh9L/e7P993BsHv5WGIw4rF0+2bY6d3g74JOk8fkAGHwUWIUQbLEqvnnqMDglEBTuZ9QtSQPdpEQdHc77N4Me52rx1IFf3ZvLns3P5gfbzu9K6SsYkiFcvXuqjvsPpaqRfszYzIvS6UlFObrh2wSeJZBJ/jgTzMTLjO8YLB3RVlgyw9Pe7v472XqSgkOyJAUq8Fier2fkcne5U2VsRssbSlBrkgO8q+2iVKoPCYUiYJxfJQlpUxEDd4ciZPxyB0fu01xcjJqt3jNrbfGY6/VrptGXmmwmh1N30LjCkwoXXZQc+q12qFhcI22f5STKXhKMopyPjqKh0kIeDKvNZQoPiQygOCzQE20iaWZe293o3YN2EhbuR0ZSeG/kJVs3DIz65SGa1VYVHgSyyqoOj5iowVlE1QUWCCJz9LUWwj9ApunyKZtOHdk0kJ/IYvJqF0YRKtELaYqxjozldF2hs6QIcPFcmTp5yqZbEaErW7x9sFd9wJ8vfe/4NEV2+Sia2fuUIRYdXn8a4jYgTJbQW0Ie3YFLysh1+fLHLl/oATAGbMwsqbMK4TF9vj4ZNwSLacuoAxoCpc7o9rZqdNqnrVbUArU3dP67rVAjtvvNTOrAjRyW9gZEFj/mg2snBxWOz2q13BaoPwmnvVS5+6pQqDdwbSvTXO2cyWwjdRGbcVEKfPFSgynaMeB7+3obTQIlxjMKPRv29VghEcK8JHLfdf0fPMwWc67K063hdzWOmpJKdtbkE2r0suaNem8tNTm4BxusM5RCQe+WtJCmv9fMNantP7pebgGD94K2HFJkdOadhy6oormdn7JIz5wpYDGE/80K0U8AqMdxZEw65AX6VCgU+q5z2mtDH9CdRdypX1avz4vXQWmCzpn15LPJEoREhC/4iPh7wbuARFr5kmH/UssKPnfVHuXWIMM/+d9Zzjs997cD7uD6tXtRWfYg/D0nK3A2DmArWSFFJ5C2da5GsAzE40xzBkS3j0/P78cW3KyfbG/y3YzVnWcdKA7qrhQpz1kS5Endd7i3K3VT08a9ZbbPOEnDa91BtBrQBqNWgrTbADDedvYJWw9QgznoTuFkjcZaNYeQEpe7Aqzc/QK1jYHvhcs9nmrye7Wf6/Vj1mdz9h8NQf/DMdZ26DaXDWgSPeK0uTPq0zWt2P9VVUzA7qZsIt+tzOkKe/vLu1fVuy97uB92g1C+9S/v+m+H/7Y7w5+vL26LLxKuqz3/dsrGHXXv73oDgam2Vp+mcxY4D4jY7Nakr4L0w08vqY94DULaOZ1skdM6RdqAjcOQ9DVhny0STzXnZt7ah4798Pb9/3rItXp2622lNG61eyyRc3LKNhlCcVsny9Kz8aem+tWEy98iUx3wxDigWNXFM3CsNkCoQVfNgq8BfYqUoGzSO81i4YbMpBHK2QXtC30Ush+K5VwJiGXSKEgkl0YaJpdj3RKvRShTIphgisuC4AkqnX2hkMBavm7sMygUEPu/g64dunc75WE8SwZAhki3dhcM604FXx0Ums3muOTJueNs2b9tDVqj/nxcQ3q7jbVvqBrPhHrsnFx6h+EEtiyYWzz5b9xwUBwkD0RQJPvvkBLOHas9A1syqall0Xic1SBuvrNxR1rnjKfq0lMz/lkSQjKuR+s5Bfg3CC+DeVEqnWkJB532X3bub8awhO7YlWqIK6VcyAdlTSmAXUA0+CTyeaGgU/Ql2qBC/24kl62WMvAELcHRiygNL/0QoMwma2XYYSdfc2IPGpodYNZwZXIbz5H7EBWRbUCDQA8g3LdnbIRp05Amb2ejuuKeeRcWUmW7SbPYZV1PE8ik5BVbAc+4wvsJLjnmVhmdkHBlQXtCeHaswoi6YqiLjJRLmf7JLJc5ZWCzgGUv2wnHTeKMeUhm3kvTK3FkpgsHHhWckXqhjmhkUjxiIMLXNBerhtAuHYhMgFvMtLMhiM6ZQCBRyVwacTKB0wKd9eGmCSYujzWO/jdnQ/hxyHW0hcfhXU+2vk00Yi0kajJRiS7P02DLVSqrsTxzTmIve/ufXfvuzv67vLLvt1DtW+p9Kmvlj73iscg35CS50rpE5L1qIAlQFTeWEXStoMtkX76ZQiO/btQCC8+z3Ev+CvWRyaVrxDfSfVhj3wlJ8KS1J/pAgkkORoOxhCJhHdOdGcUmyKRRHW8OtvbIBxJMFC1pkSEqBmyRRAzDiILY0WFM9cV5gVCq+8jey4APEJrEwFxVuU5Zgt+X0nuK8l9Ntpno79NNtpXknvf3fvut+m7WyvJlCryFlsnabvGRpZm3yO3nAFAdkAzdTlS1XK1gshYWmOVipVDadSoj+rjU1c0Pd70To7b44Z70uCt0/ppfdRsnJbyuf4h8+PUyYo+ldO30aPd5gs/Qh0XKzAuHQWBV1z+i/HyxhjDGoaetG4GmYNI36W1Y6O9ZgMwCNg1V4ukQtKFGlJlMsKYBrAzhA0TWNqsnUBcVHiwVAbmqJuc4WEyvGrC6PQqOi9yAXjDhdMZ406HPRNrjSydRSrXj4FCigR+gFVzAIYl8dzMGGs+wEAV7ASi81esTq2K/lAlz/rI8RVyzLqfzSlQllburXXruz0gPsQYMTAK3rDQa7odrsAAoCEwMSutO/f1+b4+3+f4fY7/e+T4fX2+9929736bvvsF9bmthjbX5wCwc30OsNUaS2upt3Rk7s8u08lVLAVk3ixw6dCCl9XgVFeYYw94mx5jCF5WPy8d4bEGxxxrcOyxBn30lF5efz5Kj6o4BKpzd+9Nc2DIjkMf0CWXqp5gDGjxucrnspocJlPBJ7pZNQIRrolOeIzAeCIC0B0uM0GV5B9KNHETDwm50YY9plhKL29txazs/ZRFEEMEJDQVPIJjzY0e0zFrtfheE3SVzGuFP+DrPvSf/zgvBtEGXtaJb+tsAM+A0iUWkYV3qC4wCzoDDvq6B3ouTDDrxGgKD+/yMAMs3g2FK5BZQsKGr7FC0C2CNdgbwUPoLMweyMFPvwwP2QRLVgoZ5qq6kNhjgNPdgRlRSOwk+wE4iLJUdu+2U9hxQRdkYx+EwuzFP3syeHEDuaIPwZ3EjoMExRMctfu1P14Yt+Ga36Ny2KUMza1Ac/rPsmiuQj7ME754jq/XEvFdgs0x2BzChtfpC1QY0T645gSPC3HA+K8mab16coPPyeHDRgyeINZlGlASlo7iPpmbaO3VdBTwOYivSMej+oUuMBWHJae69JTuuvaYOw0CLf6TMTQddJWHSQye9mqy6NaUQx7hNGo5khwzpSMdqC6JvitwDGWMydz/o+ImgLpPecZtfyXNQlz4la5F/FrgmR4/QBJGSC9wv+Au6xLNOKGDEzomTmhLv8lxaFjg28gDxQFjABeZ/ikSWEJzsdHgWhv5Cf0RjSnZk+GERc/PzY/zLAjav8whcYROYSBUY3Ge7hzCb2ZxYaIrCCtZVliW4Cq9fgD5dUluht50WQtz7l+NX+S4k62+3Cp/8bWj9IZI8teJu/9PEW8faf6OkcaWy2huNK3tK/JG/sbWdKurgZo+yAD/wlvyVarMoe/JvsGQRzT3eYRWTV7tTqWgdYS54BHWhxW0rGBGnggtP7o/dIuEaELfbAmBZA6dn8Rbd7TSnczMyWFM8Yl6xd86pmaGrhJNoS8VVfYLtHbKBbVgW4dnNeDdb4Ht7wagmTtULLtMlA1F12wWK7yuB2THM8bBpF6wCE9qNzaBC7o8JRJZBJG54GlHJV6MpoYs0P03Ec707RiXqKH7zSn+hblA79quT4PoUYv2wH/GSF/4ZJkIVyztX8IN1uZMhT/HxhKiLhRgIjfDdW+4ghGQKXu9IwgnR3aQPkJYQIItlDGf42q9WnOopaCvCOgIWuEcctzGQBvRlAI2fdNh2SqfsoX6r/wRNJtgsDM4muOqGJIdm27G9JcPpXX9JQw9z38ebWOLCQ3JFKSAeJ6ecIEFe65nfGw+m4KNDOgFnSX7zsZG5v+p3xpbq6bf6bJM9u03u8BRom+Q7S7T/RfI9l8g2/QFsi12l33Q7pV298/6ttcWSabfPnulIL+tD3VtEUTyHbJXymH/ia1v7xNbW6wh+Y5aZg3vsoXXL6wbDvr2U16HdJhk4/dY15KTbCWqRZ6aNP+mVdAz3lI2xkTkmfdmGyk3cuWgBfKVLu3/0IWK8vn/AJOcaDY=
|
|
sidebar_class_name: "get 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 'Retrieves all potential role summaries' (get-potential-role-summaries)"
|
|
---
|
|
|
|
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"}>Retrieves all potential role summaries</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/role-mining-sessions/{sessionId}/potential-role-summaries"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This method returns the potential role summaries for a role mining session.
|
|
|
|
## 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></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **createdDate**","example":"createdDate"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**createdById**: *eq, sw, co*\n\n**createdByName**: *eq, sw, co*\n\n**description**: *sw, co*\n\n**endDate**: *le, lt*\n\n**freshness**: *eq, ge, gt, le, lt*\n\n**name**: *eq, sw, co*\n\n**quality**: *eq, ge, gt, le, lt*\n\n**startDate**: *ge, gt*\n\n**saved**: *eq*\n\n**type**: *eq*","example":"(createdByName co \"int\")and (createdById sw \"2c9180907\")and (type eq \"COMMON\")and ((name co \"entt\")or (saved eq true))","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Succeeded. Returns a list of potential role summaries for a role mining session.
|
|
|
|
</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={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the potential role","example":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the potential role","example":"Potential Role - e0cc5d"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>potentialRoleRef</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Details about the potential role
|
|
|
|
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Id of the potential role","example":"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the potential role","example":"Potential Role - e0cc5d"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities in a potential role.","format":"int32","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of entitlements in a potential role.","format":"int32","example":15}}></SchemaItem><SchemaItem collapsible={false} name={"identityGroupStatus"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The status for this identity group which can be \"REQUESTED\" or \"OBTAINED\"","example":"OBTAINED"}}></SchemaItem><SchemaItem collapsible={false} name={"provisionState"} required={false} schemaName={"RoleMiningPotentialRoleProvisionState"} qualifierMessage={"**Possible values:** [`POTENTIAL`, `PENDING`, `COMPLETE`, `FAILED`]"} schema={{"description":"The status of provisioning for this potential role. Can be \"POTENTIAL\", \"PENDING\", \"FAILED\", or \"COMPLETE\".","example":"PENDING","type":"string","enum":["POTENTIAL","PENDING","COMPLETE","FAILED"],"title":"RoleMiningPotentialRoleProvisionState"}}></SchemaItem><SchemaItem collapsible={false} name={"roleId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned.","nullable":true,"example":"2a4be6fbcf3c4e66b95a0c15ffd591"}}></SchemaItem><SchemaItem collapsible={false} name={"density"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities.","format":"int32","example":90}}></SchemaItem><SchemaItem collapsible={false} name={"freshness"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles.","format":"int32","example":70}}></SchemaItem><SchemaItem collapsible={false} name={"quality"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness.","format":"int32","example":80}}></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={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><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={"[\n {\n \"id\": \"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923\",\n \"name\": \"Potential Role - e0cc5d\",\n \"potentialRoleRef\": {\n \"id\": \"e0cc5d7d-bf7f-4f81-b2af-8885b09d9923\",\n \"name\": \"Potential Role - e0cc5d\"\n },\n \"identityCount\": 25,\n \"entitlementCount\": 15,\n \"identityGroupStatus\": \"OBTAINED\",\n \"provisionState\": \"PENDING\",\n \"roleId\": \"2a4be6fbcf3c4e66b95a0c15ffd591\",\n \"density\": 90,\n \"freshness\": 70,\n \"quality\": 80,\n \"type\": \"SPECIALIZED\",\n \"session\": {\n \"id\": \"9f36f5e5-1e81-4eca-b087-548959d91c71\",\n \"name\": \"Saved RM Session - 07/10\",\n \"minNumIdentitiesInPotentialRole\": 20,\n \"pruneThreshold\": 5,\n \"saved\": true,\n \"scope\": {\n \"identityIds\": [],\n \"criteria\": \"source.name:DataScienceDataset\",\n \"attributeFilterCriteria\": {\n \"displayName\": {\n \"untranslated\": \"Location: Miami\"\n },\n \"ariaLabel\": {\n \"untranslated\": \"Location: Miami\"\n },\n \"data\": {\n \"displayName\": {\n \"translateKey\": \"IDN.IDENTITY_ATTRIBUTES.LOCATION\"\n },\n \"name\": \"location\",\n \"operator\": \"EQUALS\",\n \"values\": [\n \"Miami\"\n ]\n }\n }\n },\n \"type\": \"SPECIALIZED\",\n \"state\": \"CREATED\",\n \"scopingMethod\": \"MANUAL\"\n }\n }\n]"} 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={"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> |