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

129 lines
37 KiB
Plaintext
Raw Blame History

---
id: create-access-request
sidebar_label: Submit an Access Request
hide_title: true
hide_table_of_contents: true
api: eJztHGlTGzn2r6i8H2ZCYWObmw+75QBJMZsEFsymdoFK5G7Z1qRb8ra6IR6K/77vUJ82kGSyx6RcUzXB3dLTuy9Jfd+yM5XIVFtzErYOWkGiZKoGQaCcO1f/ypRLW+stp4Is0em8dXB137p0Kjm0JlWf00GWTuFZS4fmQNKcdsKTDhhQ6+bhZr2VyonDYQxWeLiuBa9C5YJEz3B9WH041U64bBTr1Il0qgQDFR6o0Ca14iRUJgVk3tm7dXE3VYkSOhV3OorE2EaRvRPSzKujhJzNEnsrIwH/IDzlOtfm2gxqwJ2QACkfEQrp5iaYJtbYzEVzMaqB7AgxAERzAG5mjVNinNgY0AYalAlnFrAVsZKGSfHLXJupdGKklPGEprAWUnX0DvAOBUyGcRk8HNskR0ebCaz4UgUyg2XqK8DfVVTXC2YYm8KiaZYYACxUktjk2uixmNvMLy3CbBbpAOTUYLQDTgMaOviUEwnyWReAUGUyAG2IBzH2j9KpZNQi0INwjvCAlgmwCjBkeaiQICbqVxUAE0AkJzRlhKBmiQxSHShkTTBVgAgBB8Gqz9qlwJAFlGnJRI1BIQxOBJ47GRek6VTFCBzgqJz1BEYYddcABswmVQwkqMmIQNgYWOWmIBfQhAwlQitcNVjgUplm7ubnaZrO3MHGRqhuVYQm1nFSRySxDsDaAIvZkDO9cbu5AWDTdt162gzmBfKHVpmBuBdpLhT7Gxb0ENsFiBeFSjkg/x8g5wAlHDl7bVjrAA+nZBJMxeDs5KtW5GkvSmEisKYgWUAkRVhYe2MTbC4NqV2bRe0D4Mq4DMahkqIxswXQ28o6TdWcJNKw/l2bIbkTnJveWZHOZ8oJO26sdIAjP3x4fT54N/wwODw8vrj48OHarIlDQGpUWLo34TiLUj2LVE6RVmRdUqAORcXoDgK4yGYzm4AuOxWNSymDW8j/trjCVMJbQMsCGxNQRpWAyM5R85EJJKjXKhV1dyvAZ4/1JGNn/1Xim6gFBQ0IWKkzRGqOZFBdSVjy7qhUSOIAPbQjS5YQPZAl6IDQB34Cn/iz+hyoWYoaxuoiwZPVHR48rYicpFeIlqiPgXu34OPFkcrtBtBAttQQAz9EvCM9L3jNgJAa4q4juZzbSKHf4pdgMGMND0gwJNNIxfAv+YuaAtDk91NdihmRqU5ZF7H8rOMsRnn2t+vgEH6vC1MDPdP8BLUTOQgMIyUqtUegTp4f//30r8cLSmkNRrCmZhYqWNgamp5IdawIce8D0IrQASy1uETdgtwKtmEArBovhBs2aH5fhD5vc+hLE+AthMl4BMye6hm6PHg60kk6TfRkiqHA3moMQBQFEbEjC8xHtBzbS81cOuIUqY2lkZOGcBfxZf+qExFq4HJazAO5gr+3c6VYAU7AB4iPiYohbB2Bun5EB+JmIJixxjiGilxNWCgAE8NxRsj6B3wIKdaCWJHJLBYyHJurU0PFOuK4phAgfsjEIMAhqpnx9Ht5VvF7Qm3Xn9dbb823NiBLYWDMuSLc4hDVRC7S4KA5oelV3wrwL03tKQgh8FceWe+0zjyyN0UkYm7PF+QwrvI9BM0wP6WFb5/KW4V6DqxSzP0ORHZVBxFngA1GeTHOUowfOG4d7QshXw4PSVq/WaM6NRdW6FjdIy2qGCtXRaUgeWR3d6fTqTg9f/1hcPT25B15RIuJdhF7n7W1OaKFAenPa2vvbKoO1tYERzGNNgJUhJqlmMcGn30lOYHVTPnyhPW0HAdZc5F9O+82CkRIOcRQfvJJKeXn4GQdOADv/e/QMtCLc8YEg8C1c/pd5QE8rFOP5g0yyRxr02IcQFlAaeKRe2lDqE7u6SdwG0qZNMnUeivAQsWk+AroiTwrNn51WG/ctxykI7HEvzDWQwViR5iNAlygHXQWo3UOlizjlU3wd71sGQhMqdCD57yEdJ6ZdTelkkDleq1dJTqgW9HpT6hKdesih4K2XvHdIOcq+A7g6HGWSSLn8JMSqAotLk2A6fBCfZagevioH+z39rp7Wzs73fHWdrjT7e3s9HZDKff7ve723lbr4aFg6ZCgLIFmshiruWr+A49roae1brIoWqjvBo34AZAxSo8l5EgUvaswIaWpgqTRJUdyy+YIVmFMrtZVkQnw0lHYqbGigT7iK0f4hhWHXFeB8nmFJSWHVHjSYPljonhErdJnWOzj+Nn56auTN8fI5FP65/jd8GT45vgt/LusiFbMK8uuEXEBBUL7K1WvxorGMkCgDpehVV8HWA0roNtuem2M4ZW49fTiXiU3t8O+2u7t7HV72+Fmf7y33w1kb3uvh+hAPhp7K34ap0MeyDlD6BMMv25CcSYf4Q0RfQX7qIrO4EtkHjLRGyYT2CGXU+J+vlBc+CBLtv+LnRrMVYiCCBO4tyqVEFyWOhwZhhqpkNHZEh1ZYswVrzSYzah743k53t3b78Nf425vd2+0uxfKLbnZ3Za91nptzjsoj2FWigk9eEcy/kfAN4euf8PiDwvuIBnpNJHJXHxS8zaEmkyJmdRYzYASz30bQ2GsGlVbMyDUZuByc0dqnqWV3At7H5x8SedsoKnOgEiDPSaoYiEZ3cDKPjNY3qT6loszzI42ltbjHbb9PHN4Xh3RFCnlI+WybBkNTeEwHVmDmQTgqSeGQx41MPIUs0ipIXfAtOCTsXdIlq+kZ9qHW0pxqJQs0iVCwDtFTnBoAOLmUzBx8WaQ58IiVNWEG9Hrb4mpzXwpRH0RAumTxtiGjCHW35oqUvUZYm6ItIYK+4C+exAWFeG4WvN7ojmJzLFYRnieCQZTCcxaRnm1CmVYc0Qcq4MyDUsU1djrpCzzssZhwVKvrAHVUgctzynz7hUhTzF8SacSKx1OYcC1lP2ueU6CNIGKhObiPm+oUScK4zymRDZLGyT6fIFg58g04FMdgotQeCxzxgqGVH3gsETl6v3YeuQvi3JDp6yrRdnl64RqEcAOEp7GErx1C7nXxuS57vG7/W67u9vu9Yb93kF/86C33el2u/8skg9O4LCtnCc5N48EZIy/aJSxNj4U9+CH/Ox/9Ld/ANf7XcD/IVxvZ0EDann3Qt71mFYAGAbEfXmSJSjdksQ9wGYTYNaGOO9R9gVlYRrS5T3wMaSIczIjmkPFDvkqYgBmNd9YbTC6W93uIoaHpLziGLv3T2A5sthjxwIMRKnD34FLM0UNwW50dGjDLwh3r7RR7UkiNWJIGw5QDIbKZ2MYTWJs4zLIPD2lcfWUEDjR6YmXMqz2LokYYBNobfAJYJ18QYp6aTTMF/kUiCVFgFmyrNpVcrTT3e9vjXe2pOzvbfV2t0f7Y7m52d3f3t8nRwN6ADX/spy/vvRrZVSiAwjsULrq3xS2cCXwnl0mLv7lZQLB+MJ0g8cWZHp8Be7WYcPz5eGZ2NoVEUTQjJ7LSYMJpn25WA8B5Qz4NNETbZ6qWY6OXw0u3wypIvzb5fHF8LFa0OS9Cey1jiHFuCOMPQFkdyrirSGx5qGuVTbU/EDtKkYIukXFJMzwqy+ZUQWd79mVphTw1qb4WXdUZ513oyCagdMaSZe38pRYY9/RfuM5uSamEJBV8gIStCKcCHKsDuZTCQ9xhvu2ZSpWhF6IqzpQdVmUrHysOn1TFQoaB2D+vJ4MgjQD5IjMqhUW2uJR9PIBnJlzdeyGTS85Nylt2kl0k4FNKNvCsIC7ud4dUd8UHI/JxxUeC11gTha5u7eMzFFq6R3tfT5vd2cRuJ82kVa8uFXe+KjH4GtDUUb93CN5f06TiwrS8yI3fG4lrGx3Zbsr2/1C222+PPd5mX9LqU9vMfW5NL4h/NuyBK1ocOeDuF5jQdLBAp8i/fJ+6BvN2DzG4kZ9z/yIQ/mSlnAuD34+yg8M5KG/lAUiSHxkCsbgiVR4QHiXGBOjmFWbi6tBdjzSoKBmSYpIW5z5jniSGarqJZS/+V4Jd1IrG6jcZG9zl32VSa4yyVU0WkWjHyYarTLJle2ubPePabtPZpIFVmQtPk9yWRzLZM6a5t/T/oOAAeXJ3cLkSFTNbAWBiSLHatUzh9ao3xv1xruB2grlVrizuT/uBzt9ub3b2+2Ntvq7rWqsvyrtuDCyuk1V5M1yJBZDEoe92MyAcrnU2rDe/svo5Cu6NXQ9Rd4MPAeW3hS5Y39/MXccWive4nG8/Fh2LYc0JY/Qp8HYGMdWzwlLMQG/aPCIjwa8UJXwcFNbJLh34k8E8bEbgJvM24NxCqSwoZS79X4VbYIoAwzJE+CuGK57J3WaHwIFCJTBTsA7f8fs1Ivod2Xy4hwpfoMUi+PPgVJo6EXmvr2sv3sCyCfoIy5YwI80ernakQYUAAoC9llF3rnKz1f5+SrGr2L8jxHjV/n5ynZXtvvHtN2vyM99NvR4fg4Dvjg/h7GdrihyqVeoXP/1NJ1MxWNA6i1sQAeswjIHp7wCVAkRmlm6WzmTeIey1Thx5lp46xJTQsYmSyIYlN/ZuQchgXAeOnKmO/kBKWPv6OLOCDizxOlolxshDqAD17xAh9iaaNRcdnMEnJlMhKCO5neDnoRs8L6dpSuG4NgIzDoeo/RaRI/xJh2UED85Gt0hrVmgD+i6TKKH308LA3qElmXse3I1GC8A0waJSMJNeUn2AvNtXn3hqmwZQ7BG6y8sdorD+uKlkgndK6ArUb+8H74QE8wyycr58qE/aifFGagIebFB3sLHSRRYEptNpnz6vLZJglYjxhFeY702F0qJq+p5nnPwx8TSQXk/66tujMnavBd8Cw7LAW34ZBifLWuLIzqQh5fDaIwnkS9lXs1yumSFrm9F4k85tPweG0FzLxpYMGuv+MSYCMB0EYSMHHHrmxdneO0KvDZdgGoj1CYOyAmPR31rK8il9s141OC1EV4dj2vzfqrxdFZtmmCPJRxEwCgUJyKYWuvUX4RA1UEzuJpkYEXfjNYdLtomi2j3uxWU2rxkW7chIST83oBhGFYmOcKATPmIhVTNhGySH0myYPMf6aTjxxrN9PgK4iaODG3wFfdmGzjjgm1csM0+wHn8OSyhYuE5SLwnhEbPCnBYyp88gUe04vcY1lKvTuA3aA6GhgBQJShudsA/DkoH5/8S9AJHF2PADWM+XWz24a0aDwtjU41ZeSegycFFfCMLIbHBN8a36ERhmPx/oxcpHpQNE7w2+L299COe5P/H7/6PPN7K0/yInsZnuNh4PC+v5R0vOdZM1+iunr+OdtO4jda8tdW8iHVVmO7C1SldOUb9+GWjyl2jL73ds+yE+X/g6kz13skTR+hvnkPne51WR6dCyuULvqore+mz8sU2LV8Fgf/TWfDUcskEBSlfA22eLZ9FMkXfRb47mGpFDZ6ZArpGeO8MVNXG5G+LT7swoAl9fiYBxZRQkuuILpAMy5UluUUuH+jeNX9eAqtM/koFXjHpiPdQc5sAjA/rbTxEA+9+tb7wvgD7O6NPEhzlJk3XyzKDNxEB7SzGG/XP2X2oXZBxeILy26icF/x1h2JW7qvRoSAJdAFUJbE7HePegQ5UxbyfWQus2/mNA2A9StGwhEtCzlVE/gfH1Yuz52CDT2lPVUSXDiC2QpqtKiu8PRkuQARgxgFdgerYZLLhJ7kNHAtAsAhm9dns9DrdNhWF8BwL6FiaCvCL4ss09W9fNPXwvtwzWX1zaPXNodU3h1bfHFp9c2j1zaHVN4dW3xxafXNo9c2h1TeHVt8ceuqbQ77FgNs6GzM8hYDVSMbbTLydd9VqbudBXT7FDT94dX+Pe9S4v/WAj2EAboBe3ZRbV/gLQPJeNXU1PincI/WHo9rUDCk2QxdPfeGOGs/g/e8nx95U9iTPTvEkQGvkv6YU8/ZqIu+wIQD/P2hdw3/wwwdYai7g8/tWflgBxjDcvKG8rJ/q/0AyHx7+DXVxjTI=
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 'Submit an Access Request' (create-access-request)"
---
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"}>Submit an Access Request</h1>
<MethodEndpoint method={"post"} path={"/access-requests"}></MethodEndpoint>
This submits the access request into IdentityNow, where it will follow any IdentityNow approval processes.
Access requests are processed asynchronously by IdentityNow. A success response from this endpoint means the request
has been submitted to IDN and is queued for processing. Because this endpoint is asynchronous, it will not return an error
if you submit duplicate access requests in quick succession, or you submit an access request for access that is already in progress, approved, or rejected.
It is best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can
be accomplished by using the [access request status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [pending access request approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) endpoints. You can also
use the [search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items that an identity has before submitting
an access request to ensure you are not requesting access that is already granted.
There are two types of access request:
__GRANT_ACCESS__
* Can be requested for multiple identities in a single request.
* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options.
* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.
* Roles, access profiles and entitlements can be requested.
* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.
__REVOKE_ACCESS__
* Can only be requested for a single identity at a time.
* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning.
* Does not support self request. Only manager can request to revoke access for their directly managed employees.
* If a `removeDate` is specified, then the access will be removed on that date and time only for roles and access profiles. Entitlements are currently unsupported for `removeDate`.
* Roles, access profiles, and entitlements can be requested for revocation.
* Revoke requests for entitlements are limited to 1 entitlement per access request currently.
* [Roles, Access Profiles] You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone.
* Allows a manager to request to revoke access for direct employees. A token with ORG_ADMIN authority can also request to revoke access from anyone.
>**Note:** There is no indication to the approver in the IdentityNow UI that the approval request is for a revoke action. Take this into consideration when calling this API.
A token with API authority cannot be used to call this endpoint.
## 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><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"requestedFor"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID.","type":"array","items":{"type":"string","example":"2c918084660f45d6016617daa9210584"}}}></SchemaItem><SchemaItem collapsible={false} name={"requestType"} required={false} schemaName={"AccessRequestType"} qualifierMessage={"**Possible values:** [`GRANT_ACCESS`, `REVOKE_ACCESS`, `null`]"} schema={{"type":"string","enum":["GRANT_ACCESS","REVOKE_ACCESS",null],"description":"Access request type. Defaults to GRANT_ACCESS. REVOKE_ACCESS type can only have a single Identity ID in the requestedFor field.","example":"GRANT_ACCESS","nullable":true,"title":"AccessRequestType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requestedItems</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
**Possible values:** `>= 1`, `<= 25`
</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={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The type of the item being requested.","example":"ACCESS_PROFILE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of Role, Access Profile or Entitlement being requested.","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Comment provided by requester.\n* Comment is required when the request is of type Revoke Access.\n","example":"Requesting access profile for John 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"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status.
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"removeDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date the role or access profile is no longer assigned to the specified identity. Also known as the expiration date.\n* Specify a date in the future.\n* The current SLA for the deprovisioning is 24 hours.\n* This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration.\n* Currently it is not supported for entitlements.\n","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></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"}>clientMetadata</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities.
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":{"requestedAppId":"2c91808f7892918f0178b78da4a305a1","requestedAppName":"test-app"}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"202"} value={"202"}><div>
Accepted - Returned if the request was successfully accepted into the system.
</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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
object
</div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} 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