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

93 lines
32 KiB
Plaintext
Raw Blame History

---
id: update-access-profiles-in-bulk
sidebar_label: Update Access Profile(s) requestable field.
hide_title: true
hide_table_of_contents: true
api: eJztW1lz2zgS/iso7kMSl6grih37Ybdsx57RVDL2+qg82KkNRIISJiSgBcgkGpf/+3Y3QIqk5CNOdndmSpOqKYsEGn1+fZC8CfRcGJ5LrcZxsBcU85jnYj+KhLWnRicyFXasDor0U9AJcj61wd5V4G6z8n7woRPEwkZGzpEOULmYScv2T8dMKplLIGgZZxMgwhx9phOWSJHGzIh/F8LmfJIKlmjDtIKbhmXaCNY6pnutrtXfGRsnjKsFkshnAk6IZQQk4/ZyBiyIr9Lm8JdiJ2bKlfydBO3APgWbtV05g32RacomgvE4BpKwcWvLsRxvbV0rBv+lQLI83Ag718qK7lldDBLMrVhzQsbNJyDNLZDOTSG2tlDgra2EpxZ+PEFKpXMWa+H++CEiA6FjXSiQeb249wpV20ykkSsg79XYJen2Wa4/AUdfZD5DR+mwk7Of/rX/5t341w47P7k8Ozwqf4Fy/IXzywO6xngBkhiZL1B69CBp4PBcs4jDebl3vi4bKxRKkgLAAdtkMg76VemCFaCVcheS8U66oqiZjGaMg2dya3UkyR4kwbkuDKxFJS3cAnQEoMTjDELA5sJ0IX68sx/oeBHs3QQl58Ee+kEniLTKhcrxFp/PUzQ4cN77zWJM3QQ2momM41/NYHvrLeTZnZfswvE1tWP4LuYC1nNj+AJ+ylxkFsn563rym4jyoB3LTS08s2zCrYxYLHIuU4t04UTAkFwKoibjGk2bG6mmD9Bk4zdIRnzl2TzFXaPtERc7kyTc2R2IcLSbxOFkZ7Qd9rf5UIz46+C20iUqunbeROtUcPXQgd5tyogFFwMnbfBA0Xh7e1u7dOVke5i7FnOO1IdOzd5XSKm5DO7nMifxG+iL0HtJNvQYEzyFp93tl6/u4IuELCObLDjs79ztZd6fAJxiiuzydxusgyf7c8tWB7W0UQHQN3jzOu9sHjiOgUsJsG1qYVS5imokLq/BGgOViy/9dxjtDF73+Wg74TwWYtQfbCeTkegPXkfD/vZouMZ/71XBel9dcfmW83aANZ4XdpX8tboANP/54uK00ihza1mkYzwvL4wCo2JG5oqyz2cZFzxtayef8bwWTX6L11VcoGbamb8sN3yiG/YHkFTDFnohzdKzbEG3kiJNF37TqD9atwn9McHUA8vuN1B/gDZoaKWtpJ+LDEQ3gsekd6+f2hoKAfRxDhCPcvpUA1oiz/8KmlGgjoy71RNd5KUwaMYE8LMA/TORRw8xjEJ/k4bORCKMUNEyMst9lLDGMbt+0E2vA/aF26ZWb28fwLHK6+4CNAdmYwjXJyHZ8gBnxnWg9gD6r1VbcPsYBHbB8j0Q/N9inmB81O+vOvJhKgHf2JEx4HQheIYPblkWdcQBm0BVgk4l1WeeyvibAPx+zHWlwiEgy8OVwbFUIpwaCCngUBDLBElAERAIw4xaA0eyrEtpXauE6Pe7A3bAY+bTJjv0woCacsOjT0Br/IhS5VJJ2M/KLUw6iLvjWLEj+GS7vzscJeAOfPh6NNh5NdlN+MuX/d1Xu7t4egZm41NRT1ZlEmse/ZNQwkCplWqoa+XvArslDronBujwx+c9ovEI/WNicGsrMT2/DBENy+iDw1M22mEpV9OCrvNpSwkqvDyHKwp80zk21rcguSN8YuRUqnWsCFVkCCpvjo73L99ewJWzo39eHp3DX0hrpc3cV2VjpCl1z/QX4tgLgOBlRQrqgPqXbXmqWyAQV7a+ULpfdgEZLAPfSniR5rDDn75mR500S4zOGqFUwv9z2RXdDlThcA2yADQPUDvDBq1o+RaG9jwP33pNbrEZZBthXkB/tcwlEI0FdViLRpOGBJICQtkhOuYWAGoZiaYtlqpsWmOJdW/rRsHgAM4fU8HnWA6QmPUorLzFs7hsXJ3mmtxd1JRGKl1ANo1ACujjFqBGY0DDUD5AJs0t83CE5rIAPKpcVyEWQmApFsHdO8fMm1zTvYgX9hFxd5oC/IQkWnXjs/DBR32VQyNRT/kekeAmik2b/arKXGXguwnBJnY3sbuJ3UfGbvtmWYn5u1T6DFZLn0vlR0WYPFdKHyPc9KycJ7lRmTckDZ58ifTL+ws/r6KZ4hyL3x9YH7lUvtoEVvZw1ydYflTGatgCGSQ9OgmwsxDxHvG95JgU5VT1cvW0Y20mEhxUrSkRATUNW+iCRlumUK7dsR2aOqpnOZtxwEfuClVCQDxVxeFcS5VvKslNJbnJRpts9NfJRptKchO7m9j9c8buvZVkxRVFi6+TbJFl3Cycp/n7KC1nsGA5QK9CjkzVrlaQGKtqrKBZOQST4WAySHYiMYr5KN5+uZsMo+0hf7Uz2BlMRsOdoJ7rr5ZxXAVZM6Zq9nZ2JBVDEfcZ6rhCgXPZXOu4Of4D9RqRIKzRg8uybgad+/Giqx0Hw9Xa8RQMpJXzVXZMxWejilRLLUFFuX867h0LTk5LT6wVOmT1sEHXHlv/wNLR6++7yux7WYf62LSYr5Q23F0990Jr9g4f8fuy0t6lMkwEsDbDtaZcCws4m0IyUQyElNq9cCAzAVQMPmdJZSYJ8dD0QNcswv0kB/s7dCkjc2kYFaUFcEjwmWrUgYZolPjsPsFCGShQ2T+FlPZHs8sZSvwWJWZHXyMhEB0r7b9aNxQfA/MGgfXcRcUd03HXIoJXFgq6KAf0VbG+aWo2Tc2mMNoURn+NwmjT1GxidxO7f87Y/YamxldDdzc1sODRTQ2s7fZZVUsdo3P9z3sbChXPAbk301FUGJrRl40Lvgwl4KLMF3TIJTRDh86V96HTcW+yqD03wg79qzJ7YAgsTT/gqyGZAE9EeebaEgZx3Bb0mltsD991Ct1LGmHrvRiqNJ2QhUlh8yzP53av17sB24PNb7t8LruS3kbLF0p/6UY6601A4WuwTNoytnEBvbnqDuiStYzEUx16EnFnO9IPuj7YkIbz91JWPCOnoNbGkekwCB7vnHQZWJxDZ/LM0mrqeTor8oFclya9/X5ZHKE7ZFmnvntPg/UMOG2JiCJ8WPrLOZbx7vQVr1mmJuyXhyuHneCyITsQ3ECP4R4hPf/l/cULNsXilcCjsFg3C4ndBoTfKbgIgeN++TgFN1G+MrqYzojx/cYDKwxGlqQgMLtW50Kwq7FXwq+QNc4A5kmluEkQsuCuD89L68Tis0gxoXaXmkTHg4DogYZ6vLHvBSVP6jJqb7d1r1XI3kjENIlFAK7xIrpXAK/mpVy8JtdTmfhbSS304UfU7IsWF061V5F7ASoCREASPLWkrScf7uiFNXrYksEVpNrmgd6HdHw0HzNGpdWezEeDXoj0mnxcq/fujfXGNuaQjFlIrGnMxiyaaW3FPxhD18EwuJoWEEVPZotekw8pIsJhv8ZS6I4MZQh1JvH3FgJDOWdyr0dSmaOhAlSxC8mPZFmI+Y/0uuXHhsx0+QrSMa6MdWSfzDMeGOKBocMA6/n3b7m/oNczUQbCAecAh0v7ExJ4Rmu452itRXUi36M9mBoiYJWo2Pme+7G3BDj/F6MbuLpaAzCMZXr14BU/f/C0MOU1lFUOGNoaXOU31ZBpW3pz/FZTQcy+fzR5UeL95RzmRKWLH43SdyDJHwd3/0+It0GavyLS+MIZ55lnyy+Xjn7Y9zDoxySPb13q0XPgC8HVgSN9q0Uf1p2OCQSo+IfWyr3ZjuVRndA85TmGC8FFNJOCRhVzwYmbDrqszijEoYRHXKEv4oDQ1MAawAMLxS6fyBTo0TC9PJkb93EIMooOg79tQf0SfYo2g9ZXdNl76B5VBPbGzhHfoYF7v2nfQp6DyU/RY9ib0ougmsuyQuHHbcB2kTEOvvqAq8XSRoVDRGgklSh1oammrHaV8IA+jCLQRyTCZPYkwSk4NNg1j3rgLHAo60fgoHq0Ipb/2J5VgpyJlFwe1zX7gYdogxuHM5HOsXcFOBf4yv3yhHfjixWKQExZ+givq8205zfZHq4FIth3Ofd52R10+yH1IXAdezlo8mrEL9d9+vfcvmh+qIoDqm7bNW+WDwQ2H8BuPoDdfAC7+gGsr8Owge7NcYyMQVi4ht4NVK6C1kAFdt01UoEUMsNhDGy6ucHxI84YbvEyrMHZ1tWH5fgAf8FhbgxJyeuTwPGXf+4VXiyo1vRzrtUHejjVcDvcaPPetfV50ekJDnmDif/oN3OTM8O/YF6E/+8F1/APfui5Q0v8Mhiv3wTlHBrWOLplUb+upvV/oJi3t/8BhU5KUA==
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 'Update Access Profile(s) requestable field.' (update-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"}>Update Access Profile(s) requestable field.</h1>
<MethodEndpoint method={"post"} path={"/access-profiles/bulk-update-requestable"}></MethodEndpoint>
This API initiates a bulk update of field requestable for one or more Access Profiles.
> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
list of the response.Requestable field of these Access Profiles marked as **true** or **false**.
> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated.
> 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 update 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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Access Profile ID.","example":"464ae7bf-791e-49fd-b746-06a2e4a8"}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Access Profile is requestable or not.","example":false}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"207"} value={"207"}><div>
List of updated and not updated Access Profiles.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Identifier of Access Profile in bulk update request.","type":"string","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Access Profile requestable or not.","type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"\nThe HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation.\n\n> 201 - Access profile is updated successfully.\n\n> 404 - Access profile not found.\n","type":"string","example":"201"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Human readable status description and containing additional context information about success or failures etc.\n","type":"string","example":"\n> Access profile is updated successfully.\n\n> Referenced Access profile with Id \"2c7180a46faadee4016fb4e018c20642\" was not found.\n"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"464ae7bf-791e-49fd-b746-06a2e4a8\",\n \"status\": \"201\",\n \"requestable\": false,\n \"description\": \"Access Profile updated successfully.\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"[\n {\n \"id\": \"464ae7bf-791e-49fd-b746-06a2e4a89635\",\n \"status\": \"201\",\n \"requestable\": false,\n \"description\": \"Access Profile updated successfully.\"\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={"412"} value={"412"}><div>
Precondition Failed - Returned in response if API/Feature not enabled for an organization.
</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":" API/Feature not enabled for your organization."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" API/Feature not enabled for your organization.\"\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