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
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/get-access-profile-entitlements.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

87 lines
38 KiB
Plaintext
Raw Blame History

---
id: get-access-profile-entitlements
sidebar_label: List Access Profile's Entitlements
hide_title: true
hide_table_of_contents: true
api: eJztXHtz2zYS/yoY9maSaERZkuXY0kznRrWdjDtO7POjuTs700IkKKGhCIYgbasef/fbXYAvPRw5ybRNTn+0kUFgsdgXfrsEeO+oWCQ8lSo68p2BMxbp0POE1qeJCmQoDqNUpqGYiijVTtNJ+Vg7gyvH9GG2k3beNx1faC+RMVICOhcTqdnw9IiFUqeapRPBqqQY11p5kqfCZ7cynTDOxvJGRKxO+Dq6joYsVR/gCXUDik12cvb61+HBm6O3TXZ+cnm2f5j/pZK84fzyJ2pjPEsnKpHpjAE/ifiYyQSmTBWT0Q2QBcYMny12FDHu+xL5bwI7lUlX05xmOmUTfiMYN3wDYVzqucoSTywsEh8tWyYINuYJn4pUJCjeeyeCP0CK0odHEuUZ83TizAv56ICpgKh6Kkq5jGQ0XiSdr9oZpEkmmo72JmLKncG9k85inEWnCQyEnuKOT+MQm7pev7PX3uO7e53tdr/N2x341et0O/1OX3gedx4emveGs4+ZSGYw2LIcyqlMFzh9w+9YlE1HIkGOE6GzMCVpJSLNkqh1HZ0Lwa5+2SabOU955PPEZ/sqDIWHNNhpIaD3zydpGuvB1pYvbkSI9tvSXIaxklHa8tR0S/rRFo/llrZ0XK+g45aCfsECMJipSgQYA/yckhe0ahILeKhFRTDdnfYSAcK8YiwSGGnImKbtLjRMQSnTbOoMYNyU35nfRMUXAQcp0F8rpamCQItFcZ5QM7Bt7S3IwtBKlcGDFrvUGQ/DGdOx8GQgcwNskHYaKPiYj2UEpgnjE5WNjXFaxXwz6vgCZRTiXy18T2XRouyPAtZAR2owmYJUQfCxirPQiFKwxr/dC5Xy0N3H0Q0UaawiLdhEcB/MvwgES9xhwoGiykKfjYT1DNCcDAq9gfxYw9hEg90KFNU4Aon5LYyU5zLyBAU5oVMMBRjFgBVGC2Eej2ysYqAjEg72l9OYe2kTV0MhEjQGIdqHiSOVoqVogbM2iMiPtPIG8kTc3vAwE0YK2BvYznTOzTdhQStC4kipUPDIqdgJjVxpKxBrKXivDq8P84b0ioYU2s80qgwtI18l0zOI6nfMDBuhKUR/skh/MOsCzlzL5wvU7au8FU1GZ3GsEtzkUPwUjoCUusXHEHpCX5PdGpyhEj1ACo2G9BuNAWuIj2B6UcO0oTCLVn1rW3kKEhxl6ZJHZH+LzV4icNelB2Ow7RD+Gwv4V9gOU+VTWFzdQ91GILNlTGra3Oce1XbPgmEmPrJrZyrQ00+Ca2fRFFfZk0aJPmpPlfiGLstdLVBvsOxFUzsHan9zQ8MFz5vZuWlbz8hAF2Q/AN5y8TdNfGoyaw9NVuq9pjAa5+YPl2jpPTaZQK5RFd12G/+pS/kYoC7G8znMjNgMfmJ/Hseh9Cgsbf2ucdD9on55knC0BJmKqa60q9HvIDbEigmKOZWGFcCIS2xjHo2DKZZcMcKVC2hvb7cXBP3Ozg6gvZ12f9fnXHidlx0PDcrY5VMnolHVqY55FsGCkwvYorpIt1DW04mXbrYwTe5yOAPZwHrUzXZmMXVlqhrt/bc/1lbRPLmsNZwkY2zSYZy6kCoosw01D/Z/xKfDomV4gG2h8niIbJqwck7WcEKqviB+1+HbmAbDjku4Z0GipsbhTV5iTa66qDGAwHghcKwzd6XlL5JcnMgbSHXGwl+xg9dYhg3fwJc5l9CsQmcOIcAkXqgy/7W6EYjJvmweIsXGOa0lc5lwtYb85RTQ1wQSyvlpbrnOo151p/ChwU3lnLd0292222m77b2Lzt5ge3uw0221u/3/onCLoPiFzIQcgmMlwn4BS8aKv15ktF5xdLAsKHZ3Pb63t+PvQlCEX57o7vF2uy1GyEm6tofaObBj0+BlHt7ymUbIfO2YCgPhg5IB0/i02GunWYiHJwfn7vDANXUJSN6rgXfpHlMnPWRTHqN3B4kQLqqOfRAz14TLmMtEL8aYmYb9q8rEvUMb9dscMMPvXyg0IzO28sLD04oKrTtoMTZ76af3yBJrR5AS81EJ8Zdv1UcHGv/JZ2iix/Jo1sS853YivYkpEB3WHZhrDXkX5DnV5V05we6oM9rj2+5OIHy3F/g9l/vdvrvXbXd6orO9Kzp9GNHte6OXXvul2/H5ntvbFtzdG4meO9rudHeCbm8v6HLnPYZiQCBeeiqSqYQJAXs8BSTMAUDI8kJTCDi4OCkwVEnbbiEAtFLMJxEAngOMO0UY90wzcFI+4lq0GIV8+IvkMB4nYkz1LVK/l8HoKeQ0RvkG90tdWg1AdAWJJjyIYwHYD/NPTEtveDKDCJGMRTgDj0hvBUQRCBUBpLiYuYYStbOV09etBV9P5Hiy1ELmDBkcjwod1J09F61xi3ECo5A+UkpLCo9LwXCEmWAlJqylyGRKCJH7J1E4y+1rhSXWHPrw+HD/AktnjiWzlk+bvjR7hS1TJxiDDGEddjl5slvnrMLAf85br3/59R8XZ8O358P9i6OTt4YbNG54XprDQapMlMgfVTwAH+Cj3jIMvE+qYodJAibmsrNKEcMUmKg4wUbKp4qsjCCGSHKkp8LkFUHfFynY7b7y14iYr2QkXBChRA4FsezBQAAC6kb6mFpQMcGQLMAN9qt5Pkqi1WE/cR/Wa9a3bxeDEky49wFoHa2xG11GEsazfAjg9MJVl0wrdgUfvWz3u73gZY/z7l4PcPuoH/Dt7XZ/p9+n7Vtozcfi057xWkC+Kz1GqEr+AQIBOwLZEwM0+fopCdFYc8cyfYtlWn5ZKu5SLMP/tH/KersQG6JxRu18PCeEyL08d+bjPazcED4B15BLkayIsBJ45RwcvhpeHl9Ay9nhvy4Pz+EX0lp4ozGMwFp9NEtFVbuJuiWO7QIQ42iBiS3sC6xhqTZgQTzS1Y7S/GVCJLPlJRhhZ18yokq63GdzVyK/uUvZc9kSrSZET8RZPIWtCwO2nweuBr4XAFx9bCXZsAXJFy02LDZfkwBpGI9hGN+HmK3A1JjBlQXVL1WWYrlPeqKui1KU87tvHkaOq0pB5wDOP20nQy/NgDlaZtULC2uxLFr9AM9GcnXuLipCI5Fi0QNCv0eVck8luNsyQES0Q9lwRLUHCDxR3q+IWLXoiNy8McyY0AnxjGd6Db87DSH8uLS04sGNsM5Hr0hMNBKsxEh5RLLVfxpsexXqyh3fVEc2vrvx3Y3vrum78w/PbOXPPiXo01mEPpeRfTGMm+cC9EnIeiKVvz3+g+CNVSS9urYQ6ed3F/blM/QXdzGWIb8iPjJb+QLzw0Iftgic14jzrb/UBTJIcjQrCCASCX9AfJccG5BIotpenO2VSkYSDDRaAhEhaiZspjLGQWRJFtFLbQ6pma+Ejp4ted+Os0a+a0rOGyS5QZKb3WizG303u9EGSW58d+O736bvPookC67IWyxO0tl0ypOZsTT7HFfLGXQoDxMVLle83KyiFSTGCozl1JGDM+p2Rp1g1xM9n/f8l9v9oOu97PKd3c5uZ9Tr7jrVvf6q9OPCyeo+VdG30aN5ESGSG8BxWQTGpVOl/Hr5L8PjCAGGNQw9BW4GmYNI3xfYsdtfxI4XSrE3PJrlCEnXMGRUyghjGvSdYt8k7wsd8qOmEKok8IWmhG+uXIaHJxidtELnxVUA3WTmDgM8p2PPb1kjK2aRkRdmwCFFglAhalZgWBIPQwWI+YACIdgxROeviE6tir4IybMzXPExrpgd3nlCoKMXyH1nWX33CJhPMEacGwWvKPSabIdHYACQEJiYVeDODT7f4PPNHr/Z47+PPX6Dzze+u/Hdb9N3n4DPLRpajc+hw9r4HPq22qzAUq/ohPmfDdPJVSwHZN5MeV6WULk5x+B0+gYaZTqjSS4B1+8bUx4CaEfPlH40MNVYNzZ3jgZ4AsF5j4dmpwLs0N4rwwCEt5gGzla9v966l/7DlqgfmzUZhFlbloQwLD9pfA8qB1U/tHgsWxAJcdwsUrd03Phme0kAw5MGxllhSj8zh5jxcLOZpEWKSiT6ggmcNIFRmz3+7xSnmh+ljyev0B5mKoNQSWSaeOrL2iU1A5sxJCXPNPVukR0urBHWdpmED59ajz2kvWIdhsiKdSwT36NzQX8GXM4tD9l/X5oJHWA1sy8YS7kjYcbXXZjsBLt12U+CJ5BamJcgz39+d/GCjRGzUswwp9eFxCQDvO4UTIRi4jB/IYCDaJsqrzUNa69c0AdZEMKCmb2lcmSF8BY2izOI7iRSHCQooOCo9c+589q4FXdSriOXHdDxLjx5RH3sEs29nas4XxevrOtzmfghp+ZaxyNqeMa+xoUR7ZU5bYWnR0ksPNQkrc+e3NBzK/RcOrbkItV5HlASlo/6izIv19pn81Gj5yK9Oh/X0Ts68VcfxkwIY3pCB66OmDdRSot/Moamg25wNc7Aiz6bLTpm6JJHuN12hSXXTOlKF+Al8XcMjhEZY+Ij3N4J3SgAfpFvXPI30iz4/G909u632pqp+Qp2YezpK+8JlzfmeMYJXZzQNTFAW/7NJoeGBb6Na6A4YAxgv9Q/RQLLaCXmGVpLozqR36IxuDV4wCpR0fHA/DEoA5z9xegB9i76QAhGdF68OoS/maVFJ2KrwsrrCvMSXOQ3VLDBzsnN8FvUtXDT/butF1c8LMsveGLwa0fpFZHk7xN3/6KIt4k032OksXgZzY2mtYlF1cgNWlssBmq6Owz/h6fafJ0AgDmkPeV14SqZOOQpHcJHn/YmUlAZIRZ4SDvEC3Dmpgz4IcBddH5IFonQmG6EJMAwh8RPhkCvxd7hZQ0PRIw5Gh68AKq/K5usFYfA2UGuOABQ02kW4fcPgIlsyjiYxye060vtZSYIQcoWiXxlimBcMSr3SDQbFEWLspVkqk8CrDdLvPXhrDkX6DC/fQeCRI3Yq5XlQs5ESFaG/erw+1O0wXLciQjpxhREUABTojLDm6OLBYpALLI3R1Uy3rKD9Bb2xUtqsHhjDNstyA3pWpPSKaS0Fbp0a6H+fYdnev664dwFrqLYvvkkxxM/yWF3QUxftmKs3aFSMpNOmUT2yplLZGHUwNytrOoEsqMJ6BL7399juQcTuwdsNpd+McMFw0LfLW+or1Tjt/UpjaVC/CCwgJJ/KcSWSBwHs+D15fD/9Q2MR+RYfCPkMwW5+aDFt/dBi0fMIf9qyWdaw+arFN/XVykesZTymyWfaSubz0os+6zEIxIvv+pRSvx9WbN9IhJ4fmbB0wu23pfAlnKWv7OMZlW2co4BzTzgXVQT7IlB88C8qKoMWTjKUav/vz5ESMxXFBjsj8EVvnb4HzGhfi8=
sidebar_class_name: "get 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 'List Access Profile's Entitlements' (get-access-profile-entitlements)"
---
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"}>List Access Profile's Entitlements</h1>
<MethodEndpoint method={"get"} path={"/access-profiles/{id}/entitlements"}></MethodEndpoint>
This API lists the Entitlements associated with a given Access Profile
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the Source associated with the given Access Profile
## 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 containing Access Profile","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**name**: *eq, sw*\n\n**attribute**: *eq, sw*\n\n**value**: *eq, sw*\n\n**created**: *gt, lt, ge, le*\n\n**modified**: *gt, lt, ge, le*\n\n**owner.id**: *eq, in*\n\n**source.id**: *eq, in*","example":"attribute eq \"memberOf\"","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **name, attribute, value, created, modified**","example":"name,-modified","required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of Entitlements
</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={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={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The entitlement attribute name","example":"memberOf"}}></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={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of the entitlement","example":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local"}}></SchemaItem><SchemaItem collapsible={false} name={"privileged"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement is privileged","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"cloudGoverned"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if the entitlement is cloud governed","example":true}}></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={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"}}></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"}>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={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"}>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><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\": \"2c91808874ff91550175097daaec161c\",\n \"name\": \"LauncherTest2\",\n \"attribute\": \"memberOf\",\n \"value\": \"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local\",\n \"sourceSchemaObjectType\": \"group\",\n \"description\": \"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local\",\n \"privileged\": true,\n \"cloudGoverned\": true,\n \"created\": \"2020-10-08T18:33:52.029Z\",\n \"modified\": \"2020-10-08T18:33:52.029Z\",\n \"source\": {\n \"id\": \"2c9180827ca885d7017ca8ce28a000eb\",\n \"type\": \"SOURCE\",\n \"name\": \"ODS-AD-Source\"\n },\n \"attributes\": {\n \"fieldName\": \"fieldValue\"\n },\n \"segments\": [\n \"f7b1b8a3-5fed-4fd4-ad29-82014e137e19\",\n \"29cb6c06-1da8-43ea-8be4-b3125f248f2a\"\n ],\n \"directPermissions\": [\n {\n \"rights\": [\n \"SELECT\"\n ],\n \"target\": \"SYS.GV_$TRANSACTION\"\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>
Reference in New Issue View Git Blame Copy Permalink