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/list-non-employee-sources.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

93 lines
35 KiB
Plaintext
Raw Blame History

---
id: list-non-employee-sources
sidebar_label: List Non-Employee Sources
hide_title: true
hide_table_of_contents: true
api: eJztXHtz2zYS/yoY3h9NNKKsh+WHZm5uXMfJuOPEOT+au3MyF4iEJLQkwANIO7qMv/vtLkBS1MNx3UyvadWZtjIJLPa9v4UAfQ50JgzPpVancTAKEmnzN1qdpFmi50Jc6sJEwgbtwIqoMDKfB6Obz8G1FeZYq1x8yo+KfAbPPtx/aAc5n1r4HACBsKTAzuRERPMoEew1V3wqUqHyAAbHwkZGZrgyrHs1k5ZNRW4ZZ8gD0xOmgIwoyVjHSYddzYQRjMO/+Z1mkeOi4AkrrLBsog3LZ4IZ8Z9C2FzEIT7JeD6D/xieilyYEXuvGOsRKZxl2IxbN0sDm54kcvBRxmqkhDUjI3j8sc2kYnczGc1YxK1gMEOb98rC/1M+L9csJfAcM26tnCoRs1zDK+Ail1GRcMN4FOlC5TAX9WLYeA5vYbCa4jr5jFevvrNMxh3kuu+4BlsY0KPjHjTH1TK1ZV7fB6l4HzA700USs7F4rzKjb2UMfHnhPzZ09pHd8qQQuBzQv5NJwvwEGkwL30lQa20vfF4KTdyTfhiqR98p2wEvqmxgyY8kmh4WNXN4p+ANeWAq82DZP17zT0wV6RhWhZWMsEUCvgIaNSIvjALdXIKT3Pw4YEdvT9llzlXMTcyOdZKICGmwt9XSH57N8jyzo52dWNyKBAOgY7lMMi1V3ol0ugNm3+GZ3LGeThhVdMJahOfkbakGV5QKPqYURigmalIaAQE14YkV7UB84uDIIF5/2IVYimYi5cHoc5DPM5QZ1hVgM5jpyLhHgz48SKWSaZEGI5iX8k/uM1GJxYSDFuiv+/v2em3qycSKVXWe02NgGzSIZpsUYF+nVQYvOuzaQkglc2YzEcmJBC8hY7fIOi1UfManUvEc3cHoYjrzYUeG+WbM8SuMUal/s/IpIFd0fzphrdwUosVk7gNLZ5AQchdZrX+EVzrnSXiMs1uo0kwryjY8LoMOB64JBwy6Ox/gPjLAcnJS2Q30x1rOJ1rsDhMppCbQGCYXsJlUUZU6MQ1xMDSwwlxmiSDLzPitwCwmDCkHx8s041HeRmkgUxgBFoMcj4lF6Rw9xQpctUVE/kqSt5An4paSjNMCjh5TZvHcfBMehPKscaKxhlLCVbDgJzRzo680km9jxQ0r2NyAiYL7BV4gxa94G1YLSNoqh9pN4t3NdLpYItkd5P8UXKvDWik6pYplBM7oisJioekEm5hfrNRh6fVP1tn9OhkmCZ+iM8VoKYhDcJqZAA6N93NwygZecC4L5VRHEkOLwsZVp81yWG2oNq1hfpP+F7IEOj4PrUCHAkM2TYMrtCOAEfhmWcBLWLeK4oIQABXT0uvtXOVQAN2kMYa0+o1D4y+oGuAr9Fw+pwh1zzDsbZFlqLy4QmATIKPv8DWUjyS2I0gBpATmtdD25jiNW60A4WOZ6Sxqud/t4v+aejp7ABkyPf4J2CaYQRAOnBAI8CxL0J+BwM5PFql8XrUlN4ajG8hcpLQ61L7zCUGU+pMf65ZBLGNQm7l0/Mr4Qd+4vj59sWL2Bk52YiDOCxb9hncH3cHeQT8cil0e7u5O9sNxHPXDvUjs9Xr94e5h1ENPK3W5jotlZ6OFTuM6OuKyqoAl1+i2yVE/OuwddA+GewfRsH8Y7XV78Cnie5PDbtQb9AbIjYunR3KCg5/Iy4XIwZlXMsYjF154+MT1VwkFkOEDSLb0eqWTOgMPo+zzsDOB0wLWJpS8KQTqIe2NXvzwIu7tqqqEQoRzE7w6//Hk4s3Rm+OTf7+6OL9+C69OX5y8uTq9+if2b7USqqcrSIfqDoS/dfV+oRJhzwLqhehI6oeQOTibolSKkMUUgGUWrFXnqZ/zItdXyD8ofX0EruMI148bdhyCD3d7w3jQnxyAG/Pe8KDn/XwwjPtik1VLehdiAmAKeH4HvgNBiMN9Q+a63gdN2ezcthb9vVo01TH1Qg9m+hhySJjLNVDs3UyoFeSVcPhQEl5KtN3eYdg9CPuDq97BaNgfDQ87vb3+v1A1JZL4ipx4kg/xsNsdDYad/X3k4Z52fDYlukckOVXPoVZnbQu2VDCrlqeRmbHnMLFdn8PrtL3SzlVi9vrQ0Cnogfm4xKdfkA+94s2J4/se/2kHu+sQy3EiET6fGAOhELKLhZ5sUf9jHVMESQUNkYMAvxTDbNByTBXyWMePqMcvAVaHU8MlciiI5Qgm+o0fhHLUGzmS5Y4PjWs6DWii02Pf8xjkdfIde2Ew5gyPfgZaj4Eq10rCfFZOgRiv4OWaZcW+4OO97mF/d7K3y3n/YLe3PxwfTvhg0D0cHh7i6qmwFpKsXQP+mku/EkoYGbFER2CR/4JCIDxA98QALf74vEw0HqF/7HPc2EpMzy/DHck25NLvj9+y3X3IGmpa0HM+XVKCCq8vgxVvbnsmzo2cyrUIqSwSL05eHl2fXcGTi5O/X59cwiektbJje6TKVlFTRM70HXHsBcCMYgU2EpBSWMtTbYFAXNnFgdL9ZefQ/KbMd8sww6++ZsYiaTYxS+1suX37THZEp83G+AzCPpqxMbcwQbvM1zqKIpHl4ZnXZMvvrzzvsKM4ligkFDLanrC0uzsGjBrHrvdyW2YQyq6v1EWOuxdyGR3Wqmxao84rZ4tGweAAzr/sJ0cRbXiXu9RVOFTe4lksW/nYa67J3dVS/qcmE/q+iDb+IKNCWoXMBLJJ6Ep9OqJeDxKPKsdVGWuxnlK6e+2YgXpO7yJe2EfE3dsE0k9IolUvboUPPtrxLbeheW0mn5H8ZiZNrna3vS7KwHfd6DZ2t7G7jd1Hxu7yywu/T+PfEvTprUKfa8UL0K+h4rkCfQx5j9KsHETwxhuyjY2Dh0g/vLuCwP4ZACuMF58y3JX7ivjIlfIV5o8qe/hNt3JPriz9tS2QQdKjk2ACmUjEI+K75tiBRFLVYHW1l9qMJTioWgMR6Zu2uS7oK09TKEUb87bNYi2s+i73W/IQEda6DIirqjh0W3xbJLlFkttqtK1Gf5hqtEWS29jdxu63GbsPIsmKK4oWj5NskabczJ2n+fe0Z85gQH02ogo5MtUyWkFirMJYQRM5BON+b9yb7EdiN+a78d7gcNKP9vp8uN/b7413+/vBYq2/qeO4CrJmTC3Y29mRVAwg7hZwXKHAuWyuddzc/ivw698JnWDLa0gMtgMAd/+hwo79w1XseKU1nqyblwjJNjCkqnWEOQ3GpjjWlGMlfnE+hbyo8EyHBL7QlWQqgAp+i83o4AgGL0oBdM08PJrkeGbOHUeR5UayX0WqKCmAQ8oEiVb0pf0dl3i2Y4KYDygQgp1Cdv6K6NSb6FcheXaBEp+hxOzkUyQEBnqF3Ifr9ndPgXmDOeLSGXjDRq/rdrgCB4CGwOWsCndu8fkWn29r/LbG/zFq/Bafb2N3G7vfZuz+Anzu0dBmfA4DHo3PYWynyyos9ZIOzP7WMJ1CxXNA7s10RMdf4xqDE64AV0KGpnSuHq+WwB87jSOwduHajLktbzsUJoGR5XnMz2AoMNB9h2eyUx6YUfqODmXeDtakHTwf4EIMEldcuKOeeATULdIh9RqJHuzSHS3glO3PIAfV2c8H6dOJPLDiHORgjkybgbd7b6LHwGYGrcR3lkZ3yHtWZATZrk1y/yV5/FHWDXI4IhvkWKe+B9eC8Qy4XBLPn2cpbzldIuZ2q6/cdarrCPZp/ZXFznFYn30vuIGGwH118eyHd1fP2RSRJkW6O+MrJB1g5uwtuAhlsqNyGx8nUXGp71YcNb4owchhkwQEZv6ofHly6Q2k+AvIyaRSnCQoDeCsx58G5o15Gw7Gv1cheyGNOyzs7l55Ed3lgZuslIsvyPVUJv5SUgsdtZCo4UnkBhdOtTeRO3gTQfgiCZ5Y0taTF3f0wgV62D/BE6S6zANqwvPR/HorKq32ZD4a9EKk1+TjvXpHl76a05jLWuX1r1MWzbS24m+MoetgGNxMC4iiJ7NFN81Cioiw311gKXRLhjIEUEj8nUFgKOdMfIxFmTCJBrimYheSH8myEPMf6cLKx4bM9PgGaieOjHX0C464L/GMC4a4YOhygPX8u9KEjoWHxkAGygPOAY5r+1Mm8Iwu5DxHa21WJ/I7NAdLQwSsEhWbjdwfozrB+U+MXuDoagykYMTU1Rd+8DfztOjY6aKyyt2AZQ2u8ptoKItLenP8VrtRWCp/b/KixEf1psm5SuZfO0tvyCS/n7z7f8p420zzR8w0HuWiu9Gyvh1YdHKH1la38CxdYIT/wluKVILT0KzUdxYXyWQJz9GnKaajmRTU/GeC54j82uhXOqU4BLiLwS+sIzSlg8oGGObQrskE6HXYO+iuVAQqxs4Kj0sA1Z+0b7EuQctv0UjsRWk4AFBpWih/K65IGd5X/oJ1Y2mjwiUhaLSUKCXTBOOqWWVEotugKjrUY5jUnk9wlxga0AUjfmEtsKH1W8SgSDo27a6q1YJciIS8DMc14feXaIPnhDORZNjbQQYFMCUWVnh9erVCEYgpf6Bam+mOn2R3cCwQwVbHOcOgAx0dPsq0zaERXaBL1x4aV5/qXxlYusVT7Yxvfx/gz/H7AL5mo353MtwfRBcqXPPnOu2bYG2nDb3bDDwN33/+jFtI2Hbe42N3xRP7b3B7zCz1nc6N3vZt/drAWqX9LHBTpvwxBb/tEtC1jMfr4c/1MwEP6LH6GYUnKnJ75//bu/P/gDuUV9yf6A3PLvzt8ueUrL/a9fwHeV7+gYEn8n71te/iP8j02h8WeCLn20v2D6q6/u2DWr8f6p1Y+o0nKLKUkKicumnuC5qFWStHGJBKtWn+6gRBJd/QovsPuNT9/f8ABPMuqQ==
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 'List Non-Employee Sources' (list-non-employee-sources)"
---
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 Sources</h1>
<MethodEndpoint method={"get"} path={"/non-employee-sources"}></MethodEndpoint>
This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request a list sources assigned to a particular account manager by passing in that manager's id.
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.
## 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":"non-employee-count","required":false,"example":true,"schema":{"type":"boolean"},"description":"The flag to determine whether return a non-employee count associate with source."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"example":"name,created","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: **name, created, sourceId**"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of non-employee sources 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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of approvers
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></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"}>accountManagers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of account managers
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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><SchemaItem collapsible={false} name={"nonEmployeeCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of non-employee records associated with this source.","format":"int32","example":120,"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\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"approvers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"accountManagers\": [\n {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n }\n ],\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeCount\": 120\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