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

84 lines
39 KiB
Plaintext
Raw Blame History

---
id: list-requestable-objects
sidebar_label: Requestable Objects List
hide_title: true
hide_table_of_contents: true
api: eJztXGlz27oV/SsY9UNfNKJsyXa8zHRaxUuqjhOnttO0dTJ9EAlJeKEIlkscN+P/3nMvwE2L7TiZNn5PXxKLxHL3ey4A4kvLxCqRmTbRMGgdtEKdZufq37lKMzkK1dnoF+VnaavTyuQkbR1ctWovRfH2Q6cVqNRPdEzjYJTLqU6FioLY6CgTicryJEqFFDS6MGMhfd9XaSp0pmapyKYys//4MhIjhQ48hwrwNDH5ZIr/lRjYPo6Acvi0W7yxo8lEiZlMPqL3tc6mYvC3wfB08OL0uCPeHL8+Gr5+KUwiBhcXw5evj49sm0SlMTgRmeGZdKCiTGc3Ik7MJ/wIRJ7qaCLaxQtPB20BMhI0kYmcdd9Hg+hGyBy90cCXTLv5qCJmyZdhiIHrMsFMqVI0m04KflmmssYLOHOjMJVn5y//NTh6NXzNE5mEKMSY1FsnPOGKmawC6vJHK/xHvK6aW4whJWpgkgkJjH7KyOBJUsqnC7tg/lWmErKOLy1N6mfJ4F2EN/hZkxoeFuS2DsYyTFWnlfpTNZOtgy+t7Cam9mmWQNqt205LfZazOKRnalfJ0fPN/f72+Pm2lP297d7uzmh/LLe2Nvd39vdb8yY4HEN7KsXMHWbjkwxzVZqiicKbBuvGmnLJNdmDHmtItWT2fSTaYhDMdARzAL9zqmUVSVhBaT3DIzur7fnaRJ6c681k2KluRHum2iTpWKapMwxzHa0aDvzJkWVviX+BqLu4y1Qko6wrzmj+eaJm8iP4z31ww+x1xTCyLPoS+uIB5CepQxq6I2JYGtTVESBbTyJIzJqRIpGADtgM+bSM8Af7hY6c4aV5mHWh5uVWQ8aQLqj1RIdka7UR0sJrK5VR1w3u3xHXMFgllAQ79IQcxkSKhHR+dnrMoeDw8Pji4l9vzs9OhqfH3bpkWbk0DkcVK2cVdMVFHscmyaxTBIEm4mTRdCZvmOEgqJgd5+iq2EZMnpFMtK+6D/IGmSSSxMJeueglcJIon1FkbvKBF8Qg/jt+fTm8PD1+hf+XRWol/DxJwC6ZouULdC9aj+WuK1p1t1yYE5bKLxZyyCVRfdvwaaKvszCC+hyHJlBOICutQyWzRweTEw3z95U4N/i5EDgyUru5ThGgZeJPKfCvDJLW6SkJZBoGMJMZ7MxYnROlZF+14dm4iHQywyK5sEfZLu0xm3cjt1BstZ4Eo4KDGbC72mtAZAZXfojjLPqN7bxRjNFwHvuw5j61vFok0w6x65IsWM2oNQKKShKKO6aMdBxM6sxZr4AGyzYkdXRtZtyyCxJj5XUFuf8/xyskgWeOe/xVCKXVifIwXHC8CydPBE/ABWKX4+pIhxTrKYZHhak566sysvNHQ9zOZKDE6IYkbwg8TWU4LnJ7mToqFaNlQ6Zd0S7JbxfUqLQ+DymxCPcWTTA56OmYXd0vj6qeI+VLqKlJ2FRS2nIppGQUuhuHejKlOQoxfsMkMkyUDOxk/MINhChnQnZRJ2h4JBxQsZc2LQ/TUB6r5PgTxwj8wSnc5oEyjT5zLu18pnDeuqS5B2dpzmHdZlStGdTKgOoeWDtykbUeOWsDXtWMsbTQD6tCSKhnOluIH6/kZwF7H8FfYV211GuzIkDJBfDs1d+2xODNUICqKJBJIA5NGIJYjCHelEjxw0/TLIvTg42NQH1SIVUg3RQqZMDa9c1sQwfRhow1hSIex/PLcbwKcT5jMc4QEaFT/DnjOmapd5ey6O9sLvF1zKsmKkFPO4x9tNXHA2hVz8jR0W8mP9u/eZRAjSWkwL9uV0nTjMepWhTnGT8G2S4Ij/PSGJB3YPhv0xz2UXddzjVt1k6bBB/LCfJYphpFUmFPT0Ud36CMUvyrhe+bPFqUPXl3luRA2zqzzhmbOA+tKOGmf/cuAVVD75B6t7k4NBGCyhRRxKUrm+AX3YGK2GuTh4EtYy1eFHpc6g3yE21rE21xTdm1SOnvI+hMEyxxYZBTIBQNUgQzwuh8Kj8pDpkJC4fa61ksfaBVndlyEBqbIaJiYopZXGnSrG0e5A/MeZtoYmptXVRH6ghhjponYUHEzxIjGhnEdhm1anZiAeUqW7HQi4DTgzAko7v0WrzHTKP3rRV4q7QMu4DAcKuQZHoTZQiqttvIQpb/rbh/Z3kGZZ6j8xnp/aR4SuZUlQQF/BgbSn30GmEpDFK2abuKZJL0gEZoI3u22weirf4Ns4za9hmJrPa0A/HhzaJyV2JbouNODdUiBjmB9FJF3IJ6Ut5qG7IzLEA0KvF+bAWSSObVd2GfPUx50IbTCzRx+4GEZKMdI97+5ib91xTLqVtkWLLAABH6BtEbQRfdZByHDG5NtPFLSn2/PBxl2xFpgSkh8WTaUqSDZVqfi+/BssWtAjBmqQrHDbjV9/d7e5t7WztBX+30nu9t9naCrf54b3/Tl72dvR7ZjjXB+2b+c46I7BHa5CkDncYhihJbCa4iqQn9SGbQ17my1adb2yQSfIxLlnyX1Qdo4WWajbnG4GZv19vc9Xq9y97ewfbOwdZud3N/758L9NNqAPWmwi9aJcFrwOiCFpA1MwHjE6KLKh1qWkTlr6dzz9t87vV3LvubB/3+QX+v29vc/gY6QwlbLSm8nRvnPnUeVb9Wq28OuttKgnGx02Atk3VA0KgIKR0OnNYhUJVyDdAU4G0hwae96GMjb1WrUGgIw7MxLxivi+p1Uf3DFtWd+ZB2i6q53M9wjYcPSUngveEEzH2p686cHnSZwWSaGl+zXCFPrgKA9fUnt/syH3BLdukFSDXXkUrO1XhZYp3v20y0qwLPkkBMy+rlbgZUMjzi6POPruB9QK5JZODR64ZGinYtlulD8rqzPR00VbssadeT+ndL4OVe0D2cDUINvCNOVDLJU8OFwwzedP/8x9SMVjATcp2vmFHyjN2xnfFPRbfU4CHwJK8PFVY/LO0XzRUqyHeoaF+DxUEUMAG1kH3ItWSWnpfYeWmFVefh3VTxLmEtXeLXLEcMckvewnej2vxdq3erINTQcFG5rXZcMHhLDbaXIdZDQCo4zjGvQ3vAVlVdXiNSjEzAG6o6QlFsbexr0ewK1BqoDGI95MW5+0zgREfKmyRSE4V26dxHRyc7EhLXx3bIIkxwu6ZTQBLdnnghg3LH/NAxQ3JMpP8RYz0kdr2NNPqLogsFpyJpLpn23o1agowwbjmpx5myDGhO/VIhfGlfhMaHRv7DEEWSZxEBPPnDKwce44EhzbYt2XT0ikx9pk1B8eLwjdjeBZaLJjk/l5M5IUTe24tlcM4OfJboiV6KPwv0c3R8Mnh7ekl47vivb48vLlcAnkFUZA7DC1FTc80UOwYIAqPcgTho17LtRm2DIRml9Yba/kpv4Ksz4VZM0MPNvqRHfWgxTsys4UrsN58z8ZPuqm4HSYFgOG+OjWTKCd4utRFcjjPv1Emy7dbYnjU2eHiJ6iu3dypdVKJcqE5cMDmtK4WcA5TfbycDP8tpz5fYrHthaS2OxAoYWck1qbusCY1FSmsKPh0hocVf3wCkA5CNci5chQtHXNoj8ERFuzJi1WMkh7tXlpijzPA7BnL3+92bEOHHY9bKF5+Ucz6ubopIXtv9dhHJLWhz5/L8jJNF4fh28WHtu2vfXfvuA313/uW5W6dzbxn69Bahz9vInRWj5LkAfRJli7DiQNl/GN44RfJuvoNIf3l36U6i0dGyz7HmQwjfDR/ZVL5A/KDUh1tjLSBikforXRCBLEfLwRiRSAUHTHdFsQWJLKqtxdlOTDLSMNBoCUSkClTcmNyeA8qjiDdn0o4IjEqj32duW6Zc/CmO4Hl2RXeNJNdIcp2N1tnoV5ON1khy7btr332avnsnkiypYm9xOCnNZzOZ3FhLc+95N0WgQXU+pnQ5VtU8WqHBRImxWk3k0Br1e6PeeNdX24HcDp5v7Y/7/vO+3Nnt7fZG2/3dVj3XX1V+XDpZ06dq+rZ6ZBEDxH0CjssjGFeaGRM0l/9y2u0f81HSrILE0B2dUv9QYsf+/iJ2vDRGvKLD/w4hpQ0MGVUyopiGtjNqmxRtNX2bMUFcjOhcjzZ29Z/2Nz1BpxcEHx4i5yUuMG5y4w3GtKrqjiRVR+rtLDrywxwUciQIDaFmA8PSdL5nTJgPIzCCnSA6f0d06lT0TUhenBPHp8SxOP7sK0WOXiL3nWXru0MQn1CMuLAKXrHQa6sdGcEAUBDYmFXizjU+X+PzdY5f5/hfR45f4/O1765992n67lfgc4eGVuNzNHgwPkfb7qYosdQJH5r+X8N0dhVHAZu3MD4fVQsqDM64AqZEBE3424pYZlP82KgdYPOqI6kW9luC8iREw+L07Rf7IextV8a6W5yZiMw1H8EdQThL4o49hUE2Qw34sK+doMuSTTTNbiMdD27l7I6gt8pTvneOXJw3uTF54j7W7dA5G2dI/Bgkxqgifp9y6y4bzgJ/4OttEt5+Oy92oBW8LBPfnbOhvQClcywSCx9IXVA4BmJ9vQU9hzZMDXJS8tWHepsLguWWwoWWVaqhUq6/QNAZNeuLF0omdFqFdzd++su7y2diQmCUg4E99a00H2iR4g3MiINdecyTOnH+qd1T0NhLIecS4xBCEe6LiuL4zWtkgXOEbRb7oLo6AL0efj5cNvqt+H7ifeSJI53Y4+P2K3DHov3G5Cou+JI1vh5LxO+K0Tw7msej0dn0BhVWtFe+PZvjw8NpCBmmLK1HT27H82rjUYmFJzTqPA0kCUdHcwfML7T2aDoa43k0XpOO99G7qaZv7BvdhA1sIp3yR0RD4U+NSdUfhSDTIVe5muTwtEeTdU2TeuwRXn+zRpJnp/S0B9zI9J3CMSJrTHJEeZthiwGiiwLrtj+zZhEXfuajzD83eObHV0iv1DIw/ld89DBHM03o0YSejROpo99mLzIs+DbxwHHAGsBhpX+OBI7QWmx0dyAsi/w8/Ab3ofThm9iGmDQ+sD8OqiDo/hL8glqXbRCqCXaXe4J0MtWNRSmsIaxiwWBegov0hgaZc05ult5ywYqy6Y/GL3E8qNZV6OKJ7x2lV0SSHyfu/p8i3jrS/BojjQPCZG487dzZXjLyFw7TLa7z2cP8+Bdv2VcZc0v6aKb4uLU+UBzKjKyavdqfasUrBLGSmb0CBkyYGXsiivny7hcMNOHPhBKQLEP3FQavYRczS3YYCz5Jr/Q7zcsvMfwpKk7VFe9QtEU+1EIFG53CwLtfjKvcLqCZN3zT0VGhbEGnlvOIjoqD7HwmJEzqHosIdOrnNnChfotUIQt741HZq/BiMjVioculSzJLz8a0+Iy6tqb4e+aC3osv5iB6/n7KfuhYMXKuQrZMateE9veNDWvzpiqMqWRE1AUAU7UZXg0vF0bEYFEKvlCam2Sy4TqlG9QWg1AJZc1nq9vrbnpcUuB5bNIMRW5t8CVXhAn6aHDeDr9Ui+7rG8N+OzeGuXxPhdpGTMuPZEW5LS5tIX/VWlbIo+ybwtbo9ZcvtEBFle0tPbbfCVO5COunPtUnvisNbn0/2BO5H2yFwXxUtN7VvFrOrWu1+MOth5vCr+1OsTvkVVyq9khJPY27se6WgL047LuZym/7Fq07BF27ieyRwn5aVw7dIYriRqVHyuG3dVfQHXIs71J6bPhaX/zz5C7+ucMcitudvimW/+AXvPwgN/TcoYXq3qRH6uE3d83O3WmzvOSoEueHajOON8BQCHFE4pLHdrNb9LVeC4fYaJRy2/TlMWr62/8CAO9JAg==
sidebar_class_name: "get 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 'Requestable Objects List' (list-requestable-objects)"
---
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"}>Requestable Objects List</h1>
<MethodEndpoint method={"get"} path={"/requestable-objects"}></MethodEndpoint>
This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param.
Any authenticated token can call this endpoint to see their requestable access items. A token with ORG_ADMIN authority is required to call this endpoint to return a list of all of the requestable access items for the org or for another identity.
## Request
<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":"identity-id","required":false,"schema":{"type":"string"},"example":"e7eab60924f64aa284175b9fa3309599","description":"If present, the value returns only requestable objects for the specified identity.\n * Admin users can call this with any identity ID value.\n * Non-admin users can only specify *me* or pass their own identity ID value.\n * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"types","description":"Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The currently supported requestable object types. ","example":"ACCESS_PROFILE","title":"RequestableObjectType"}},"example":"ROLE,ACCESS_PROFILE","explode":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"term","required":false,"schema":{"type":"string"},"example":"Finance Role","description":"It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored."}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"statuses","description":"Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice.","required":false,"schema":{"type":"array","items":{"type":"string","enum":["AVAILABLE","PENDING","ASSIGNED",null],"description":"Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.","example":"AVAILABLE","title":"RequestableObjectRequestStatus"}},"explode":false,"example":["ASSIGNED","PENDING"]}}></ParamsItem><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"},"example":"name sw \"bob\"","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, in, sw*\n","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"required":false,"example":"name","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**\n"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of requestable objects
</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":"Id of the requestable object itself","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Human-readable display name of the requestable object","example":"Applied Research Access"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"The time when the requestable object was created"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z","description":"The time when the requestable object was last modified"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the requestable object.","example":"Access to research information, lab results, and schematics.","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"RequestableObjectType"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ROLE`, `ENTITLEMENT`]"} schema={{"type":"string","enum":["ACCESS_PROFILE","ROLE","ENTITLEMENT"],"description":"The currently supported requestable object types. ","example":"ACCESS_PROFILE","title":"RequestableObjectType"}}></SchemaItem><SchemaItem collapsible={false} name={"requestStatus"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","enum":["AVAILABLE","PENDING","ASSIGNED",null],"description":"Status indicating the ability of an access request for the object to be made by or on behalf of the identity specified by *identity-id*. *AVAILABLE* indicates the object is available to request. *PENDING* indicates the object is unavailable because the identity has a pending request in flight. *ASSIGNED* indicates the object is unavailable because the identity already has the indicated role or access profile. If *identity-id* is not specified (allowed only for admin users), then status will be *AVAILABLE* for all results.","example":"AVAILABLE","title":"RequestableObjectRequestStatus","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"identityRequestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"If *requestStatus* is *PENDING*, indicates the id of the associated account activity.","nullable":true,"example":null}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>ownerRef</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><SchemaItem collapsible={false} name={"requestCommentsRequired"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Whether the requester must provide comments when requesting the object.","example":false}}></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\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Applied Research Access\",\n \"created\": \"2017-07-11T18:45:37.098Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"description\": \"Access to research information, lab results, and schematics.\",\n \"type\": \"ACCESS_PROFILE\",\n \"requestStatus\": \"AVAILABLE\",\n \"identityRequestId\": null,\n \"ownerRef\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\",\n \"name\": \"Alison Ferguso\",\n \"email\": \"alison.ferguso@identitysoon.com\"\n },\n \"requestCommentsRequired\": false\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={"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