LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-11 04:19:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/beta/list-non-employee-requests.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

93 lines
43 KiB
Plaintext
Raw Blame History

---
id: list-non-employee-requests
sidebar_label: List Non-Employee Requests
hide_title: true
hide_table_of_contents: true
api: eJztPGuT2kiSf6VC+2HGRIvm2Q8iLm4xTfuYxQ0HtH1zbUdPIRVQM0LFqKSxOUf/98vMKgkJ6Id7emfHszgctlBV5TuzMuuhL45aiYjHUoU932k5gdTxlQq7y1Wg1kKMxK+J0LF2jhwtvCSS8dpp3XxxrrWIOiqMxee4ncQLeOdIP2yFIli2IsF95+PdxyMn5nONTQDQTSGyvpwJb+0Fgr3lIZ+LpQhjBzr7QnuRXCElQMdkITWbi1gzzpAmpmYsBDAiBRNZyspA2opHfCliEWkiTiIAaI3W0BZCC/G1lLGzjeUt/8zCZDkVEcKPhE4CwBgreIyTKCx/CMeA6uZdnbWHPTaOeejzyGcdFQTCQxhsmKH++P0ijle6dXzsi99EgGItay6DlZJhXPbU8hgkdMxX8lhbOK6XwXE3LLxiMxWxpYoEkyE8Lkk5yCayLCMBaprxQIsjR3zmIA5gr9asgIK8hVhyp/XFidcr5BnwirmIYKQBY17Va/BiKUO5TJZOC8Yt+WfzTFB8MeMgBfp1d3e0X5pqNtNiV5wDeg1kgwTjhWCzJAisVBk0lNm1TngQrJleCU/OpPDZJxkvWIm0U0LBr/hchjwWMD5SyXxBcKxivhl1/A5lZOK/X/ieSsJd2fdmrBRHiSgxGYNUQfArtUoCI0rBSv/jTlTMA7eDo0so0pUKtWAL8FYwf9IDdtzjDgsOEFUS+GwqrGeA5uQs0xvIj5WMTZTYJ4GimocgMR80BjqToZf5qwzn4NExksKIEebxkC34bwJeg45IONhfLlfci4+QG4gEkQCNQaTwAXGoYrQULRBriYD8B3FeQpqI2t94kAgjBewNZCc6peabsCDkZ48RTZUKBA+dnJ3QyHttxUpd+C4gLmC8B4OOI1CRc5ejxQFIu+EZmPEhcsOEQOx9Wqil9VXCyD5xzZZgWmVWWqJRhr70wBg1dYKZJILBqJWo7NxHvFYRxfQ9grqP7px3ocFwVwtUBAigyBJfrSIFVgIWECf6aCYjmPb4HkbHQEPmCYlG80UGUo0zvQ5jmETMoCm6RfgHm9ffUExAl2upfEVWbt6h6+hktUJB+qQnCssARn3CZgjBga9b6EYwa0OfI7YlGZaJ5ogFPH0C2cvgiK0WKoRf3CMnNE1AbBRfACzoFfr4UCrdq+GZDL5WwwU1apVEnuj5TPzKPjg177x6Vjlrnpx5zdq5d1KpwpPHT2bnFa9ar9Y/ODvqvSQC/uQKNlLaVvFl+vZpSqYgbXI9FekWQiiVUvmVSmAD4ldQ1EdUhZkaNAq/Vqngf0Wp9R9IyJia/gwsUF7mYYYIcxUAALMKMAAAgOOfNUL5sqtiHkUcrUPGYknYIVkYzCinsz0McEz5IuQlloZK6T8YCq6vexc7qi8kpUYQENKQ7FyYqNQr9ZOzmtsUDe42GrNTd+p7NffEEyfVaq3ZOPeqaJGpHPdRsR1PCBGYLNdaeRKdLp18QY8FiRqoRYoes3GkxjjXEynBzs+kZSRiMGfEWID8RMS5l8/EvwvIgYnQgTmJmnNljOnZB7uiUPSwMeXC2ePMjNIJdjMd2vEk2SLBmJBIvixryJoWKLfNvPMoory5fqdNWN6D4r1BgcDTcP3VsHHgHtDjlGqK/l8NlUY9II+/2/cYGRELTS5fjYVGFbE0sz8IdklFZ/Q4YExxUlX2LjDcccwrZU7TlIVGmLrqXZP9DvMfwlUk52cOBPpKkKdum2iOrEOoO4S63xvqHJ/HfJ9Ncd+XCIUHw4J17eRaRX7aMTRME6gpp4GaHk/5nPINXmAAE/oswe6lU/n+DCLtxnDKz3IXm0oAnfclBv9kHymSBeCKdlkV9bOzqVsVzabbmFa4y6dNzz07P51Va5VGtXnubURgQs32pDGDIhmrXLtQkjOKng0uG+bvYdK07rIpQlxKuHHanc7g+mpy2xmMRt1+e9IbXMHz1WXvDXSCxu54fDscDS57/e7mxaj739fd8eS2PYSmd+2+aUE4+DQc9nsdggS/Ou23w3bvTf7xFoBNuiN80x1Nepe5zv3rsW0ZXF11O5PB6Hbc+a/u2za86l5NepN+922XsLwZvOuOrtpXne7tm9HgegivehfU5cfcY4707JUlHl71e5fdzo+dfvd2PGlPsNOwPR6/H4wubocD4AEhjQY0enRN/40Huabx4HrUwbeT9hvz7y1w0n0zGP1IP8f/AFzj6z6iGnWHg9Fk8xsBvesN+innqRranUnvneEB6PiHYW1n2bMdMtSfXZFFD0HzQBVr/HExGeRzfQwgUI5gl9RsrtQnXGWIYAqPEi9Ooq1AkhNlGjwuYjVBGwKT3e84WwtN6ey35RZNCM+VatOv12ZnEKF5tXlWtSG83vRrohCwUiCZJ7wHVnpUpL9k+lUgMIaOZduaD1Gm0n3Qlcgbuhek7h/Aeulx2L266F2hgVwN0ADaFz+SL4Dl9vvQY0e5XQAHsW0FBRbSaivNvUVUFoC0IW4juXaR6hwfg8gv5DVmJW9HZCkApqh/TkLVuyPHLLPFj0vedtwEcYCF6ZXyaWH3wQAMs5JwY7lnueX9QoQ7y0iUj6aAt3KESvXcrZy5tfqketZq1lrN83L1pPa/SIpd0nhJSizIh2hoVFr1Zvn0FGnYP0O3c1Pja66NY/xVjPE59pMuUkYWAIgVO+Ha0Ysqz0AWwTq12B1F1ipupe7WGpNqtQV/G9VytQ66bbYqFcp907WtZ5JVyDGMmEkGBJfhuHsJqlRa9HdDjF1de2FScFF9LyFVIqS5h5A/3OUf0dIf5/cPEnJHO6C77m+nLOyAjt/Yt8DWCSQqoxtFkBG7bJTbc8mTNlX+Glf/ZEiF6XOW3O5JLn2qdzrKf8IcfClD4c4jLpFCQSR7MJChi0kfIwvtfRiQaUpD/YryBEmUq+w195kVEetYZjCORtz7BWA9pfC8DiWMZ+kQSA2yymIPWnEq+PSkcl5rzE4anNfOGtXT5vR8xuv1ynnz/JxMXGgNlXw+LqclSRH1GxGKSHosUB5o5P9AIGA5IHsigJA/vYohGE+QPy5UmL4Zm5ZehvvzR1Ceve4MWeMUvCqcJ/Sez7eEELrXY3gTJkHAp+kOFC4iEeBBJOdyb72bzkoX3ct2mhDbLBxh7Utw7VaQok3GBeSr8YYBdDYtcA0cvI2VLNQSMMRDne8ozS+91lih2d0wGGGx7xmRB81m0dZ2lWcOM7DvZVmUj9gU30Go8BZsClO0z5QJCqW254lV7PatJEt2//RVmbWzktpsP+Lyzxq3HqHWNtsGZkscc3LK3FUS4+6k3K71N6IsamMTTfp5paBzAOWP20kbygEgjtjMe2FmLZbEdKvOt5IrUjfZCo20P+IBF7Sx76koAgmzKfAmY81sOKItCgg8Ydovi1j5HInC3VtDDBQl1ObxRD/B74YBhB+XWMsafhPW+ehEh4lGpI1UTTYi2RqcBttembpSxzebKAffPfjuwXef6LvbjSO7rWhbKfWp7qY+1yFPQL4RTZ47qU9E1hMqlnYy6yRGkUdQ0qYp0g/vJ+DYv0AuB/3F5xXuLb9gfmSm8h3i25k+7H5xWlelU/9GF0ggydFwMINIJPwW0b2h2CSJJKr6LrZLFU0lGGi4J0XEkxVsrRLGQWRREoZ08EYfMV8JHX4X2yM34BFamwiIWEPfNbvTh0zykEkeZqPDbPSXmY0OmeTBdw+++2367oOZZEYVeYvNk3SyXPJobSzNtpsTHNBhc/Y5czlS1Xa2gsBYlmM5xczBmdaq0+rs1BMNnzf8k/r5rOad1HjztHpanTZqp05+rr/Z+HHmZEWfyunb6JFETKdLIpaEYFw6VsovLv8leDR1hmENQ0+WN4PMQaQfs9yxdr6bO06UwvsX6zRD0oUcMtzICGMa9F1i3/TOBXbgbA5xMcQz2xLoQlOSSwFQ8LQto4Ph6LzIBcCN1m57hict7XFzma6xWiwy9IIEKKRIECjMmhUYlsSz2zPM+QACZbBziM4vmJ1aFf2uTJ6NkOM+csy6nz0h0NGzzL25b323B8RHGCPGRsH3LPSaaoeHYABQEJiYleWdh/z8kJ8f5vjDHP/XmOMP+fnBdw+++2367lfk5zYbuj8/hw5Pzs+hb7nCslzqki7E/dFpOrmKpYDMmymPrrf5mxyc8gowJSRoTvdmVxwvTTvH+fM2bppeO3jZGvNCQ1ISBdA1vUv0BTQFGror85Usp4feQvWJLhRNQTx7Ig8eETBehh3o6pJBUCbZRhLN18Q6Am4kbS8YOtmdpQch0+FqUOFaJRDdCMwRHly0pkSv8QQO1BHfaXu74I7uLW7xB3xdR8Hd7+fFALqHl33iexAb9GdA6RaL9phHejd+jEm3wb5zQ34zkWChVttBNsBuNfZa8AgqArN38f0P7yev2BxTTXJ1cz9NSKwNwFmGYCIUytrpOj4Ootllc3m6XdgpQddhswAYZvYubP7k6AiCMokUBwmKAzjq6TfZeGHcPTdfP4Quu5CRueimqY9l0dwOvlmlfPEcX88l4m8pNNdAcwka3qErUGFEe+OZkzce+C+C4IEmaT0buYHn5uBhAQVvEOo2DSgJS0dxf8tLtfZsOgrwXIRXpOND+H4hYR4tDmMmbDG9oOvfPeYtlNLiPxlD00E3uJkn4EXPJusTInXJI9xaJUeSa1C60oWskOjrg2OExpj4FGdlSkoU5Guhb1zyJ9Is+PxPdNnxpwLP9PoGJk/s6SvvK65nbtGMCF1E6JoYoC39Zm5Cw8KTZsADxQFjAJ2N/ikSWEJzcc/A2hvVCfwxjcGpwQNSCYpetcyP1ibA2SdGDdg76wNhGJPqbMcPfjMLiw6g5oWVLgdsS3CX3kDBvLglN0NvthyFc+WfjV/kuL1ZNRmEwfqlo/Q9keTPE3f/RRHvEGn+ipHGprloboR2654HGvlrm6/truJp+kYJ/Aut5KuUUUO9svksSR7QKuAxWjV5tbeQgur/leAx5n5HaFlqSZ4IpTq6P1R5BGhOx3gjIJlDxSYDgEcr1ClmTg5jEkvUK/7WCRUhiMtbQD0pyuw9lGShB2rBcgzPWEDbz8rWZWPQzBAVyy5SZUPStVwmof1URrJkHEzqEYvwpfYSE7igOgtFKgtFqV82KvViNDVkoUyFSbTUgxkuLUu8Ueo8ERfoXdt1ZRA9atF+pWHDyEgEZJnYr5i2PwYbrM1diGBFF5OBLCjvchje9iY7EAFYaK9Cqmh+bAfpY+wLQLA8MuZTL1fLFZfKBbw2rHQMJWwOON01LJx3z33Vaus6Z7ao/nUfoLJzBib7xytcoEJKElN8mFLvxtlf6kHxsACKscOXL7iIgbXPHb42n8rAAhBkiIa9+TbGvUR/W9+z2iu1XwQuC6Sf67KFv0PX9p8uh3+vD1E9IMfsQ13PFOThq1Lf3lelHjCH9NNhz7SG70f2Kz2vaF/3xT4A9SDN25+weibthw85vcSHnB7U1OZ7Xc/U0eFrTMWvMT0o7c23szbS/rhZAoXM4SP0NYGY0ggzzGyN5EbtHB5AKNly9ZsuZmb8ntrYPiCqu7v/BzRPTN4=
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 'List Non-Employee Requests' (list-non-employee-requests)"
---
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"}>List Non-Employee Requests</h1>
<MethodEndpoint method={"get"} path={"/non-employee-requests"}></MethodEndpoint>
This gets a list of non-employee requests.
## 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":"requested-for","required":true,"schema":{"type":"string"},"example":"me","description":"The identity for whom the request was made. *me* indicates the current user."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"approvalStatus,firstName","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: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"example":"sourceId eq \"2c91808568c529c60168cca6f90c1313\"","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**sourceId**: *eq*"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of non-employee request 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={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name.","example":"william.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's first name.","example":"William"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's phone.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"manager"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nonEmployeeSource</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></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"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Attribute blob/bag for a non-employee.
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></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"}>approvalItems</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of approval item for the request
</div><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={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approver</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Reference to the associated Identity
</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={{"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"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name","example":"test.account"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"ApprovalStatus"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `PENDING`, `NOT_READY`, `CANCELLED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","title":"ApprovalStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalOrder"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Approval order","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"comment of approver"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"ApprovalStatus"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `PENDING`, `NOT_READY`, `CANCELLED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","title":"ApprovalStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"comment of requester"}}></SchemaItem><SchemaItem collapsible={false} name={"completionDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}></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\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\"\n },\n \"data\": {},\n \"approvalItems\": [\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": 1,\n \"comment\": \"string\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n ],\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"string\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\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>
Reference in New Issue View Git Blame Copy Permalink