mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
95 lines
42 KiB
Plaintext
95 lines
42 KiB
Plaintext
---
|
|
id: get-all-potential-role-summaries
|
|
sidebar_label: Retrieves all potential role summaries
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztHGlz2zb2r2DUD000oizJlq+ZnR3FVlp1fVWSt7trZ1KIhCS0FMgQZBytx/9933sAL11W3Ey3afUlsQjg4d0XAT5WglBEPJaB6nmV08pExB3fvwlioWLJ/X7gi0Eym/FICl2pVWI+0ZXTu0qv02M4xi6lkmpSeVereEK7kQwREsDpiziJlGbc91mYQmMRLtEpPBZPecxmPHan8KdgHxIRzVnIIz4TsYhwPy3cJJLxHPZ8rNxqEZ0FKhaf4k4ST+HZuyfYuLAAZ0ncnkDBegUj8FMHkQUYiQ+JjASQOua+FrBDPPdxyjiIZjAuPoV+4MGDOEpw1J2KGa+cPlbieUiQ4gjprdF8HsMTNwByHC0QjRgAPy2yYgCbs0joxI81SzQsJ2p1zJXHI4/puYr5J2YWjYTHpGJ3/9xnnZseG6STzgLfFy5CZDcZve9eTeM41Kd7e574KHyUZF1z6YeBVHEdENuTntrjodxLN3PcDI6T8+0b5A/g5VgsX9+rezUwz5jUILEwRA56DKgm5McAJnjA4bEUvqdPWbXqRgIZcA7/1Jj0UOTx/CxIVFxj9MMXM/jfPhnDXlMltK6B3LkPU6tV4j+fhSSQAjjg6Wq5jqVv5Vpm+Vt6/gdnukF+ke1v06fbMZ7BFsyYcBDpU4SQSeLNvOdVqyAa8aHG9EONuUF1YcIVILN6SoGhNKE0KBTJhQZ8kLYf24FMqhnQCQxPQN6laWp52zUzM93YBA4YHcUZQmZKOsQ/ipQJ9hFa8jPw3CAEFl+KeBosLNZAG7AEVCQW5ZFU4zsxuIhRYoeBZSWtflViPdDN7kGz4/vKa5Lkq4LogDEw2HJPmseNk8ZRNgXxZ+IDjJ1dX15eX2UDr1QGElAhmKA1r4gFuABd2uvXX84JPq0zy2A81iJesspregyWFgdGlxMIDkb3GQzU2a0GaftzpkPhStBvjz3IeAoqJmcyrjJYFvKJVMAgWB8FycTEDWs+dfBZQvzOVvyaLHMWRALoMjEBJtRXMTlTgsYKlsKuYiKiYmCBR/steDCDEDtLZrTOE2MOtMLfa5lPzFri/SU4O5XMRuAVg3HmGIGjEQXqr4Z3rfZv4N6MfzJ/E5SMl/BrLTddjFZL3OyNWRVto8pkDDpKOU6Y+EYxBav+yxkGMfcdinVVZHcYKC3YVHAPJEBajRNXSARToocg8T02ElY4GJ3GmRWgqVeNhVXZg0DmTRTw0KtT1JbKxXVAhqbwzUHIgAojQpjLFZuCP4DHIDViFs6Xs5C74AWBGog6kcCcBnw8bKyCGLVEC9y1SkD+RpRXESfC9iP3E2G4gLMB7USn2HwVOrXGy40CyFa5qhQ0hVY+YdKZilTjglajgf8tpH2J6woBPKyzL5EMIwkuJr+gjrAXD0NfukTc3i8aN3xcpoBHEUddlrGY6cLzYPQLMA4GwggZHUtDhvRWJboLmu+htiKCZUJKQU40XLftHXnOaHw0dg7Gx01n1OJj5/j4uD1qnHgnJ619zJONjT23JQXK5zfNahZTmDjMYIH7hMVypi/Gy8I6FzEoG0hoFCTx6p3+kryDjShxx4oORky1d7PITphVyvdXeuYyYsOS97Or0QwgD+cLqNZX+fVCRIDtF+uLz8agAOAFODTbBRZ8B5lJiAliop8X0NAUJTDXpvjgf1NAbIKQ2MNUgk9Azw2u9b7S7/542x0Mu+f3FUzv7ivXb4ad3hX+Lsk0fUwGEAUfZZa3Lqt/AQvgRTabyowUqwV+sLMUoZvrYfdq2Otc3Fdq+LN7dd67+s78eNvpXSBmNYMqJKw3F91h975SL+ufWZNbWcYtoTBe3+WbwLN8dgoP/jQ7YSPiGYW9KfMCuIP09Lax3/PMlFIYECHJjYPG9Ho/IpG986s6Y1eY2lKAXOIcxF9tA6VQRUjIEgXr+CgPSjmLWvxgJA7HI3e87x6Iw8PRSZs33GZ7PPbaJ03TdVCaWiVbqb6dzSC6RNJlrxpOs9F4bQhcIe3v5WQKlpKuopiPhuJhEAKazLCGFMXn2LBhfBaoiTa+NDfvzWZ00gAyshJyS0Ky+Z9JSr5ukZhVQoMnlFR4EtMqyDo+YqUFaRNkFJggiU/S5Fs4+xkyj5BMW9huSaSd/Zkkpqu2IRC1EqWYiRjzzIxHmwk6RoIMFYueheLJjKywsCPOrW+w9sFN9wxsvfcfsOiaLXPRtHNzKM9YNnn8a4jQn7CJSDX7GrdnBguZ1up4WUD3N6QAuGPuRqICc1Iki0SejPcPx23RdpoC0oAD4XJn1Dg+ctoHxydtSAWa7lFz+1ygQO23mpmuAK3c5HYGNK1/yQaWTw5rHO01G7gtYH6VzHqZcfdUydFuodqXpjjbOhPYhGqrsaSiFPkSJYZT1OPA97a0NlqELQazCu3bVjXo4REDfORy3zU1XxilbcSb8nYb0G2vwpaEsrkEMWCel6wJ55WFMgf3cINVhkowcGhBCln8f0ZZH7P8p+dhIx6sFaBjK5NTAz6JXFFHdTs95zEfuFJA4Yl/mk4RT7tmpv95li0FPKUOfU79MvwJ2V3Elfap2X5auQhMFXTKLiWfSeQiBCB+wUfC3266B0is2Cdb9g8xp+B/Ve+dYw4y/Pf7znDY7725HXYH9Yvrs86wB+7pKe/A2D2ArLQzC08hbetcDOCZ8cbo5gwK756enp73LQXePlvfpf25VXriQ5z6DBGX8rS7vBt52ORtzt1G8+iw1Wy7B4f8sOW1j2H2iimtViObc9ACgou6sY3bugcfziN3CilvutDUy8AlL3Gpen4Raesd3zMa+7RRZberv1fKx7wVyMl8MQV/DcNZWaDaWDUgT/eC1OT3y0xWl2P9ZVEzM3U9Ymf9bmdIW97enNu/LNt73cH7rBqE8ql/e9V9P/y+3x18f31xXhpKq6z3/esLWHXTvz7rDgam2FocTHcsUZ+jsV4sad1Ves2yooFmhjHnhXETfiEncJMoAlmtiUfr2HPZubql4rFzO7x+378sY52NbtSlHNeNapc3Nc/jYJsWinnBPq88GX0+WNVNPPMlEt2NIvAHju0omsaweQVCDV82Crw51ipSgbFI7yVNwzURyKMO2Rm9FnrOZb+VSjiTiEvEUBDKLiw0xa5HMqVaikCmyTDNK7cFgBP1JnvDIQG19J1ZYpCpEXd/BVjbVO63SsJ6li6BCJG9UF2xrTgSfHTYOGkdjA8POG8dHzSP2qOTMd/fb0DefUK5L8iaT8SqaFze+juhBJZs6Nt8+V9sGAgOvCcEaPPtG7QEY8tM38zNyLT4Mjw8UYO8+s3ZDTs4Yj5Xk4Se88kCE5RzO1iKL0C5AXwdyYlUq1BJLe68+7ZzezGEJ7ZjVakhrKWTIh2VFqYBVQDT4MFEc0PAA9SlWmCjHzvpVQu1CgRBlClOlOaXnmtgJrP5Mqywu69YUQQNpW4wK5mSa06asFeyLuo1KAB02p4fcaoElHnX03FdEcbOheVk1b7keV1nHc+TSCREFVuBz/gcKwnuecaXmbegYMqC3glh71kFsXRFWRY5KxejfepZLopCQeMAzJ/Xk44bJxjykMyiFWbaYlFMGwee5VwZu2GBacRSPFrhAhX0LtcNwF274JmANhlrZt0RnW4Ax6PSeZnHKjpMcneXBpnUmbo80VvY3Y0P7sch0rKBj8IaH735NN6IpJGKyXok+36aFttZmbhSwzfnL3a2u7Pdne1uabuLg337DtWOUurTXE59bhVPgL8RBc+l1Cci7VEBSydRemMFSa8dbIr0w09DMOxfhcL54lOI74K/YH5kQvkS8p1MHvaoWXoSLQ39uSwQQeKjoWAMnkh4p4R3jrFJEolV+8u7vQ2ikQQFVStSRPCaEZsHCePAsihRlDhzXWNeILT6NrbnAsAitDYeEHdVnmNewe8yyV0muYtGu2j0p4lGu0xyZ7s72/06bXdjJplhRdZi8yRte2ykaXYcqeUMJuQHNDOTI1EtZisIjGU5VqWcOVRGreaoOT5yxYHHD7zD/ZNxyz1s8fZR86g5OmgdVYqx/i6348zIyjZVkLeRo33NF32EPC5RoFw6DgKv3P5L8KbJGN0aup4sbwaeA0vfZblj62TFC8AgYJdczdMMSZdySJXzCH0azJ3h3CidSy9rJ+AXFR4slYE56iZneJgM78UwOr2KxotUANxo7nTG+KbDnom1SpbtIpXrJ4AheQI/wKw5AMWSeG5mjDkfQKAMdgLe+Qtmp1ZEvymTZ32k+AIpZt1P5hQoyzL39qr+bg+Qj9BHDIyA1zR6TbXDFSgAFATGZ2V55y4/3+Xnuxi/i/F/jhi/y893truz3a/Tdj8jP7fZ0Pr8HCZsnZ/D3HqDZbnUWzoy93un6WQqFgNSbxa4dGjBy3NwyivMsQe8co8+hOON9soeHmtwzLEGJzuV4tCp4goeZcXs0CCWRD4sSK9NPcJUkNNTnYeynh4XU8ED3Z0aAZNW+B88KGBsDSfQLS2zQZ04HElUYuPxCLjhtz2IWMmuZ22ErOwNlHmQgI8jMDU8ZGMVih7TQWo1/1bT7Dop0BJ9QNdt5D/9dloMoDW0rGLfxt1gPgNMF0hEEt7lny8YYOptdl/6iEEeTrBcay1tdo3TWuyN4BHUBeYNxqsffhq+ZhNMOMngzQV3IbFCAJO5ARUhh9ZJu/m4iGJMfmu2U3pfggbExj4QzOy1PXuud34Fnr4PrplYiosEeQNctf2lPV5at+aS3r1y2LmMzJ0+c3bPkmguMt6FKV28QNdLkfgmheYYaA5Bw0v4JSwMa+9cc/7GBSs2JqmJWy/e3MBzCvCwjIInCHURB+SExaP8lstNpfZiPErwHIRXxuNe/UTXj8rL0jNZeko3VXvMnQaBFn9nDFUHzeBukoAVvRgtuvPkkEU4rUYBJcds6UgHckPC7wIMQxllMrf3KDUJIGtTnjHJn0myYPM/06WGn0s00+M7CKE40wvcz7iJuoAzbujgho7xAdribyIUKhbYNtJAfsAowFkuf/IEFtGC3zOwVnp1Ar9Hayr2XDdB0eGp+XGaOzj7lznijbOzOeCGMbXO3vvhJVULC8NUiVlpU2CRg8v4+gFExwW+GXyzphRGzD8avUhxJ++dXCt//qW99BpP8sfxu/8nj7fzNH9GT2OTXVQ32tZWBUUlf2PzteVenqbPKcC/MEq2Snk1VC35FxSKgEKfx6jVZNXuVArqAoSCx5j71VCzghlZIhTsaP5Q6xGgCX10JQKUOdRtEu/MUZ863ZmTwZjEEuWKv3VCpQhdBJpCVSnq7CcozJQLYsGiDE9awNgvga3OBiCZGxQsO0+FDUnXbJYovGwHaCczxkGlntEIT2o3MY4LajQlUl4EsbmeaVelVoyqhiTQ7TURzfT1GBvMULsWBP/MXiB3bbvLwHqUoj2unxPSFz5pJs4rp+3PwQZtc6bCD7EsBK8LCZgo7HDZGy5BBGDKXs4IosmeXaT3cC4AwfLIqM9+vVlvOFQu0DcAdAyFbAE4voRAHdn8XYZFrXzM2+xf6iNnNrJgSbAXYjML8U1MiWLKwrvKprIQCo0pUIfTHh+x7YF10hM+Nh8zwWIR+I1GkH/9Yi1Ru8+VfcbnylaK7le695J/c872Kir0GbPtBbH7iNnuI2Z/pI+YbdD1/Dt8L9T1v9anwTZwMvt02gsZ+XV952sDI9LPmL2QD7svdH19X+jaoA3pZ9hybXiXd3XpQ7CQA5HoKNsxi8w7n8KqpVMRCCXrw3/XxWSTryn37R+41dPT/wC+M2YK
|
|
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-all-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-potential-roles"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Returns all potential role summaries that match the query parameters
|
|
|
|
## Request
|
|
|
|
<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, identityCount, entitlementCount, freshness, quality**","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, ge, gt, le, lt*\n\n**quality**: *eq, ge, gt, le, lt*\n\n**startDate**: *ge, gt*\n\n**saved**: *eq*\n\n**type**: *eq, ge, gt, le, lt*\n\n**scopingMethod**: *eq*\n\n**sessionState**: *eq*\n\n**identityAttribute**: *co*","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 all potential role summaries that match the query parameters.
|
|
|
|
</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> |