mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
105 lines
38 KiB
Plaintext
105 lines
38 KiB
Plaintext
---
|
|
id: delete-access-profiles-in-bulk
|
|
sidebar_label: Delete Access Profile(s)
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtv2zgS/1cI3YdtA9uxHefhfDkkTbrIIt3k8rh+SIMrLVE2tzKpI6m03iD/+80MKUuynUe7xW13YRRtbYkczvM3wxHl+0jnwnAntTpJov0oEZlw4iCOhbXnRqcyE/ZEHRbZp6gVOT620f5N5G+z8n5024J5NjYyRzpA5WoiLTs4P2FSSSe5E5ZxNgIijOjDIKZTppVg2rCpNoItkOx8UB/U4QyGp7zIXIvJlHE1w1luIoBsImMgmyzOY9zgXVZY0WJKz5ez7LPMMjYSDKRNtZnCVK4SIraxIdW1FRsbLJUiS8o1jLA5TKwWs3S5sHxMH7lj08I6pGnEVN8BxVQa6zrspCTw30LAAE91Y2MEX45TWNydqWwGy4GONjacKWDpFpvoz+JOmFa5AApiRA6jgTBI1OR0zpwnPioc4yCfhlHmCe2USvBWTkjLB8zpT0LBPTdBm7XY2cXP/zk4enfya4tdnl1fvDkuv4GxwoXL60O6xnjhJtpIN0NpUGJpYF2nWYz8uOAHoBPFeJJItEULfGGRzJSDbUEraLj5LCTjOV0WZCLjCemIW6tjSdKSBJe6MLG31cwPGGUCKfFkCt5onTAdcOVgnEOdzKL9+6jkPNpHe7SiWCsnlMNbPM8zVCdwvvmbRfe+j2w8EVOOn9wsF+DwevSbiB3QzQ3Gk5MQFTi3HkcnCV1rRsopcIQed3Jk8b9FOYHvmrkwBP163Bg+g6/Siamt8WGdkWocPbQi8YVP80xguPbjYW+vuzfY3ev1RXfU6/bg0253uzfsDUUcc6AThuyFIX0aInr9Ydrb7u31dqJbINl04GVZwO8rf7bAv3JgUftJ5gzCw9QD2OYiluC7yy4qU2+6mCulXU16+Bhz7x7Bsj7OKd42NlKeWVp4ZdRzB4rKKZQaQPI4fNSUPdI6E1xFNaWilA+gEicdfo0agIloeURMX3gva9jjfkmP3uWWfeWmMsvOYGtvRGbZ2dkbDVdZjobwPRrStNwDcloiBnlLv9tdNt+FcIVRoCIKRJk+CllzVSOCPgHiC9r8TjHluP2EqWrR5xdz0MlRaWScERAD+BdfRFw4mEH3GkmpwyhxgetRpgBo8VjmsXcT6bSt466woIoAUM7w+BPzVzt1Fykts4PBxuNB4sMuHgx7vd6Q97voFbkArAbmK2nKyP4qmKjgMBCsRPpKkChdbeRdLe4/6mrBGxdBgjLUi+UJyW4V8nEzprAH73tSmpdB79f4S5MVn+rBLbwnrzLx40oDhcCc5HD2Yo0YkQojVOzB3wtXN3BhS9d9LM0/paOFiAdcqxH0KmO5J9NZjjwi9pwej67OGI4gYZ5bQKhiit53cXZ6jGVkpVq6gv70YtM9v1jNbntot+1dPhxtJbwLduO8uzXo7Q32uukwwYUVn75EWmnzDIoXHP2VTLzjCpzfMLRC9OBRemU+ucYgiR6/X883HuQXEs4cZW5u5wF6syJEnk8m6M4YsTQ/aIb494ZqEIC/ASKGKRJBEtHD7UNISP1u/4kchGnaMUi7GBVKVPuGpTp+nVrWqWWdWtapZZ1a/ozUUkJm6a8cgGirO+xygqRBr89LSKoh0s3q0VupmHv3D5SoBqs2S28yCQmHHRsDGNJm9bxV7/2MdDLzAX7HM/k9c1UiHJfZG528wJPeSiXaY8MlciiI5Rgmou/cScJ02r55kiVU0bimW4EmOj12yBMWNrbsTRAG/QezFdB6CSBeKwnzWTmFSY/FjywrdgUf7XSH/UG6M+C8vzfo7W6PhinfAt/ZHg5x9Sk4iLf3M2D4s1DCyJhlOgaL/A4KMVBkQGGBDNDiL08EROMF+r8CufzYuZiBX+bEF4cNscM352ywyzKuxgVd5+MFJaj29SVcUUWWYUsr9CBagYkzI8dSrWKlxMGj47cH16dXcOXi+F/Xx5fwCWkt9W4PVAn/wCr4wkR/Jo6DAJ+5ZRYQIcaGFNsIVDdAIK5sfaD03+zMgjLLRi7MCKuvmFEnzVKjp41Qorj54tgr2RGdFsPWBJtyB7lrxC11LXwxhfiVu/Zp0OQGmwieCPO6ww5CA5JnDKIRiFLbEbtDSVI1WdMCQllQM1EXjintZLwAr5Uqm9aoQPS0bhQMDuD8eT85iF0BzJGY9Sice0tgsUrPXnNN7q5qSiOVzpTjMUjBs2wGajQGNEwtYwnpP8ARmssC8Khy3Byx6rmB4O6dZ+bIabpHTbnn4+48A/hpk2jzG3ciBB8VJB6NxLxPDJoIiBTqZJocRs3NVQa+74SvY3cdu+vYfWHsLt4sS7xwl0qf3nLpc63CQx9MnkuljyHvUbp8MvQ7lTfBkPQIKZRIv7y/Ck+eaOec4+OX71gf+VS+xPzB3B7++qgsp8vUX9kCGSQ9eglSQCKR7BPfFce+uiZVbS2v9labkQQHVStKREBNw2a68E/6CqWQE25bLNHCqp8cm/C7eZVPCIirqqSda6ncupJcV5LrbLTORn+fbLSuJNexu47dv2bsPllJzrmiaAl1ki2mU25m3tPCfZSWMxhQHW+ahxyZarFaQWJsXmNFzcohGvV7o166G4tBwgfJztYw7cc7fb6929vtjQb93aie62+qOJ4HWTOmavb2diQVQxGHR1sKBc5lndZJs/0H6jUiRVijI0hl3Qw670S+v0i1Y3+4XDteac3e4VGVUCHZRg2pKh0hpsHYKY415VgYwNkYcFHhkzKp/bE2ORVAxYDTsExOJQUvSgF0zax9kDoQxQdK6WS1U3BxVgCHhASZxqpZg2NJPKKTYs0HFKiCHQM6f8fqNJjoD1Xy7AIlPkWJ2fGXWAgM9Hnlvr2qv3sCzBvEiEtv4EcavX63wxU4AGwIPGbN6851fb6uz9c5fp3j/x45fl2fr2N3Hbt/zdj9ivo8VEOP1+cw4MX1OYztdNm8lnqLzvV/L9MpVAIH5N5Mx3FhqN1c1uCgBCvgonQzWuQa6vo33pUPoGjHyJSJ2vfd2HY4c7E/pWMW0e3DLfIInojy5NoSBnGcFm02p9hNPBXW9kfaI1wUq0svWGEymDBxLrf7m5v3YG+w80OH57IDMAgmdzOlP3diPd2821qBXnjMwEcqLJYUMXWt8SiZX6RDVjISA8GjJi3gbUZ6QZcH21F/+Un65YmUmS4AJ4lMCw/mBKeky8BmDjuSnyyN7pATLskIsl2b7OE5ef699ZQcnsgjcqxS35NrwXgGXC6Ih+zfVj5yiaW7X33JU6p0hNu9/tJiZziszw4FN7Cv8E9AXv3y/uo1G2PBSoDhT/kISa/zcHYOLkKAeFA+DcBJlKOMLsYTf7Ss8bwFA5ClGQjMPqhLIdjNSVDCr5ApLgDaSaU4SRCa4KzbV6VlEnEnMkyinUqT6HgQBJugoU3emPeaEibtLKTCU5l0tfNBtdmRRByjdzFwTBCRNorsJi/l4jW5vpWJf5TU2iHkiJp9vcCFV+1N7M/vxIACSIJnlrT1zYt7eu0aPdyGwRWkusgDaiLw0XxKFpdW+2Y+GvTaSK/Jxwf13p/3a0xjHr2YhWSaJeyExROtrfgnY+g6GAY34wKi6JvZokOGbYqIdr9bY6ntl2zLNtSWxN8pBIbyzsRHmNuptNFQ9anEh+RHsizE/Ed6A+VjQ2a6fAMpGEcmOrbfzDMu2MYF2x4DbODfZzh0LIhtlIFwwDvAm8r+hASB0RrmeVorUZ3Ib9IcTA0xsEpUbL7vv+xXABc+MbqBo+djAIKxNJ8/N8T38AItTHMNZZVNhUUNLvObaciuC3rz/M6bWphxfzR5UeKDqveCbzF9b5R+BEl+HNz9kxBvjTR/R6QJxTL2MC+qV2iPqwPBT7zG+MdeQF1+/zRsrdH1SQVhh1MPOF85Lncl/Wuk8C/cJdSgHQLsv/xLxFhP1cnkGXcYX4Qv8UQK6mfkgjusQlvo43pKmAClN8pP71oDobGBMQAgFipjPpIZ0Ouw97BhVDGYGzeLeAIEqP6mw67xEix+jg7DjkongmJuOi0UvmQNTBRTfDPmOU9LpI0LD4iwd1SilMy/IT6fVaIDujCqgt56FWZqz1JsfMOeuuZQz6wF/mRD1xsUiRbx59yjSpALkZHH47jmVuA52uDF7YnIctyuApoL5d8ECSu8O7laogjElKWXwTvajDfDJLuJY4EIbru8M2x1YJNKb8zAzg22dA3OV7x9/sq+XnSo+6rXv/7tg3o7aP3bBz/gbx+Eyge3rJs5NmvpXSK/hfZti5tooW0Bs+qNCwDjCbY5YOD9PTb2cBf/gJfB7Ng1whcNy006foMFfIOPOh2fBDaWwhOl9tWMKrrQQVp+VIZ9Az/DNw2fHFvvxJyfYfs0GoXfeJj6npThn+Ei/rsffYA/8EXnHpRgEF2/j8oOL4zxdMvSeVXlGD6gmA8P/wPpQ+kf
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to '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 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><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"}><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> |