LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/create-non-employee-record.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

97 lines
34 KiB
Plaintext
Raw Blame History

---
id: create-non-employee-record
sidebar_label: Create Non-Employee Record
hide_title: true
hide_table_of_contents: true
api: eJztW21v2zgS/iuE7kNfYDm28+4vd26THrJI21xeEOCSAKUl2mZXIrWklNQb5L/fzJCSJdt5aTZ33e15uwhsiRw+M5x5OEOTt4HOhOG51OogDvpBZATPxSet9tMs0VMhjkWkTRy0Aiuiwsh8GvQvboMzK8x7rXLxLR8U+QSeBTJWfSWStJ9yxcciuLq7agU5H1t8CQLDUiI7lCMRTaNEsI/UNBUqD6BxLGxkZIZYAMnpRFpmxG+FsDm7kUnCHDbGmQJpopRmCGD7Uh3X22JHaQTLJ4KNdJLoG6nGrNSB2QjU7l+qVw61NX0n/BUo6sd8p2PQ9XYOVUMRN7TDBa8rtEPo2vaSAATYNTeFaAURWgx0Bak8yxIZUbe1rxZF3wY2moiU46d8mgkYTA+/iigHQZnBWcqlsNQ3inSh8k88FbXGNjegYjBvRm8VETMZw9iovO/PFAhAmOIbB41QBppO8rRtUwmTetcKRtLYJw5Ut8wry6jnkiHO3RAoPOHPlI0dl4g+KVGDFWXy3VKp1wP2+Id/3o40wc8mWn0/durVHGWz+g/FuvAxjws+Bdcup/Jgj+kRRMY1T2RtpnMNLm+uoZ2FSIB4qkcOgPFjNeF85QAw1gLBWF2YSCAzfKeariMgacruRbvdnc7O5tZOtNnbjbY6XfgU8a3RbifqrnfXccyY50uDgMexxMF4ctQIhyauu3lggxxeDAsgjmGih2tDPgZCMHMs0mLdDuNlS8ukJeZI+TeZFimz8nfBbJFl2kAktckyOTf5HlDGMtPAACmHOEddRJhL8PGH7MUcDORBRnIZ9puzXKfXCTvrYW/jtNPp0/9hZxP+ksOr+L8ABaQuB9IlIJsLQO7qlHfR4Kk6ldQiv4zVMppm7l/zvbqxZ7ri6iJzgtRYrmbkfXfnENlMK+t8pQcwFzj9PVF/vHRZCV6MteXSIKqm5+zsYO/hmfGrjXT+97KLwIrqV1T/f0L1P4i9u7thZyfsrZ92d/qbvf7mbru71fv3DyDvzn04Uh3LkRQP09T9QM4nQtGiWeXs3IdvKfjpJnHJ+Isi8SIfwrDR6a9vtre3EcPdPasLFUNuYdlYupYkEq2/bww4XsiORV4Yhbw7aiDCCgGTDKkojF9wmYlFDtz2XsdP4KsPUolwbLhEhIIgR9CRgcRrGWPBlGqooZxIZB1Ugdo1zQiWaHfZOx6zsgZ775VBMxoe/QqynsIsZ0pCf1Z2AU6hAL5nWLEt+HCrs9vbGG1tcN7b2ehubw53R3x9vbO7ubtLTi2sBd6rswc3hk8Xhv6nUMLIiCU6ghn5HQwCDgO2JwA0OHSRuUjt43NAMp5gf6R117ZS0+NlWFm3gLnevT9iG9sQR2pc0HM+njOCCs9O4IkqkoQP8RHWmrjkkuDPRo6lWgZFqCLFLG1v/8Pg7PAUnhzv/+ts/wQ+oayFenygwFtjdEuACr4w0TeE2CuAMWZFAuaAIGNvvdS3oBBXtt7Qp9Z2CvlICr414kWSQw8/+pIeddFsZHTaCKXIbUOw17It2i02xGfAENGEDbmFDtpxwdtBFIksDw+9Jd+yieCxMG/abFCtNrioglDoPwVBDJYhDF0nYFRAKAMYSA90ATmJzmU0x64zUzZnY8Ylh/VJweAA5I/7ySDKCwBHatajsPIWD9HPD2B2lmuiO51jRDtVOY9AC54kUzCjgQQTmAl0k7llno5wuiwQjyrbVYxVp0iiu48OzF6u6V3EC/uEuDtKgH5CUq16cS188FlMaxwb0WyU0+QZCV6i2tTZt6qmqwx8yE5FEq9idxW7q9h9YuzOvzz2FbR/S6lPdzH1OVO8APsaWjwXUh9D3qM0Kxu5LVM3kS0GBvEp0i/npxDYv0IKB+3Ftwx3E14wP3JL+QL4QTUf7vkQ049qshpzgQDJjk6DETCRiPuEe4aYDOVMtb442gdthhIcVC1JEYE1DZvqgnEwmSmUQiTcthjUaVa9ytmEX1M1CHgdA+KoKg4zLVW+yiRXmeRqNVqtRj/ParTKJFexu4rdv2bsPphJVqgoWnyeZIs05WbqPM2/d/vd0ICVv+WwKuRoquazFRTGqhwraGYOwbDXHXZH25HYiPlGvLW+O+pFWz2+ud3d7g43ettBfa2/mMVxFWTNmKrNt5tHMjHtxRtWKHAum2sdN7f/wLxGjJDWkHqqvBlsDia9qnLH3u5i7niqNZ6bmJYZkm3kkGpmI+Q0aJtiW1O2hQacjYEXFQOqkoALXUmmAqQYPF2RyFRS8KIWINdMw8EoB1VcoJROVo0iVZQUgJCYINGYNWtwLAlKihHmfCCBMtgxsPMLZqd+iv5QJs+OUeND1Jjtf4uEwECvMvfNZfu7BwDeIEecuAm+Z6PXVTtcgQNAQeA4q8o7V/n5Kj9frfGrNf7nWONX+fkqdlex+9eM3e/Iz302dH9+Dg2enJ9D23aHVbnUB3Su/3maTqHiEZB7Mx1FhaHt5jIHp7wCXAkBZdoSiXA87xys1c+UhO5slg3wmDTmhQ5SYRJoOcnzzPbX1m5hpmCG7to8k+3y3I7SN3jIaG0I5lnCPLI6iogN2ODowFcWbbKtkei+jutIuLM0aYOOChanXeEHJePpKpzCqS6A3UhMi4Gre1eixwAxgzrilS3Pi4FlFvQDvc5McvfHdXGC7tFlmfkeHA3aM0A6pyKqcDU71X6CSbcbfeFs+2whwUKttzDYZ2zWY+8EN1ARuN8uXv9yfvqGjTHVpFAvLGa5QmJtAMFyBC5CVDYo9/GxE60uRhfjCQEfNH4pwdBhowQUZpfqRAh2ceCN8Ak4/hhImUyKnQTxAPa6el3OTiyuRYLLX3tmSXQ8Gas1sNAab/R7Q0sd1QRSuSM38LR9qUK2J5GBJC7Z2MarSCUeu8hKvXhNr+eC+FspLXTSQpJm38yhcKa9iNzJmwjiF0XwxJK1nj24kxfW5GEBBU9Q6jwGtITH0fx9Kypn7dk4GvJClNfEcanOJxLW0WY35miLWVgGk5gdsGiitRV/ZwxdB8PgYlxAFD0b1g0OGlJEhL1ODVLohgxlCFkh4TuEwFDOmfgQV2VKSjTkayp2IfmFZhZi/gvUzDH70tCZHl/A4oktYx3ZZ2PGAUMcMHQcYD1+tzahY+EBM9CBeMA5wPvZ/BMTeKA13nOylrI6iV+jPrg04KUTkmKzvvvSnxGc/+SupmDrqg3QMCbV1S9+8J15WbhANYxVbgfMW3ARb6JhXZyzm8NbbUfhWvln0xc1Hsx2TT6rZPrSLH0Pk/x5ePcHMd6KaX5GpvFpLu4+1i5P7JcFydx1s7krYo1rA9WB//p5f39Uvzqp/8BB++qcff2YfO2U/Oy4ev20+uMHzatz5s2D3w9cqakdyn7ovksrwCClyfJVVJ0a3vksd3Hv09K9RPgLb4nhqA6BKo/qVsr96oKyhOfIBcSF0UQK2jXJBCgFGXML41GnxF+Z0UiaUBuToDGdeTYw0RzqXJmAPNrXL0fmRDMuHcdowO+2oNINx4omUIWLNjuHQlaBDxgsYvFkCrz7qn01ewKzeoThwPbKEIFUNU0LhbcSAHaRMg6B+EgcxdJGhaN7qGmVKG2hKWGuepXchwGKKrSpnDOp/TzCDXmo9Wvh8shYEC3W78aD6XEWlfPYmSLHIqF4xnbNYucx2RCj4UQkGV1+AVhQFNdG+HhwuiARhCnn1W1txmu+k13DtiAEi0rnPuvtbrsTUpGFV1OgKoUIqQl315lY42JAdYu34Ym3s58iftx1W79qY7m1luEWIWpVuPLP1doXwdJaG6q3CZbk8P72FneRsPi8w8cADLcoLq5mdSV+A7luN4mK818F7mL4ny/C0yklIX67YvF3GSx3XQ+3Q/Vg26varsHRZ9yrC4b+NnHqNkAMv4GH+LcfXMI/+KIz52nQiJ7fBuV2IjIfyS2zvWXJjv+Aat7d/QdULXv7
sidebar_class_name: "post 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 'Create Non-Employee Record' (create-non-employee-record)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Create Non-Employee Record</h1>
<MethodEndpoint method={"post"} path={"/non-employee-records"}></MethodEndpoint>
This request will create a non-employee record.
Request will require the following security scope:
'idn:nesr:create'
## Request
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
Non-Employee record creation request body.
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accountName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name.","example":"william.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's first name.","example":"William"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's phone.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"manager"} required={true} 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={false} name={"sourceId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"}}></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, 10 attributes is the maximum size supported.
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={true} 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={true} 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></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Created non-employee record.
</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={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee record id."}}></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name."}}></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={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"}}></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={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2019-08-23T18:52:59.162Z"}}></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":"2020-08-23T18:52:59.162Z"}}></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></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"accountName\": \"string\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"data\": {},\n \"startDate\": \"2019-08-23T18:52:59.162Z\",\n \"endDate\": \"2020-08-23T18:52:59.162Z\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink