mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
106 lines
41 KiB
Plaintext
106 lines
41 KiB
Plaintext
---
|
|
id: set-access-request-config
|
|
sidebar_label: Update Access Request Configuration
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXG1z27gR/isY9sMlGUmW5Hd/aWVbaX0Tx65jN9OxPT2IhCRcSIAFSNuqx/+9uwuQIiXZVnK59u6GczMXiwQW+/rsLgToMdCpMDyTWp1EwUFgRTYIQ2Hthfh3Lmx2pNVYToIWvAhzI7NZcHD9GFxZYeBNJh6yQZ5N4VkgI3XAaWbbuKntkOYe5GnEMxHcPt22goxPLI52azC/iA3gVSRsaGSKnAAfl1NpmVBRqqXKmBFpzGEGy6aCAR9GwMP6asytljtZOjdqwDL9RSh2L7MpO7v4678Gx6cnHxkHfjUKwmABnCuNiGAoC3kcA314Ojg/6YDEnvChjkDox6AYGxxkJhetIET5VYaveJrGMqSFN362yP9jYMOpSDj+lc1SARLp0c8izIBualDlmRTWzzX6jsf2NIe1xPAhE0bxuDJxpHUsuAoWVXQyZsQJKkWxkg5LgBAbCQafUUEg3WjGhKfL7MxmIkH5xANP0lg4eZ5aAWhGDzyVoeKjGGVdlwvGVcS8xoTxn+6kuMcPRpDhLE9KbmGtBBSGSp953t2gQo5VHHr6Z+pQTHk8Pht77wQu60x5v2Jnirmh7GzMjmoOAuRfMUwc6/uLxRUHaqaVOJy5f9fTD6ex4GCq0JD3XTbWxr9daZCVHAxhjJ4J4OGUKz4RZk0mWOKGP8cHeP7GFF5H4OQhhZw2mV3mCxjLZIYfgyXevD2Qd2/GC5FIFQkzUNHQgrVJ+c+ZrfA+VswiP5rP+1oTRnxmr1Qm4zmJirIAWASqb1FZH/NkBEvrMcP5CA33XGJEgZacj46lsaghx2SHgXqVLj9bcvgCjkTkXZ6gRToIUy8uIUpuUUR4BJHi+N3sV83RbQUqj2OM1NJnkN6hyO6FUIUS7S+RmSiVooGYmRx7qLNfz13CH76Gq1P+IJM8qahrJSPIroVcgf+idkvg8fosfPE1xQJpXC446FXE6K0QYwyROeLhF+evwlyI8Sqgr89bdE43upxlMyPVZEkFlyAPjqCo1QrAEpD95Hj48fLk8p8ddumdyggetfF11QJBMQ4DUkavL3YSQUKj1BjV4j7Y7u3sdXvb0WZ/vLffDXlve6/XD/d7e929ze2oL3ABBej++hJ/ywGG2sguagbAxkJmnzGcjPaVnoPXJBvEEvIsey/MJLcal4dkK+PX1x/iMMajyCDufcWKnFbsjN2KfymmWQ0PQ50EVVws9Ah+IaBUCcVnqEE+goiIgsRndfRgDahEARVNSODfem22BKPD+ciiwvqm5DdcWnGNVPM+5hOX15AEmIBVGC/yzgvJ/UgnOJLqT1durb+kK9FwzdBTYfdTCW5m81EiswzfQBg9w1AkxjyPQUYIbysqDNJnxFahpIh+FQaNQDP8Qv4mhpeWKpzqE5ahVcB5LjDK3GvdDOKXKD5nQxcwiEsASSJJETcoEZZ4C6+VEJGIoBw/BdZlirbw9IsyFTXB21akHJwThjKEPJgto3Io5tObagCc3SthboIWPLU6N6GoPPBlzk1AxcNNcK/Nl4nReXrwKKOnm6DKS/nOsjcTRHLFIVqZe/S2kC23JEHVBNVlVyD9HDYWmW6xysxWUZO15pwceFzd2tnpjre2o51ub2entxtxvt/vdbf3tmrYsRyiBWBUAWZFQ/f09EQxZ1NI5M4/+t3uipKs1qjVYYQdiwzAjOqAphtquqGmG2q6oaYbarqhphtquqGmG2q6oaYbarqh31M3tLWqATqKJZp5aAx4QBsQJMuNgi4CjOuyq0OUkY7oGyWpyFjfsSWKqMk60tEa+eS9VKINbiqRQ0EshzARm587GaHrJlgCOJKI9ygCjatnONBEp8cOeVRFTBIGFWkg2QOtkzVy6JWSMJ8VUyC/UCQ9s6zYFXy0093vb413tjjv7231drdH+2O+udnd397fx9UhAiw4STWGuTF8trT0XwX4lAxZrCF7yP8IbME4pklkgBaHKRK6P/u6DYjGmvWJG1uK6fll+F1pC/qOw6NztrXLYq4mOT3nkwUlqPbVp6UoAskd4TMjJ1KtYkUorNaug+Ph+8HVh0t4cjH8+9XwE/yFtJa+Yh0o8NYI3VJTNTnV98SxF+CeW6gjY1AHwtA7T/UdCMSVrQ70VbxrpZkHBZjhV18xo0qajY1OaqEUui+W2RvZEZ0WQA48g9I0nLIRx/4dS1wY/g4DOc3aH7wm37EplCrCvO2wQRRJFBJAF6IxR3jlVCpCpYOh6wiMcwhlQd8P6zyjGjqsd54VVS5iWoEmH6pGweAAztdIL2GWA3MkZjUKS2/xLHr7AM9Oc3XuLitKI5XOVMbDYhsh1IZa1xHIJiG1ejhCc1kAHlWMKxGrhqTIzalj5jjT9C7kuV0j7s5jgJ82iVa+uBM++KiZcmhE1ijM5BHJtyw02Y8qzVUEPvSbIo6a2G1it4ndNWN38eWF3/b1b6n06S2XPlfKH5bB5LlU+hjyHixw/SC3++AM2WKgEF8i/fj50h/FwSM9Dym2Cd+xPnKpfHn3rLSHez7C8qM0Vs0WyCDp0UkwBiQS0QHxPeeYFOVUtbm82nttRhIcVK0oEQE1DZvpnAp3kytFjY1tsUgLq37I2JQDPvq9R0JAd/SpTWefmkqyqSSbbNRkoz9ONmoqySZ2m9j9fcbui5VkyRVFi6+TbJ4k3Mycp/n3KC1nMIAVBxBYGXJkqsVqBYmxssYK6pVDMOr3Rr3xbii2Ir4V7Wzuj/vhTp9v7/Z2e6Ot/m5QzfXX8zgug6weUxV7OzuSiqGIu4M6Lqdv6zKto/r2X447wWOENYSesm4GnYNKb8vasb+/XDteas1OuZqVp+FrNaSa6wgxDcYmONYUY2EAZxPARcUAqiTwha4kEwFUcAuZxTKR5U4y0DWz9mCMpxJcoBROVq4iVRjnwCEhQayxal74ztfMqIKdADp/x+rUm+gXVfLsAiX+gBKz4UNIu+2srNy3V+3vnih/FOSTM/AzG72u2+EKHAAaAodZZd3Z1OdNfd7k+CbH/zFyfFOfN7HbxO7vM3a/oj731dDz9TkMWLs+h7GdLitrqfd0LuB/XaZTqHgOyL2ZDumyaDSvwamuAFdChtKcMITjBdZgY+Xl1QAvvmJd6FjKTQxDp1mW2oONjUewFFjoqcNT2SmOQCl9jyegNu42V+DO/MwjIFeUh7TfPDg/8d1Fh/RrJLqwwztawGm7PGsBWqed4RfpF0fIZjoHhCMyLTw6592JHgObKfQSP1ga3SH3WZIRZLsy8dNr8vxj8yU5HJFn5FilvhfXgvEMuFwQD9m/nd9Trhz1WbqtPE8k2Kj1lxY7w2F9dii4gY7AfXfx5sfPl2/ZBEtNCvXc0kkgib0BBMs5uAhB2aDYx8dJlF2MzidTYnxQ+6YEQ4eNYxCY3ahPQrDr4qTcR8D4CwBlUilOEoQDOOv2TWGZSNyJGNNfZ65JdDwZqQ3Q0AavzXtLqY56AqncWU93TbrNjumIMx5hdaecnIjU4rHrtJCLV+T6Vib+VFBr+2AjavbtAhdOtdehO3kTQvwiCTzMj9r65sUdvXaFXptOdLWR6iIPqAnPR/37rbCw2jfzUaPXRnp1Pm7U56mEPFqfxhxsMQtpMI7YCQunWlvxZ8bQdTAMric5RNE3s3WPi7YpItr9boWltluyLdtQFRJ/HyAwlHMmPsKsTEWJhnpNRS4kfyLLQsz/ROfOfqrJTI+vIXniyEiH9pt5xgXbuGDbYYD1/LvchI4FsY0yEA44Bzia25+QwDNawTxHayWqE/kNmoOpIQRWiYpND9yHgznA+b8YvcDR5RiAYCyqy2/88JcHPK0nd/VkrqxiO2BRg8v8xhry4oLeHL/ldhTmyt+avCjxYL5rcqbi2fdG6WeQ5LeDu/8nxGuQ5o+INL7Mxd3Hi/lPmAyLhuSFS3auaVp58829euHK2XoXxPwK617lKq5+rXl9atUFp+5zt4C6ixdweq9dZSkvkLj7I6/fAymugSxe0CjvZ6x1j+Klqw7P3kyo2Wv5kL4/NP/cGX7/+sUj9L/WYW6ESVL6wvURBGfXZSzvPVu6iQb/h7eUYagPhC7b/foP1t5VMik4B2Ix5aJwKgXtWqWCZ+jtreI+JuSP4taodYQmBsZAsiH/GsmYbsp8FkyoEETHLQE85wNUf9Z+b+AT2PmcfsPouAAchvrOFd4sAibyhHGAtVdQKZI2zF3yhMZUiUIyTe1HOavIJAh3qAq62iJMYs/G+PWGDEUFfF5ZC7DH+u82QJFoEe/Mc0EuhIsyHFdvG1+jDYjXnoo4xU0JyPzQBIjKCqcnl0sUgZhy/tXRZrLhJ9kNHAtEsEV3zrDZ6Xa6+CjVNgMnrNC9ol+iYi/daV70rcf5lzu/hd+k8kiErexGituvKGjuWmu3kXEdrN7IgNZ4qhEZroPHR9yiw67+CR/DMNz/ub6dN+34CQi7rTra+fgicIvIfzfUvpxRhef3gpa/9MJ9BDfDbf+9OPa2siVzfoWWH/mf3Erc5pLh9/AQ/38Q3MB/8EGnzu9gED1/DIqtWhjjyBaV9KpC0v+BUj49/Rf7SjRS
|
|
sidebar_class_name: "put 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 'Update Access Request Configuration' (set-access-request-config)"
|
|
---
|
|
|
|
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"}>Update Access Request Configuration</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/access-request-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint replaces the current access-request configuration.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"approvalsMustBeExternal"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"autoApprovalEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","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"}>requestOnBehalfOfConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Request On Behalf Of Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfAnyoneByAnyone"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If anyone can request access for anyone.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfEmployeeByManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":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"}>approvalReminderAndEscalationConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Approval Reminder and Escalation Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"daysUntilEscalation"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"daysBetweenReminders"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"maxReminders"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":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"}>fallbackApproverRef</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></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"}>entitlementRequestConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Entitlement Request Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"allowEntitlementRequest"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for allowing entitlement request.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"deniedCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"grantRequestApprovalSchemes"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","nullable":true,"example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Access Request Configuration Details.
|
|
|
|
</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={"approvalsMustBeExternal"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, then approvals must be processed by external system.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"autoApprovalEnabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true and requester and reviewer are the same, then automatically approve the approval.","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"}>requestOnBehalfOfConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Request On Behalf Of Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfAnyoneByAnyone"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If anyone can request access for anyone.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"allowRequestOnBehalfOfEmployeeByManager"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If a manager can request access for his/her direct reports.","example":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"}>approvalReminderAndEscalationConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Approval Reminder and Escalation Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"daysUntilEscalation"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"daysBetweenReminders"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of days to wait between reminder notifications.","format":"int32","example":0,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"maxReminders"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `>= 1`"} schema={{"type":"integer","description":"Maximum number of reminder notification to send to the reviewer before approval escalation.","format":"int32","minimum":1,"example":1,"nullable":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"}>fallbackApproverRef</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type can only be IDENTITY. This is read-only","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id.","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of identity. This is read-only","example":"Alison Ferguso"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address of identity. This is read-only","example":"alison.ferguso@identitysoon.com"}}></SchemaItem></div></details></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"}>entitlementRequestConfig</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Entitlement Request Configuration.
|
|
|
|
</div><SchemaItem collapsible={false} name={"allowEntitlementRequest"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for allowing entitlement request.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while submitting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"deniedCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag for requiring comments while rejecting an entitlement request.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"grantRequestApprovalSchemes"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Approval schemes for granting entitlement request. This can be empty if no approval is needed.\nMultiple schemes must be comma-separated. The valid schemes are \"entitlementOwner\", \"sourceOwner\", \"manager\" and \"workgroup:{id}\".\nMultiple workgroups (governance groups) can be used.\n","default":"sourceOwner","nullable":true,"example":"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"approvalsMustBeExternal\": true,\n \"autoApprovalEnabled\": true,\n \"requestOnBehalfOfConfig\": {\n \"allowRequestOnBehalfOfAnyoneByAnyone\": true,\n \"allowRequestOnBehalfOfEmployeeByManager\": true\n },\n \"approvalReminderAndEscalationConfig\": {\n \"daysUntilEscalation\": 0,\n \"daysBetweenReminders\": 0,\n \"maxReminders\": 1,\n \"fallbackApproverRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n }\n },\n \"entitlementRequestConfig\": {\n \"allowEntitlementRequest\": true,\n \"requestCommentsRequired\": false,\n \"deniedCommentsRequired\": false,\n \"grantRequestApprovalSchemes\": \"entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584\"\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> |