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/patch-entitlement.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

133 lines
49 KiB
Plaintext
Raw Blame History

---
id: patch-entitlement
sidebar_label: Patch an entitlement
hide_title: true
hide_table_of_contents: true
api: eJztXAtz2ziS/iso3lVN4hNlSZYiyVV7V4rtzGrKsb1+7NScnZpAJChhQhFcgrSjTfm/b3cDfEmyLTu+m50pTdU4FAk0uhvdja+bIL45KhYJT6WKxr6z78Q89WZHUSrTUMxFlDoNJ+VT7exfO5W72vnUcHyhvUTG2BU6Xs6kZqOzMctin6dCMx4x8VXqVEZTJsquLNN45/qni9MTdoajfXozS9NY7+/upkqFuilFGjRVMt2dpfNwNwm8d8NW5y3TiyjlX5s30U10ORMsUGGo7pBUIEXow3iJYMQ9n4Rin+3sJOIfmdAp/tzZacCNOJG3MhRT4ZvfWkxJGPNL3UUiMZcRn9suFRnxBo98uDnnUcbDcHFFkvofaPydHeTs55mI2EJlP+TMIINEucFUFC7MNUsXsSBi5qf02TzTKZtAp0TdSl/4TXZKj5AVBppVxAMPDQ8yZXcq+oF6zJUvQQXQYxywFDSjah1zgg3spGcqC33mqSQROlZAKVXUJxE8pC5NhspdZtXLoEOUwk2dxbFKQGqkPT48OrkcX/5CkzICWl9A+juZztjp+Y+/jg4/jk+YStjF6dX5wZH9zbN0phKZLpAATpFMBLHhgUqBF2NFTbA7LWBYaAi298250iI5UFEqvqYjoID2KP1ov2JY+zAtfCqcT/dgmzFPQJhUJJp6o2Rgo9IHsjIyZj5zlk14fMiUUWHVXoE1mklonrPr7KdJJoBDbybm3Nn/5qCWgIJOE5hwaCm+8nkc4q2ON2wPWgPeH7T3WsMWb7XhqtvutAX832sPnHvk19rqe+UvkJyHkoLzwSWP41B65KC7v2kVucTMf+ElPl5hgScJX6CYqZjryn01+U146YrMI4aOSH7ITvNIwLhmvghkBDMzWbDr8w8HDJ2Quey5blvT2jUEG6dhlI+TlGDsSaUgPuHRGkUuBxmwzYJLmBn0GJEEKpkLnFsRZXMchvs+DTxXt4Iu4pB7eGVveCpGHUGYSpGRcrbylveWyyc5GjHzwCpGSZi4BOw6BgdDK4InaFApT6YiRUOaIdsYG0vzAiF4EMDsGHWnVSFrtrRbHRtYvOVhJkh3kTgNyNIfNsQTcceq/UF8tPGy8X2j6I5STEVS7b/XapU98ueVLoV95W2KGwUJMOYUhppkqZlx65XxTIYyBj+oUMutOCdmft+vWXUEIy1YPWYadAjmUFdioww0+OwG7ePGoUh6k085/C7a60cVB3wWfP0EbkjeUPgOzkvR99qYdcUAjVU5u5XFySkmEqPK/aeSAGnpI/8iyGAqManSm6QoVzYmI4jegqIp9l6zSFviuBjcaQZ/YPEJU4m37FI65wtSplnfTETnDNft0C5rRL9Zcv4SQRsP9inFWaObkdZyGi1rBJ2K2QV9Y7mhExiMlQgpPEka/ROMJ3dre/cHXArzpbTSFe7nGIORBa/RmAlVueR58123bOkE/Ul7MuB7bi8QvtsN/K7L/c7QHXRa7a5o7/VFe+gs6cYu3mpJmFdQzQOUlzRDrUB+GQVqjWaeVAT1dyohzgaGHHLgCueXy2tvsNfu9Ya9XqsNV8PeoNvpi16308XlFRRzbmys5B/jwCupJilp1+fejAR6MS1erppVD3ll9VzA2lSdyxzhFiHABIbnqEgDyRWNPEDXhHBtAo3Rqw0bTfZ384jmCwDiEgWKgHnUshBax8IjRIyx0IBbS+sDEImAPYK36Z2qyWypWIBLSHSfHY4vzo5Hv/x6Mvp4RJH28Oji4Hx8djk+PdlootbmCtWJq46Q48rKIDbwGe/2fZKnMgWvacfggBDolok/13HrECMPYVF9DV1H2UQwoyd6RhnMK8pnLGbVKCnt2WQuCa+UMlWNB+WjxyAE/oeYExMsbdbwTqu1yva5ScGs2S+nHQDBrZM0CbA+mBCszQIK8FXH2BgTNsHYVUYoaVrJZwb9bhAM2xhR+r3WsO9zLrz2u7aH+McAu+cOZNVbDnXMswgESy7BeTtI14M0NRWbyCDBdO4wF19W6x3oNSfTcDBx4KBVBxXtpnKJgU6r03LbLbc1uGwP9vf29nudZqsz/F/kJU+7v5eZkEPUKoh9F0sFun6+7ouuq7MwF/OJSCC9gHnNwpCAnAVwK8vPI6MZlL6aX9fGOjj5S23SG6dXtRunyRRv6TBOXZ6lam7g/eHBX/DpqLgzOsR7oQKUiorRKks8cUFOckqecUn8bpRuUntTBllTHQgSNTdQkMZg1hOrQk0TlcWUUZawthx6Asmz4BGNHXAA4s5+wEMtVngBjTO5ygCVeCpwuRjXTpEXqsz/EdLeJHrtcYk0m+a0V8euUVpVdt2c1im/umT8PqZTTV9eVXn1vGhZc/VE+akSzpzHqJ4gEcLF+MG+iIVrHC7mMtGrVrrQqZjXc3PCPycmJadrQl4UVwDWm+rjWWU1sZwaiq+39FgOx4frVp1O3+ODQc/vw6oDV57oDHir1RITZDPd2KftGNiwAasvwEoe3vGFRvR445hy5Y1TY8DcfN7iZodZiainhxfu6NC9MJpbCauIHgy+x9U+DOuVnQeM4EICcYN6Dy9PyxIIpSA2hq31oJfNUlG3XgfkahPHO4HPPY/3xF63F7QHk6A/7Le8YDIZBMLrPE+jldL2UwNLn54sWPsx28gLhkXetLbCVA3+xEKTjSNwCUpETDKBLXIi6N5FnbzGVDFMtYZEhf5zEYhERJ44TBWV1ZaMArGxLxOYxjORzCVk41imenHZ9wFzKWlbmwFBUpWYVOqCy5AKnICZAZzwCdf2dQH+QqH5dJqIqUnsMOJ4kJGpOcyYiTfavLvQZaBqgI8widWROBY84SA/8wCg3/JkAcgomYoQK1HpnQD0BBCJdJTCwiOpSJLT180VQ07kdJauU9BS7KR3DpAiUnP2RjSnTcY9KgK+hSfcJIJYZM4Vw/G9EyT3UaWwSzVm7p+CKeSL2fJErKnIXhwdHx1cGlswZDZyAltLxtErbN3Rm50p6BDksOKoqLmGswoDv1w0f/z7r/95eT46uRgdUL5ZtczSHMgqMdrb+tQGlldUlZ9Y54+lptA0PtT4Tz5CA9dNHi0amLrdzSTmcDgTR/Vl1NSlTJJUll03K5k1nM7Qm7zzWu/cts8HbndPcHcwEV13stfu9IJOdxB0uIOutz6NfzQ+1+2xnua/FpAwySvlEXlFpSiQ3Epexxxzqmt4+hbfyZmsWER+jB7dZOwDDsvmwIw2dm/5X1jkPoMxIoUFFnBFb8ajKb61wJcdASCMevkojwPAe/MmImUB3gHn1TiZ19UpzNNkC5zLl0q+uBUhctDUEHcMl56a70o/2uWx3IWowHfBD9zKwG/Zf7PPqJHPBffNNeCqVl55NUxXxarbCalMSEUxj81LJe58XOdtsE6tWRiXZ8ekdwzrJVyC5jaoajaZUYhRK8SU1M4wXL7CRC4RJ5sy9rPRnPobTerjZdJHq6T/F2XRSlqxcX2zMv/V/SemmtZdV0A7IBjAjpIEBHDZuUgzTERz57QZFpsonzYbyAiULF+znOaDycvwQPkbwNcPMhIuLM/0Ul0Qyx50tPsz8N3AHIAWMyQLqI7tagpFTTTb7D33QV4j34EVBhWYcO8L0BpvAOOvIvkPfG9qu9TA/Oqwoi/45F1r2OkG77qcdwbddr83GQZ8b6817A2HVBITWvOpeBp1/SgA8UqPUZYt/ykwGHFty8I0+GNItj4HRGPD9MG0LcS0/DLcVNJgnL0/OGPdPuDOaJrRfT5dUkLkXl2sq4MZwqcAu+TaSkeeZhwefRhdHV/CnfOjv10dXcAV0lpJOkYRWKuPZgmsgi1QObsUAKOSFiHtGGiyHUt1p1gsiobS/DLwm9l1DXrY0df0qJIuywa5K3lmBw57I5ui2YAwgrVLineYDPg5KN4ZeZ6IU/fYanKHzQCDiuRtk42KWkL+0se+bOa+X76xCTJwZUGFcZWlGBKlJ+pzUapyeUHIo8hxdVLQOYDzDTZ0eClETrKJmhcW1mJZtPMDPBvN1bm7rCiNVIqb1yCt8Cgo0/4rWKUmIBtmPzYcUd4IgSfK2xURqxYckZuPhpkclns80xv43VkI4ccl0YoHt8I6H0EBu1uMlSWfPCLZF5XUOd9Tlusid3yzWGx9d+u7W9/d0HeXH55b+G2fEvRpr0Kfq8juo8TFcwX6JGQ9kco3W/7T7JczE9lAkGoh0k8/X9pdm/QGNcYtUq+Ij8xSvsL8qJgPc3+S74zIl/5yLpBB0qORIIBIJPx94rvkmBRlVLW3Ohqg24kEA43WQESImglu16XNw0kWRcgJ1w3mK6Fxf+2MQ3zk4BFamwiIo0a+a7D9FklukeR2NdquRn+a1WiLJLe+u/XdP6bvPook61vKLU7S2XzOk4WxtHz/HEjLGTQoC8GFyxW7fapoBYmxAmM5deTgTDrtSTvoe6Lr867/bm8YdLx3Hd7rt/vtSbfTd6pr/XXpx4WT1X2qMt9mHs17dpHcAo7LIjAunSrl18t/GRa1AwxrtMsxx82g82a+XY+wY3cVO56oFGQDwoAdkwfKi1fnx5VaOke9mff+qnjxTqVehJRU3KWv4rbQcQsdt8vPdvn50yw/W+i49d2t7/4xffdZ0LH7FHTsPgM6dhlCrAAh1u8JHX3AHQjNApgUkMF+7l5+xstrH63YDVg50KuhyM5wzfcpSrGPPFrkYEnXKpFRqS4Mb9B2jm2TvC004GwKITLC7V4S0C1aFX5TAJgUP2gJ5VySH6NAQDdZuCPaMmB8pvwKyo4iIy/MgEMKCqHC2qsCG5O4LSBA+AcUqA46hUD9ijVOO1vfVQ9m5yjxMUrMjr56QqDPF/Xf3rpdAmP8IhvDxYWZ6we2C5iaOY8gjRBfYxO+Cgi6hepbqL5d7rfL/Z9jud9C9a3vbn33j+m7z4DqFg09DNWhwcZQHdo2W6zAUh9og/T/N2InV7EckHkz5RFW90sMTrgCTKk4zMwpP+Cu7pzf/Sb9ewe/aEBUaBjKkhCa5Ruev8E8wfzcN3ksm/nnRJG6o13PuNt5TdzBbabGx7ABnYdmBjAfmCcSjddEOiJu9Gy3mzvFxupHKdOWf5jABWQfzJBp4AdI1pDoNrAYQxZRfN1uDtdZkg/kukrC+++XxRB6QJZ16nt0NGjPgNMlEVGET+WhYPQxrxl95WiwchnBYn9nZbBTbNZh7wVP6CQT3P/y5qefL9+yKQJNcnRzSp2QmBmAq5yBiVAgG+V7QbATrS2Jyqbm8/1RbbcNOg4LQhCY3UQXQrDrsVXCCUT4cwjJpFLsJCgKYK/Nt9vzWr+3tNBRRoDHiiTzfK+/yw7pqzH8oInaWBEpwWPXcS4Xr8j1Uib+I6fmGmouUdNvl7iwBwCaj7jwY3xSCw81aevFgxt6boWeS19DuUh1mQfUhOWjvkfKy2ftxXzU6LlIr84HHhKIXzPVuzETtPIT+sbMmymlxf8whqaDbnA9zcCLXswWfULlkke4nVaFJdcM6UoXMCHxdwyOERlj4hNck+1pGlQdIZf8TDMLPv+Zdv9/rslMt6/xHCpo6StPv5hnHNDFAV0TA7Tl36xMaFjg2ygDxQFjAAfl/FMksIxW4p6htTaqE/ld6oNLgwesEhUd75sf+2WAs1eMHmDrog0dveWUu8bwgwxLC5enmrLyYsCyBlf5DRWsikt6M/wWrzRxpfx3kxclHpU1E/wQ8bWj9AOR5N8n7v5OEW8baf6MkcaCXKw9npenhh5915GDeCpqoEgKm1xUfea9hX+rJUFNJzXBX3hKrk/wHJKf8kyjKiHgKKXzKTBIeDMpqJgQC/OFWoPZczkEHmioMJrkZ4JN6cSeBDTAIf2TIdCjcnc+Mif/MzgVzQR/68xuvlD2S7om+xm/2PRgljG3w22/8Ow3ZZO84vN2dpjbDmC4+TyL8BQBYDubMw4W+oSB+VJ7mYmDkOpFIteFIiRZ9MqDAlouitCkLCeZ69MA69QSj9RwNhwLzEjbIjWoHmfRnqxZCnIuwuJky3oW8BRtMF53JkI6wAaCOOA5URnh4/hyhSIQi+ybETwO1nbSu9gWzwwC4Y357DXbzZZL2QeejqN0Cvlwhbg5lXbp9K+VU2WK2vz2COrtEdSvfAS1RSiYWu7GWAxFQ81MqmvC6nX1GDj0rn3p4yEiM7BmfPrtG1bLMM2+x9tgDliKuf5UZtAUssHb8Npf/8151cjfnFuG37Inz6tey35e8Y0W5SqAZ918EVgjAu7prBFTxCPezAP71silk7PKjo8dT40lB9PZ1Agf6UZH+xZ1m7PR5cFfofXEHoc9NzWohN/BTfy779w4dECPsUlz4gfe/+bkFV1oYwjnkHsd4rQXMB/Q7F+mcCCq
sidebar_class_name: "patch 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 'Patch an entitlement' (patch-entitlement)"
---
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"}>Patch an entitlement</h1>
<MethodEndpoint method={"patch"} path={"/entitlements/{id}"}></MethodEndpoint>
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"ID of the entitlement to patch","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121e121518"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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></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={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The value to be used for the operation, required for "add" and "replace" operations
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></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={"200"} value={"200"}><div>
Responds with the entitlement as updated.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The entitlement id","example":"2c91808874ff91550175097daaec161c"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The entitlement name","example":"LauncherTest2"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Time when the entitlement was created","format":"date-time","example":"2020-10-08T18:33:52.029Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Time when the entitlement was last modified","format":"date-time","example":"2020-10-08T18:33:52.029Z"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The entitlement attribute name","example":"memberOf","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceSchemaObjectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The object type of the entitlement from the source schema","example":"group"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is privileged","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is cloud governed","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"}}></SchemaItem><SchemaItem collapsible={false} name={"requestable"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement is requestable","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A map of free-form key-value pairs from the source system
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"A map of free-form key-value pairs from the source system","example":{"fieldName":"fieldValue"},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></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"}>source</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The source ID","example":"2c9180827ca885d7017ca8ce28a000eb"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The source type, will always be \"SOURCE\"","example":"SOURCE"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The source name","example":"ODS-AD-Source","nullable":true}}></SchemaItem></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"}>owner</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Simplified DTO for the owner object of the entitlement
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The owner id for the entitlement","example":"2a2fdacca5e345f18bf7970cfbb8fec2"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The owner name for the entitlement","example":"identity 1"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"The type of the owner. Initially only type IDENTITY is supported","example":"IDENTITY"}}></SchemaItem></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"}>directPermissions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div 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={"rights"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"All the rights (e.g. actions) that this permission allows on the target","readOnly":true,"items":{"type":"string","example":"SELECT"}}}></SchemaItem><SchemaItem collapsible={false} name={"target"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The target the permission would grants rights on.","readOnly":true,"example":"SYS.GV_$TRANSACTION"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"segments"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"nullable":true,"description":"List of IDs of segments, if any, to which this Entitlement is assigned.","example":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>manuallyUpdatedFields</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Object contains entitlement manually updated fields. Field value is true if is was updated manually via entitlement import csv or patch endpoint. Field value is false if that property value has not been changed after first entitlement aggregation. Values for all manually updatable fields must be specified. For now only two entitlement fields support this: DISPLAY_NAME and DESCRIPTION.
</div><SchemaItem collapsible={false} name={"DISPLAY_NAME"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"DESCRIPTION"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","default":false,"description":"True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation.\nField refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property.","example":true}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c91808874ff91550175097daaec161c\",\n \"name\": \"LauncherTest2\",\n \"created\": \"2020-10-08T18:33:52.029Z\",\n \"modified\": \"2020-10-08T18:33:52.029Z\",\n \"attribute\": \"memberOf\",\n \"value\": \"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local\",\n \"sourceSchemaObjectType\": \"group\",\n \"privileged\": true,\n \"cloudGoverned\": true,\n \"description\": \"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local\",\n \"requestable\": true,\n \"attributes\": {\n \"fieldName\": \"fieldValue\"\n },\n \"source\": {\n \"id\": \"2c9180827ca885d7017ca8ce28a000eb\",\n \"type\": \"SOURCE\",\n \"name\": \"ODS-AD-Source\"\n },\n \"owner\": {\n \"id\": \"2a2fdacca5e345f18bf7970cfbb8fec2\",\n \"name\": \"identity 1\",\n \"type\": \"IDENTITY\"\n },\n \"directPermissions\": [\n {\n \"rights\": [\n \"SELECT\"\n ],\n \"target\": \"SYS.GV_$TRANSACTION\"\n }\n ],\n \"segments\": [\n \"f7b1b8a3-5fed-4fd4-ad29-82014e137e19\",\n \"29cb6c06-1da8-43ea-8be4-b3125f248f2a\"\n ],\n \"manuallyUpdatedFields\": {\n \"DISPLAY_NAME\": true,\n \"DESCRIPTION\": true\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={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</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={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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