LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/get-account.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

106 lines
44 KiB
Plaintext
Raw Blame History

---
id: get-account
sidebar_label: Account Details
hide_title: true
hide_table_of_contents: true
api: eJztXFlz27YW/isY3ocmGUvWvr3cUWTZVStbqiQn0+tkXIgEJTQUyHKxo3r83+85ALhJ9JZkumT0YlMkcHB2fOdwuTNcj/k05K4YWUbPWLGwb5puJELjyAjpKjB6V4Y+ExgfjwyLBabPPZwAwy8DRsI1D0h/OiKhS3wWRr6AU4xYLKTcCYjt+oSSgIuVwwhVlMhyS3gYkNFJmZAPog9TPzFBbnm4JpPZ2XX/5Hx0QWgUrl2fhzA2AMp/RNxnFq5iUsdJli0DowEzIxwIzN4hT/7AFSH7HPaBAgrALdHTSwc9n1HL+HgPsnjUpxsWMj+QEzlK5FGYcmQIuAC/uIXUzTXbUKN3Z4RbD88GoQ/iGPdHRsyV0Qv9iO1qR+sNxQQy7DPdeA7OZ3a9Y3cb9UabdRvNVm3ZXC47jVqDNlv1btvqGMiczwLPFQELcOFapYL/ism7y9+ZGeISJooNpoOh1PMcbkrDHv8e4Pi7jCCgwIkthdYiKRpGVqIrpQTUk49OEnLFC+hkj5X5NgjZprRiAp0JrBQJ/kfEQHLi2tIdJvECeR1m1cKtaq3eaEomqDURzlap9T42x+6qF3D2BfQpjkermUA/ZAViDPACHBILrr+Acq1SbZYqzVKts6g2epV2r9r+HwwA199QsIaB5Eohh9ULZNu4Frd5ETtjGoREXTb/ar6AsZCHkspbGrCBu9m44iR0QX+PO03gRr7JRjJw5KHU+pFBQ+BvGYXgRPBDhzZIdYMXLR7QpcNwkuOan+SBkBdHFjg0hjaQk06WpqdImK7vM0faEvRIRQR+vR1kT65pMBRSkA3TGSzvzQm7e+GdU6TZrXYqnXrTqrFmtdUBvVr1mt3pVkxabXaqxm7oL8BAezGg1lKZK8mEzHHFKiBSs1mNPcrPEP67WyZ1ub8waNNz6JaITHw8vTbXmv5rdBGvlucIDlObar4yjtPbdz1qWRzXoc40Y9eibIxsxOukNGF9Cr99uLZa+Wyl/SYR986wuR+EyiTGHLa0qcul+zk0PR15nuuHypFR9bvDSTwC4yrv/KlMS9d1GBV7+hsJC+MfeOX2nrps390QKkiOqLZ2Vg6bOgFmmxzpfTPv7DAk8zu2HE0CUESOg2Eb6ztZDC/cZ6L6xTKynEdE4BEidLYkkyb2BNN541stlaShvYV28tKTSix0/3jNdMdcbrNxqnJdLu6azVq73ZRZIpcIiyTOM72nAeABDaacCf2JRACaEqYQh3FBYhEv3FuAaTBJEUtniWSG8sI882VkNZejv9LVhRvmswNywNP9Yc9SUcQLc9kL7EMDBLLM33CR2ii+qPFU1kiB44XlIEkH+Qi5L9ykvsJjYXeDJA7IOSb7Mv3sbo5fyQnL0sosp0XnmYjZt8Az94NcZkbrxttRo9Wq2I2m1apUW61q26K0W6tWmp1GCpBGJ8OLxWjxawrv+xbdkJ+ZANtu0Vt3N5c8VFBXd5k/WUyIvFIAxES0kfXTYDC5vFhcDyaz2XDcX4wmF3B8cTo6g0FwcTifX09nk9PReJiemA1/uRzOF9f9KVx61x+rK0gHj6bT8WggKcGvQf982h+dZQ+vgdhiOMMzw9lidJoZPL6c6yuTi4vhYDGZXc8HPw7P+3BKKmg8PB/KVc4m74azi/7FYHh9NptcTuFURofxYYb15JRmHk6NR6fDwa+D8fB6vugvcNC0P5+/n8xOrqcTkAEpzSZy9uxS/ptPMpfmk8vZAM8u+mfq7zVIMjybzH6VP+c/w1rzyzEuNRtOJ7NF+hsJvRtNxrHksRn6g8XonZIB+PhZifYxG8UZKWMQDNB3geaVjvx0UkkziXImjMbbNTfXyr99ZjPYaCBXyjqN5eIldulmq2M2a10TXbpjmrRlA8Sq1qt1I1MRPc7GjxFkhhJCe8xChcDwC/h7zx2HQ+TAf6wsd2uFWTz5JAtqJ7ew0xXHvouXnglU9xNAw2yanWa9wbrdBiQA1u0wZrfMdpPVmmxZqT6WAAoA2iELHLLAIQt8+yxgMxpGfq6Ie7DqUBeIwwNEfCKkXODvUOUKPFRZ4geof2KyufL4ov9WetEO/rrHxlrMZIyf4Syw1yjqsA1AaMgNQ993fVIiM9ndBCCiwQ+2PRiwuHQt2aPk4oY63HpRJ+7xZKOaqAPXeoaVTwGillY+lUiVSZZNmEiA4g23UGkb14/7srHd5bh8dxI0Ua6St9QCeZV8Ay0MWtin5iegVdwk2GkOK1AdTwGIJ5vBDyzL2owuW5VurWG3GpTWOo1qu7ns2rRer3Sb3S6uvmFBQFc5H6K+T7d7S59hWcVNrOLAIn+CQsD7QfeSAbk4TOFQpBT2FPI2kDSeoX/cydTYREzNL8Fe9BHUR28HU9JoE4eKVSTP09WOEkTpcl5UNyjCE5+veGHdHm8yJ8PTfpwHdfJFWnuN+z5UBgrLu3LnXbu3kmMtwC3A+YA5oA5mlckbTfUNCERFkB3I1S9V8YFv2TRyQpihVy+YkSWt6sZsKJmqcU9e8TIrH8HGjx1QGkJGWkJOsYirbi68geBlXlgaa02+IWvIbsx/XSb9pCFEIBqBKMzfAiFCLQtDVxGwI8wastJ1oxBLS26yvC1SVe72OeIMMs4aBYMDOH9GejNDqNWkT+SiMPEWzaK2D/CsNJfnbpFRmlTpFtKkCVKkZSDk8yXIhjdadDpCcwWQeEQ8LslY2ewt0925YkYmb2yZ0yh4RtxNHUg/JSlacuGG6eBD/KazkbRGbCadkeAiii0n61GJueLAJzZnjnWI3UPsHmL3mbG7e3Gm7yvqqxL6VPehz6XQHWXcPPegj89UQy5uO/+pbk8pQx4RUIiGSD+9X+ibuzCeffbwLtE3xEdqK9+/M5rYQ51fxugx3vpTWyCDUo9KAhsyEbN6ku+UY6kopar6/mqnrr/k4KCiACLKvurWjeQdBj8SErzS4IhYLgvED9g4u5FdNOBXZUBcVVglD6vSA5I8IMnDbnTYjb6f3eiAJA+xe4jdf2fsPookE65ktGicFESbDfW3ytP0dZSWEhhA4ifcSBJy0lS7aAWJkQRjGXnkYCxr1WXVbpusYdGG1ap37ZrZqtFmu9quLhu1tpHd66/SOE6CLB9TGXsrO0oVA4i7ARwXCXCuIHRdK9/+A/X6zMa0Jm+6xrgZdA4q/Zhix0bBI2xuCLIBYcCO/gPtxcvZWLViFXnUm7pHgkGr+7b4EAtCSnmTnH3mQXiAjgfoeNh+DtvPd7P9HKDjIXYPsfvvjN0XQcfGU9Cx8QLo2CAIsWyEWH8ndLQAdyA0s8EoIIN+zhTk8EAUONLdRx32IfVXLEyAXg5F1roFD9G4LjmnYhuDpSDXiRSpujC9wdgNjvXjsTCAkhWkSEEga3FAt+hVfMMQk+ILBw7fcBnHKBDQ9belvh2CVCpmYn9LVuHCdCLgUCYFfHJHPldAOT7IYyP8AwqyD7qCRP0Ne5zaWl/VDyYzlHiMEpPhZ5MxjPmk/9ssekpgBMz7mC7mytYPPC6geuZUQBnBPnsqfSUQ9ADVD1D9sN0ftvvvY7s/QPVD7B5i998Zuy+A6hoNPQzVYcCzoTqMLVdIgqVO0bn+csQuQ0VzIN2buKbE6laKwSWuAFfSr8tjDsF3xnvGcfyK+fEdt+4NfC0d8aBiJfIdGLIOQy/oHR/fgYXAMvdl6vFy/OqLcG/Lprs5vqkX5Bv1yhX6CmQsKzJlvYBv3atFylKvPkfXVXlOLqC0LCVBJwVte/rtxYfpx48Fb6H2IIrMET7brt1IngY2Paghfgjk6LJ0mz0ZQbZL37l/Sp539cfkUEQekKNIfY+uBeMJcLkjnqEeDI6/IjBHsK1W3/uWQLqBYJu/trfYBIfVyFtGfagE1JMvr356v3idedMvwo8hEMaxJoAgmYKLyBTWj58CwUlyV/HdaLWWjPdzz9lgyBDbwffyPog5Y+Qq864emUEylirFSUzGP876+Cq2jMVumIPbXjnVJDoet8QxaOiY5ua9llucrAW4UK+Ow9nyB1EiJxwzD8etGsdoEWVpR668WC6aketLmfhPTK2kqJUkteD1DhdKtVemem7bhLhFEhQ/QwHa+uLFFb1Shh4WTnAGqe7ygJrQfOSfjjJjq30xHzl6JaSX5+ODeC+f3s9PIypdkQC2P8ciI2KuXTdg/yUEXQfD4GoVQRR9MVvylYGSjIhSrZJhqaSWLPESoEHJ3xgCQyhnokvcjSUYcVVfRIbkb9KyEPO/Qa1skd9yMsvTV7Bp4kjLNYMv5hkXLOGCJZUDAs2//mwJMAuxjTLIPKAcYJDaX2YCzWgm5ylahVldkj+Wc3BrMIFV9QECr6d+9NIEp4+IvICjkzGQghFMJ8+L4ZdQNK3Mq+VKWXEbYFeD+/w6LuyHO3pT/CY3M3GP/KfJixL3024Jfr3iW2fpBzLJPyfv/k0Z75BpvsdMo+EtuptcVtcBWSdXaG2/dyc/BMXgL1yVkSpxNFQp6qtOiGGyZDyHhujTMqbNNWey6vcYDRH5HaFfuRsZhwB3MfihtpOEVvLbPT4wTKFO4w7QK5P3UFYJwN4+llT4tC1Q/d3VtVX6judJbDiCn7OJBL5uDkxEG0LBPZ6wrsUDM1JJCCoswWLJXAnjkllxRKLboCrKsrjwN8HExvYwVJ4ZIz6xFtgw0L1hUCRaRL+2mgoyw1fjMRHAuDz8foo2eE5pzRwPizrIoACmWGaF89FijyIQE/qGhOuvjvWk4BjHAhEsdZQz1MtQyuEpzw1CqEAzdONvVp0o59/1o7u0Ef5P+baY3kmwBDj2sF0lP2uhShJV+F0ZceEHw3vcwrdI1yA5Xrm7w14GlkH3eBpqeCyUrz6mVY6sDtMvpRR9sCOrlVczzexrkv+8WCGfcfNNbNO624DDTwzLdWAVilpgVvZTJCPqguq4ZKbs3ZPAeimpgs+G6Cz0ga1XH4DQkFz+DxyABLA=
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 'Account Details' (get-account)"
---
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"}>Account Details</h1>
<MethodEndpoint method={"get"} path={"/accounts/{id}"}></MethodEndpoint>
Use this API to return the details for a single account by its ID.
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"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"Account ID.","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
Account object.
</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={"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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\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}"} 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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><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>
Reference in New Issue View Git Blame Copy Permalink