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/delete-access-profiles-in-bulk.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

107 lines
38 KiB
Plaintext
Raw Blame History

---
id: delete-access-profiles-in-bulk
sidebar_label: Delete Access Profile(s)
hide_title: true
hide_table_of_contents: true
api: eJztXOtv2zgS/1cI3YdtA9uxHefhfDnk1UMW6SaXB/ohDW5pibK5lUkdSaX1Bvnfb2ZIWZLtPNotbrsLo2hrS+Rwnr8Zjig/RDoXhjup1WkS7UeJyIQTB3EsrL0wOpWZsKfqsMg+Ra3I8bGN9m8jf5uV96O7FsyzsZE50gEq1xNp2cHFKZNKOsmdsIyzERBhRB8GMZ0yrQTThk21EWyBZOej+qgOZzA85UXmWkymjKsZznITAWQTGQPZZHEe4wbvssKKFlN6vpxln2WWsZFgIG2qzRSmcpUQsY0NqW6s2NhgqRRZUq5hhM1hYrWYpcuF5WP6yB2bFtYhTSOm+h4optJY12GnJYH/FgIGeKobGyP4cpLC4u5cZTNYDnS0seFMAUu32ER/FvfCtMoFUBAjchgNhEGiJqdz5jzxUeEYB/k0jDLPaKdUgrdyQlo+YE5/EgruuQnarMXOL//1n4Pj96e/tNjV+c3l0Un5DYwVLlzdHNI1xgs30Ua6GUqDEksD6zrNYuTHBT8AnSjGk0SiLVrgC4tkphxsC1pBw81nIRnP6bIgExlPSEfcWh1LkpYkuNKFib2tZn7AKBNIiSdT8EbrhOmAKwfjHOpkFu0/RCXn0T7aoxXFWjmhHN7ieZ6hOoHzzd8suvdDZOOJmHL85Ga5AIfXo99E7IBubjCenISowLn1ODpN6FozUs6AI/S402OL/y3KCXzXzIUh6NfjxvAZfJVOTG2ND+uMVOPosRWJL3yaZwLDtR8Pe3vdvcHuXq8vuqNetwefdrvbvWFvKOKYA50wZC8M6dMQ0esP0952b6+3E90ByaYDL8sCfl/5swX+lQOL2k8yZxAeph7ANhexBN9ddlGZetPFXCntatLDx5h79wiW9XFO8baxkfLM0sIro547UFROodQAkqfho6bskdaZ4CqqKRWlfASVOOnwa9QATETLY2L60ntZwx4PS3r0LrfsK7eVWXYGW3sjMsvOzt5ouMpyNITv0ZCm5R6R0xIxyFv63e6y+S6FK4wCFVEgyvRJyJqrGhH0GRBf0OZ3iinH7SdMVYs+v5iDTo9LI+OMgBjAv/gi4sLBDLrXSEodRokLXI8yBUCLxzKPvZtIp20dd4UFVQSAcobHn5i/2qm7SGmZHQw2Hg8SH3bxYNjr9Ya830WvyAVgNTBfSVNG9lfBRAWHgWAl0leCROlqI+9qcf9JVwveuAgSlKFeLU9IdquQj5sxhT1437PSvA56v8Zfmqz4VA9u4T15lYmfVhooBOYkh7NXa8SIVBihYg/+Xri6gQtbuu5Taf45HS1EPOBajaBXGcs9mc5y5BGxl/R4fH3OcAQJ89ICQhVT9L7L87MTLCMr1dIV9KdXm+7lxWp220O7be/y4Wgr4V2wG+fdrUFvb7DXTYcJLqz49DXSSptnULzg6K9k4j1X4PyGoRWiR4/SK/PJDQZJ9PT9er7xIL+QcOYoc3s3D9DbFSHycjJBd8aIpflBM8S/N1SDAPwNEDFMkQiSiB7vHkNC6nf7z+QgTNOOQdrFqFCi2jcs1fHr1LJOLevUsk4t69TyZ6SWEjJLf+UARFvdYZcTJA16fV5CUg2RbleP3krF3Lt/oEQ1WLVZOsokJBx2YgxgSJvV81a99zPSycwH+D3P5PfMVYlwXGZHOnmFJ72TSrTHhkvkUBDLMUxE37mXhOm0ffMkS6iicU23Ak10euyQJyxsbNlREAb9B7MV0HoNIN4oCfNZOYVJj8VPLCt2BR/tdIf9Qboz4Ly/N+jtbo+GKd8C39keDnH1KTiIt/cLYPgvoYSRMct0DBb5HRRioMiAwgIZoMVfnwiIxiv0fw1y+bFzMQO/zIkvDhtih0cXbLDLMq7GBV3n4wUlqPbNFVxRRZZhSyv0IFqBiXMjx1KtYqXEweOTdwc3Z9dw5fLk3zcnV/AJaS31bg9UCf/AKvjCRH8mjoMAn7llFhAhxoYU2whUN0Agrmx9oPTf7MyCMstGLswIq6+YUSfNUqOnjVCiuPni2BvZEZ0Ww9YEm3IHuWvELXUtfDGF+JW79lnQ5AabCJ4I87bDDkIDkmcMohGIUtsRu0NJUjVZ0wJCWVAzUReOKe1kvACvlSqb1qhA9KxuFAwO4PxlPzmIXQHMkZj1KJx7S2CxSs9ec03urmtKI5XOlOMxSMGzbAZqNAY0TC1jCek/wBGaywLwqHLcHLHquYHg7r1n5thpukdNuZfj7iID+GmTaPMb9yIEHxUkHo3EvE8MmgiIFOpkmhxGzc1VBr7vhK9jdx2769h9Zewu3ixLvHCXSp/eculzo8JDH0yeS6WPIe9Runwy9DuVN8GQ9AgplEg/f7gOT55o55zj45fvWB/5VL7E/MHcHv76qCyny9Rf2QIZJD16CVJAIpHsE98Vx766JlVtLa/2TpuRBAdVK0pEQE3DZrrwT/oKpZATblss0cKqnxyb8Pt5lU8IiKuqpJ1rqdy6klxXkutstM5Gf59stK4k17G7jt2/Zuw+W0nOuaJoCXWSLaZTbmbe08J9lJYzGFAdb5qHHJlqsVpBYmxeY0XNyiEa9XujXrobi0HCB8nO1jDtxzt9vr3b2+2NBv3dqJ7rb6s4ngdZM6Zq9vZ2JBVDEYdHWwoFzmWd1kmz/QfqNSJFWKMjSGXdDDrvRL6/SLVjf7hcO15rzd7jUZVQIdlGDakqHSGmwdgpjjXlWBjA2RhwUeGTMqn9sTY5FUDFgNOwTE4lBS9KAXTNrH2QOhDFB0rpZLVTcHFWAIeEBJnGqlmDY0k8opNizQcUqIIdAzp/x+o0mOgPVfLsEiU+Q4nZyZdYCAz0eeW+vaq/ewrMG8SIK2/gJxq9frfDFTgAbAg8Zs3rznV9vq7P1zl+neP/Hjl+XZ+vY3cdu3/N2P2K+jxUQ0/X5zDg1fU5jO102byWeofO9X8v0ylUAgfk3kzHcWGo3VzW4KAEK+CidDNa5Abq+iPvygdQtGNkykTt+25sO5y52J/SMYvo7vEOeQRPRHlybQmDOE6LNptT7CaeCmv7I+0RLorVpResMBlMmDiX2/3NzQewN9j5scNz2QEYBJO7mdKfO7Gebo5AySvwCw8a+FjFAXSMzC/QIQsZiUHgEZOIe3uRTtDdwW7UW36WcnkaZaYLwEgi08JDOcEh6TKwmMNu5CdLozvkgEvygVw3Jnv847J4Qk/Iskp9z64G4xlwuiAiinBX+cgVlu5+9SVPqdIRbvf6S4ud47A+OxTcwL7CPwF58/OH67dsjAUrAYY/5SMkvc7D2QW4CAHiQfk0ACdRjjK6GE/80bLG8xYMQJZmIDD7qK6EYLenQQm/QKa4BGgnleIkQWiCs+7elNZJxL3IMIl2Kk2i40EQbIKGNnlj3ltKmLSzkApPZdLVzkfVZscScYzexcAxQUTaKLLbvJSL1+T6Vib+UVJrh5AjavbtAhdetbexP78TAwogCZ5Z0tY3L+7ptWv0cBsGV5DqIg+oicBH8ylZXFrtm/lo0GsjvSYfH9UHf96vMY159GIWkmmWsFMWT7S24p+MoetgGNyOC4iib2aLDhm2KSLa/W6NpbZfsi3bUFsSf2cQGMo7Ex9hbqfSRkPVpxIfkr+SZSHmf6U3UH5tyEyXbyEF48hEx/abecYF27hg22OADfz7DIeOBbGNMhAOeAc4quxPSBAYreGep7US1Yn8Js3B1BADq0TF5vv+y34FcOEToxs4ej4GYBhL8/lzQ3wPL9DCNNdQVtlUWNTgMr+Zhuy6oDfP77yphRn3R5MXJT6oei/4FtP3RuknkOTHwd0/CfHWSPN3RJpQLGMP87J6hfakOhD8zGuMf+wF1OX3T8PWGl2fVBB2OPWAOwy143Jf0r9ICv/CXcIN2iPADsy/RowVVZ1QnnGHEUYIE0+koI5GLrjDOrSFXq6nhApQ6aMG6G1rIDQ2MAYgxEJ9zEcyA3rUcy9XDu9IUpGLPobfbUHbKnqNegI7ZNFhH2CTqWJwEdxg4qkRuPebDjvNK/CSC3Qydlw6HhSA02mh8MVsYLuY4ts0L3lnIm1ceBCF/aYSpS78W+XzWSWioNujCPSmrDBTe55isxz24TUnfGEt8EEbOuWgerSiPxsfVYJcioyiBMc1txAv0QbPb09EluMWFzKAUP7tkbDC+9PrJYpATFl6gbyjzXgzTLKbOBaI4FbNu89Wp9fptmnrgq/awJYP9oIN9le8tv7Gvl30w4fqIcH6RxPqfaT1jyb8gD+aEEom3Otu5tjlpZeQ/N7b9ztuo4V+B8yqdzwAxSfYH4GBDw/YEcQWwCNeBrNjuwnfUCx39/gNFvCdQWqRfBLYkQqPotrXMyoFQ+tp+RkbNh38DN9tfHZsvYVzcY5912gUfhxi6ptZhn+Gi/jvfvQR/sAXnXtkgkF0/SEqW8MwxtMta+5VJWf4gGI+Pv4PDX79LQ==
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 'Delete Access Profile(s)' (delete-access-profiles-in-bulk)"
---
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"}>Delete Access Profile(s)</h1>
<MethodEndpoint method={"post"} path={"/access-profiles/bulk-delete"}></MethodEndpoint>
This API initiates a bulk deletion of one or more Access Profiles.
By default, if any of the indicated Access Profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated Access Profiles will be deleted.
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to delete Access Profiles which are associated with Sources they are able to administer.
## 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={"accessProfileIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of IDs of Access Profiles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]}}></SchemaItem><SchemaItem collapsible={false} name={"bestEffortOnly"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use.","type":"boolean","example":true}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use.
</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={"taskId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"}}></SchemaItem><SchemaItem collapsible={false} name={"pending"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>inUse</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of usages of Access Profiles targeted for deletion.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accessProfileId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usedBy</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of references to objects which are using the indicated Access Profile
</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={"string"} qualifierMessage={"**Possible values:** [`ROLE`]"} schema={{"type":"string","description":"DTO type of role using the access profile.","enum":["ROLE"],"example":"ROLE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of role using the access profile.","example":"2c8180857a9b3da0017aa03418480f9d"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of role using the access profile.","example":"Manager Role"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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 \"taskId\": \"2c9180867817ac4d017817c491119a20\",\n \"pending\": [\n \"2c91808876438bbb017668c21919ecca\",\n \"2c91808876438bb201766e129f151816\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438bbb017668c21919ecca\",\n \"usedBy\": [\n {\n \"type\": \"ROLE\",\n \"id\": \"2c8180857a9b3da0017aa03418480f9d\",\n \"name\": \"Manager Role\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"pending\": [],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438ba801766e129f151816\",\n \"usages\": [\n {\n \"type\": \"Role\",\n \"id\": \"2c9180887643764201766e9f6e121518\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"202"} value={"202"}><div>
Returned if at least one deletion will be performed.
</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={"taskId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status.","example":"2c9180867817ac4d017817c491119a20"}}></SchemaItem><SchemaItem collapsible={false} name={"pending"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of IDs of Access Profiles which are pending deletion.","items":{"type":"string"},"example":["2c91808876438bbb017668c21919ecca","2c91808876438bb201766e129f151816"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>inUse</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of usages of Access Profiles targeted for deletion.
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"accessProfileId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the Access Profile that is in use","example":"2c91808876438bbb017668c21919ecca"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>usedBy</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
List of references to objects which are using the indicated Access Profile
</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={"string"} qualifierMessage={"**Possible values:** [`ROLE`]"} schema={{"type":"string","description":"DTO type of role using the access profile.","enum":["ROLE"],"example":"ROLE"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of role using the access profile.","example":"2c8180857a9b3da0017aa03418480f9d"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Display name of role using the access profile.","example":"Manager Role"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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 \"taskId\": \"2c9180867817ac4d017817c491119a20\",\n \"pending\": [\n \"2c91808876438bbb017668c21919ecca\",\n \"2c91808876438bb201766e129f151816\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438bbb017668c21919ecca\",\n \"usedBy\": [\n {\n \"type\": \"ROLE\",\n \"id\": \"2c8180857a9b3da0017aa03418480f9d\",\n \"name\": \"Manager Role\"\n }\n ]\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"taskId\": \"2c91808a7813090a01781412a1119a20\",\n \"pending\": [\n \"2c91808a7813090a017813fe1919ecca\"\n ],\n \"inUse\": [\n {\n \"accessProfileId\": \"2c91808876438ba801766e129f151816\",\n \"usages\": [\n {\n \"type\": \"Role\",\n \"id\": \"2c9180887643764201766e9f6e121518\"\n }\n ]\n }\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"}><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