mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
94 lines
42 KiB
Plaintext
94 lines
42 KiB
Plaintext
---
|
|
id: list-accounts
|
|
sidebar_label: Accounts List
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXHtz2kgS/ypTuj92QwEGDH5QdXVFMPayaxsOcHJ7Tso7SANoI0ZEI9lhXf7u190zeiHsOI/LbfbYqo2FNNPTz990z2h0b/krEfDQ9WXfsdqW56qwY9t+JENlla2Qz5XVvraSW2/LliOUHbgr7AIdJgtXsUCEUSAV4wz7M3/GuOlQZeyN7LDQfycku3PDBRuMzm46Jxf9S8ajcOEHbrhmROJ95AbCgabM5p7HQiTcGfarwIYSdoQNgZV760qJoOvLUHwIO0AB2XMd2Y5HbAeCO9bbB+B0xQO+FKEIFHV0kd/3kQjWQFLCE5J36YbWplAX/AOT0XIqApQlECryQoWcaUGrb+RYCHb9ah8ZZOOQS4cHDuv6nidspMGGydBvf1yE4Uq19/YccSs8VHdVcddb+a4Mq7a/3APu9/jK3VOGTsVO6FRSEV6wmR+wpR8I5kq4XJLRUDux6qz2jHtKlC3xgS9XHojXaNVAefZCLLnVvrfC9QplhnHFXATQU5PRt/YbcGPpSncZLa029FvyD/qaqDhixkEL9Ovhobxdm/5spkRRnQO6DWyDBsOFYLMI7Ku1yuBBlV2pCEy+ZmolbHfmgheQq5TIOiVU/IrPXclDAf0DP5oviI4xzHdjji8wRqL+x5VP7l/QfX/GSmEQiRJzQ9AqKH7lryJPq1Kw0r8qEz/kXqWLvUuo0pUvlWALiCJwf7IDNtwSDgsOFP3Ic9hUmMgAy7mzxG6gP1bSPlFidwJVNZegMQcsBjZzpS0o7oUKXTkH9AiRFUaCAAhItuC3Am6DjUg52N5drrgdllEaQg2w2FJIBwaWfoieogSOWiIifyfJS8gTcXvLvUhoLWBrYDtSMTffhQehPFucaOr7nuDSyvgJ9XzUV2auR7C4hZYKAzCG9ZAZFfBVyBDwt+8w8Z69sRr2cf2odtSC/xv1Vm1Ww1/H+86Uz5rNRq3+xir44SmNmDhPpNDi6FixkphayxBwV3eboifJb2yRv2m1AGcVw+cLdI3T+C56nIpWKz8IgT20HqEZkPLv8DEgl+cocns9q/qBaiOFUsl1SqU2K4n34LmyzNRdKb4fa3b7c7TXY09C91b0Tf/tbZQfBbZ4jHYkbT8IBGJB3GKDq+q24YsO+piXKVQUeVnBox9zuwwMYmTzihJoH+Bw0yPLNMimm41hyD+5k6FWNl1srO89z8HAHGChMkMFlJkN+Q60LgOSODR3gpGM2cFkiXul11XdN+s9ZRZFeBcglibibuIXmW7aFyxMrOJZQqEBG7Ua/snb4TyfBzJ/+jtoAl3BxtQNJirowlcrz7UJ9vZ+V9jvvugYPAg4+pQbiiWNBwwOZpTQmRaads7LrrULYg4YoKVCV/PqOkVWx2sFpCtzIQU5GoukC47M+icoABpgEA+w6atZf6w39pstYoI7A+mtNVg/xMGwOeol3P0E+hzbYwgYcxcJdvEBuqyDc/vzKQNctyq1VqVxNKk327XDdv3w39kwRHKV0KVYK8gW+9wWB+DgAPqx/a35AsbAY4nKS65EF4DElyehbyFQPeU0ceDgvEiXlxpjeAj8TaNQoAPHZQtFEAKQq/jUE9jJ8+13dJEPLyRHTmbKKPidxV5M9QqBBzcXXPUkCQIZjq698t6csLsFRjOK1JP1fstpiFb94Aj06uw3ZkfHNZvXW0f1AoZOwECFGNBj6aosDuopwKCcY2GEnpnR2JP89OCvvxaky+LAoM2Vx9cEbs8fO8W5b6GLeLQ8R3CZ2tTwlXGcdtH1uOO4OA73hhm76hyvyEY8TkpTJ7UcEkg+nwdibvwmEfce8rxAhdok1hgmqyFOVuioPL2t5xvtyKj6zeYsboFxlXf+7RlorvyQDsY/8Eo5eF5ds8BfQrbEckSNtbNymCQjT7po5vzIHZb5HVuOJwEooQbFsI31nQyGDx4yUf3JMoqcR0TgETKE2jYDEwXBDG58raESGCoMtIFLH1XiVvePx0xnzOk6G6ca63Jx12o1Dg9bhBI5INwmcZ7pLfUsGUw7E/oT1nBBwhQWrJDTxSJe+ndVxqCTJpb2kkkP7YV55qvIag6jv9DVsdzMoQNy4KbzQ8FSmJB9oX24ghCAlHPpytRG8UOTZ2WNpLxVWFUJHOQj5GHrJPUFHguzG4C4kEnS+Wn62Zwcv5ATkaW1UXBn5pdinjN5/nyQQ2a0bjwdNQ8OarNmyzmo1Q8O6ocO58eNeq111EwTpP5J73LSn/yaFlcdhy/ZL0KCbdforZuTSz5V0E83mT+ZDBg92ZKISVx5urY63e7g6nJy0x2MRr3zzqQ/uITry9P+GTSCh73x+GY4Gpz2z3vpjVHvn1e98eSmM4RHrzrn+gnSwavh8LzfJUrwq9u5GHb6Z9nLGyA26Y3wTm806Z9mGp9fjc2TweVlrzsZjG7G3Z96Fx24RQo67130aJSzwave6LJz2e3dnI0GV0O4ldFhfJlhPbllmIdb5/3TXvfX7nnvZjzpTLDRsDMevx6MTm6GA5ABKY0G1Ht0RX/Gg8yj8eBq1MW7k86Z/vcGJOmdDUa/0s/xLzDW+Oochxr1hoPRJP2NhF71B+ex5LEZOt1J/5WWAfj4RYv2NhvFGSnjJBhS3wmalxz546CSIol2JozGu4VrL7R/B2ImYKIBrKT6TeTiJVkaOjiyW41jG136yLb5wQxSrPp+fd/KVERPs/FTBMhQwdQeUWhrYvgZ/L12Pc+FyIG/WHFu1gqjuPNJNqkd3MFMtz32fXz0zES1CABNu2Uftfab4vi4CQAgjo+EmB3Yhy3RaIlprf4UAGxJ0HYosEOBHQp8fRSYCR5GQa6Ie7Tq0A/0RiiudXFXxquQgBV4qVHiB6h/YrK58viy85K8aCP/esCFt5jJOH9+wP/KVnPbElwXpAZw6AWBH7AKG2U2aPTmGW28sKnv0AasK2+55zq4//CpS3SPoA0knwBRXd95hplPIUetzANOqaoglm3oyIDireug1mijRJOMDU/tqjntgSaqdfaSOyCvlq9rhEETB9x+B7S2rxLkGbrSWXXcBXK8ZD12y7DiUPDpQe240ZwdNDlvHDXrh63p8Yzv79eOW8fHOPpSKMXnOSeK1zbzQ59hXeXaWMaBRf4AhYD7g+6JARrcyiyHPm0DovEM/eNUptsmYhp+GW60l6FAetkdsuYh87icR3SfzzeUICtX422FgyY8CNy5u7Vwj2eZk95pJwZCg75Iq/DOQQdKA53M+zT1Lvw74tgIcAf5vBK48i6cKisZqiUQiEuVbejqX7rkY2brDHqY0bf0yJLWhWM2lGz9VgL70a2KahlmflwC5SFA0hRAxWFgQtpzhegVq7BybjRZMputL6qsk6wI6b1KBf3XuE/JHUdvVuj9c4QNKnX9KMTa0rVF3hapKjcXOmIIOc8aBYMDOH8GvtkhFGvkE7koTLzFsGjsAzxrzeW5m2SURirFXRkbpEjrQAD0KcjmhooZOKLNEQAeGbdLECsL3wR3F5oZQm9cM+eRekbcDT2AnwqJljy4FSb46PUPjUZkjdhMBpHMmw3U2bRKzBUHvt6+2cXuLnZ3sfvM2N18ODIbj+YppT71YupzJc2SMk6ehdQnEHpFLl53/kPvT2lDlhkoxKRIP7+emDfXoL34sMJtoq+YH+mpvMB8J7GH2aWO08d46k9tgQySHrUEM0Ai4bSJ75RjnSSSqvaLo536wdQFB5VbUkRaWF37EW0xBJGk7JWrMnN8oeQPoXk/ByJCKY2AOKp0KnpPfJdJ7jLJ3Wy0m43+MrPRLpPcxe4udr/P2H0yk0y4omgxeZKKlkserLWnmef0ShuDBumL0knIkak2sxUkxpIcy8pnDta0UZ/WZ4e2aDq86RzsH88a9kGDtw7rh/Vps3FoZef66zSOkyDLx1TG3tqOpGJI4m4hj4skOJcKfd/JL/9F+L7kDGGNdl3jvBl0Dip9m+SOjeMt+x++zy64XMcZksrlkDLVEWIatF1i2yBuCw04mwMuSnzB2wW+0JXcpQAq+FoBo7fIMXhRCqAbrCudGb5EbN5NN06WjOJK24uAQ0IC3HShJWHu4h7MDHM+oEAZ7BzQ+Stmp8ZEX5TJsxFKfI4Ss94HWwgM9CRzb21b3+0D8wFixFgb+JGFXl3tcAkOAAWBxqwk79zl57v8fDfH7+b4v8Ycv8vPd7G7i93vM3Y/IT832dDj+Tk0eHZ+Dm2rNZbkUqd0eu5bp+kUKoYDcm/m2/Q6r5Pm4JRXgCshQ3M6ZLviePrZ2uPpeW2d62suosCDp/GhpXswDhjlocpXbjV+YVH6d3Ry6XZ/C9ToF2XRTQCsnEifh8JzUnqQKqk0cNFrNcTRAFrB5hCilRyQepJ+/DLH2o8A1IhMGd9IMh5Et4HNFZQPPyhqXSWPKcgIsl0F3sPH5DHnvR6RQxN5RI5t6ntyLGjPgMsN8Sz9Okd8rn2MebYevXC6PZ07sDZrFAYbYLMGeyl4AEWA3q748efXkxeZ97P1QTjhYjkA8TEEFyH06sRL99iJJpT0cHUntzmC0cJmHr5Nbc7KZt6wZiPAYVIpdhIU+tjr+UfmeK7fIydj38gKO3EDfaJOURsjoj49fL2K5eIZuT6Xib/F1CqaWoWo4XG9HBdatde2ftnGhpBFEtxTpK3PHlzTq2ToYc0Ed5DqJg+oCcNHfkvLjq322Xzk6FWQXp6PN/I1vXOV78Y0UjG1oOPhfWYvfF+JfzCGroNhcD2PIIo+my160atCEVFp1DIsVfSQFbcCiSDxdw6BIbUz8SlOxJSH+JCiSUeH5G9kWYj53+jo7m85men2NcyX2NLx7U84B7rBMw5YwQErGgOU4V9PR+hYENsoA+GAdoBuan9CAsNoBvM0ra2oTuT3qA9ODTawqo+Nrdr6RzsFOHPF6AG2TtoABGMenWzy4bc5DK3MgSCtrHgFYFODRX49H6bCDb1pfpMVKJwe/2zyosSddKEEzxx+bZR+BEn+PLj7P0K8HdL8FZHGZLbobjSsKQGyTq6zteKynaIvmMC/8JQilVJoKFDSj5Zkyaw8HqJPU0zbC1dQwb8SPMTMr4x+5S8pDiHdxeCHso4IzenEdQAMcyjRXA/PwrPXUFFJSLsDrKbwFQmg+rtvyqr0zfyT2HAMDyFHEg8JARPRknFwj49Y13GVHWkQguJKilgyn9K4pFcckeg2qIoq1RXBUg1muDIMRWfGiB8ZC2wYn9EHRaJFzGGDVJARHmhCIIB2+fT7Y7TBcyoL4a2wngMEhWRKZEa46E8KFIGY1G9LV/1gvmc6qT1sC0Sw1NHOsF+FKg5vrXwVQvGZoRt/uorhJwk2veg+XQH/Nl+yMrMEpvd7K1yFooOGutzQ9dy1xTMf21qAPHjv/h4XJ7C4ecDb+kMbWOWl51S3HZfMyvd9fdRqq6LeCSz34292mYLeomP9z9fD/9fXqJ7QY/K1rs9U5O7TUt/fp6WecIf4ZPxnesPuA09/oQ88PeEm6afDPtNRdp9o+m9/oulJ+6Uf5Urt9zZdAoWk4i0eryeMpgxDd9O7IZlehfcFkEqyQn3Ww2yOP1Ibmwsc6uHhP1XhTf8=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'Accounts List' (list-accounts)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Accounts List</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/accounts"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This returns a list of accounts.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
|
|
## 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":"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":"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":"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><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"example":"identityId eq \"2c9180858082150f0180893dbaf44201\"","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**id**: *eq, in, sw*\n\n**identityId**: *eq, in, sw*\n\n**name**: *eq, in, sw*\n\n**nativeIdentity**: *eq, in, sw*\n\n**sourceId**: *eq, in, sw*\n\n**uncorrelated**: *eq*\n\n**identity.name**: *eq, in, sw*","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"id,name","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: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, identity.name**"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of account objects
|
|
|
|
</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={{"description":"System-generated unique ID of the Object","type":"string","example":"id12345","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the Object","type":"string","example":"aName"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the Object","type":"string","example":"2015-05-28T14:07:17Z","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the source this account belongs to"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Employees","description":"The display name of the source this account belongs to"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c9180835d2e5168015d32f890ca1581","description":"The unique ID of the identity this account is correlated to"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The account attributes that are aggregated
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"The account attributes that are aggregated","example":{"firstName":"SailPoint","lastName":"Support","displayName":"SailPoint Support"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"authoritative"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if this account is from an authoritative source","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A description of the account","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={false} name={"disabled"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the account is currently disabled","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"locked"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the account is currently locked","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the account generated by the source system","example":"552775"}}></SchemaItem><SchemaItem collapsible={false} name={"systemAccount"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"If true, this is a user account within IdentityNow. If false, this is an account from a source system."}}></SchemaItem><SchemaItem collapsible={false} name={"uncorrelated"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if this account is not correlated to an identity","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"uuid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the account as determined by the account schema","example":"slpt.support","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"manuallyCorrelated"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the account has been manually correlated to an identity","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasEntitlements"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if the account has entitlements","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"}>identity</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The identity this account is correlated to
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></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"}>sourceOwner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The owner of the source this account belongs to
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"description":"DTO type","type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the object to which this reference applies","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the object to which this reference applies","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"features"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string list containing the owning source's features","example":"ENABLE","nullable":true}}></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\": \"id12345\",\n \"name\": \"aName\",\n \"created\": \"2015-05-28T14:07:17Z\",\n \"modified\": \"2015-05-28T14:07:17Z\",\n \"sourceId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"sourceName\": \"Employees\",\n \"identityId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"attributes\": {\n \"firstName\": \"SailPoint\",\n \"lastName\": \"Support\",\n \"displayName\": \"SailPoint Support\"\n },\n \"authoritative\": false,\n \"description\": null,\n \"disabled\": false,\n \"locked\": false,\n \"nativeIdentity\": \"552775\",\n \"systemAccount\": false,\n \"uncorrelated\": false,\n \"uuid\": \"slpt.support\",\n \"manuallyCorrelated\": false,\n \"hasEntitlements\": true,\n \"identity\": {\n \"id\": \"2c918084660f45d6016617daa9210584\",\n \"type\": \"IDENTITY\",\n \"name\": \"Adam Kennedy\"\n },\n \"sourceOwner\": {\n \"id\": \"4c5c8534e99445de98eef6c75e25eb01\",\n \"type\": \"IDENTITY\",\n \"name\": \"SailPoint Support\"\n },\n \"features\": \"ENABLE\"\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"}><p> An example of a 403 response object</p><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"}><p> An example of a 500 response object</p><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> |