LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/list-requestable-objects.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

82 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: eJztXGlzG7m1/Sso5kPGLDYlUpK1VL1KOFocpmTLT5Ljl8iuDNgNkhg3G51eJCsu/fd37gV64yLJsiuxZvjFFrux3P2eC6DxpWVilchMm2gYtA5aoU6zc/WvXKWZHIXqbPSr8rO01WllcpK2Dq5atZeiePux0wpU6ic6pnEwyuVUp0JFQWx0lIlEZXkSpUIKGl2YsZC+76s0FTpTs1RkU5nZf3wZiZFCB55DBXiamHwyxf9KDGwfR0A5fNot3tjRZKLETCaf0PtGZ1Mx+NtgeDr4+fS4I94evzkavnklTCIGFxfDV2+Oj2ybRKUxOBGZ4Zl0oKJMZ7ciTsw1fgQiT3U0Ee3ihaeDtgAZCZrIRM66H6JBdCtkjt5o4Eum3XxSEbPkyzDEwHWZYKZUKZpNJwW/LFNZ4wWcuVGYyrPzV/8cHL0evuGJTEIUYkzqrROecMVMVgF1+aMV/iNeV80txpASNTDJhARGP2Vk8CQp5dOFXTD/KlMJWceXlib1s2TwLsIb/KxJDQ8LclsHYxmmqtNK/amaydbBl1Z2G1P7NEsg7dZdp6U+y1kc0jO1q+To5eZ+f3v8clvK/t52b3dntD+WW1ub+zv7+615ExyOoT2VYuYOs3Etw1yVpmii8LbBurGmXHJN9qDHGlItmf0QibYYBDMdwRzA75xqWUUSVlBaz/DIzmp7vjGRJ+d6Mxl2qlvRnqk2STqWaeoMw9xEq4YDf3Jk2VviXyDqPu4yFcko64ozmn+eqJn8BP5zH9wwe10xjCyLvoS+eAB5LXVIQ3dEDEuDujoCZOtJBIlZM1IkEtABmyGflhH+YL/QkTO8NA+zLtS83GrIGNIFtZ7okGytNkJaeG2lMuq6wf074gYGq4SSYIeekMOYSJGQzs9OjzkUHB4eX1z88+352cnw9Lhblywrl8bhqGLlrIKuuMjj2CSZdYog0EScLJrO5C0zHAQVs+McXRXbiMkzkon2VfdR3iCTRJJY2CsXvQROEuUzisxNPvCCGMR/x28uh5enx6/x/7JIrYSfJwnYJVO0fIHuReux3HVFq+6WC3PCUvnFQg65JKrvGj5N9HUWRlCf49AEyglkpXWoZPbkYHKiYf6+EucGPxcCR0ZqNzcpArRM/CkF/pVB0jo9JYFMwwBmMoOdGatzopTsqzY8GxeRTmZYJBf2KNulPWbzbuQWiq3Wk2BUcDADdld7DYjM4MqPcZxFv7GdN4oxGs5jH9bcp5ZXi2TaIXZdkgWrGbVGQFFJQnHHlJGOg0mdOesV0GDZhqSOrs2MW3ZBYqy8riD3v+d4hSTwzHGPvwqhtDpRHoYLjnfh5IngCbhA7HJcHemQYj3F8KgwNWd9VUZ2/miI25kMlBjdkuQNgaepDMdFbi9TR6VitGzItCvaJfntghqV1uchJRbh3qIJJgc9HbOr++VR1XOkfAk1NQmbSkpbLoWUjEJ341BPpjRHIcZvmESGiZKBnYxfuIEQ5UzILuoEDY+EAyr20qblYRrKY5Ucf+IYgT84hds8UKbRF86lnc8UzluXNPfgLM05rNuMqjWDWhlQ3QNrRy6y1iNnbcCrmjGWFvpxVQgJ9UxnC/HjtfwsYO8j+Cusq5Z6bVYEKLkAnr3625YYvB0KUBUFMgnEoQlDEIsxxNsSKX78aZplcXqwsRGoaxVSBdJNoUIGrF3fzDZ0EG3IWFMo4nE8vxzHqxDnCxbjDBEROsWfM65jlnp3KYv+zuYSX8e8aqIS9LTD2EdbfTyAVvWMHB39ZvKz/ZtHCdRYQgr8626VNM14nKpFcZ7xY5DtgvA4L40BeQeG/y7NYR911+Vc02bttEnwsZwgj2WqUSQV9vRc1PENyijFv1r4vsmjRdmTd2dJDrStM+ucsYnz0IoSbvp/3iWgaugdUu82F4cmQlCZIoq4dGUT/KI7UBF7Y/IwsGWsxYtCj0u9QX6ibW2iLW4ouxYp/UMEnWmCJS4McgqEokGKYEYYnU/lteKQmbBwqL2exdIHWtWZLQehsRkiKiammMWVJs3a5kH+hzlvE01Mra2L6kgdIcxR8ywsiPhZYkQjg9guo1bNTiygXGUrFnoRcHoUhmR0l96ID5hp9KG1Am+VlmEXEBhuFZJMb6MMQdV2G1nI8p8V9x8sz6DMc3S+IL2fFE/JnKqSoIAfY0Opj14jLIVByjZtV5FMkh7QCG1kz3b7QLTVv2CWUds+I5HVnnYgPrxZVO5KbEt03KuhWsQgJ5BeqohbUE/KW21DdoYFiEYl3o+tQBLJvPou7LPHKQ/acHqBJu4+kpBstGPE29/cpP+aYjl1iwxLFhggQt8geiPoopuM45DBrYk2fk2p75fHo2w7Ii0wJSSeTFuKdLBM63PxPVi2uFUAxixV4bgBt/r+fm9vc29rJ+irnd7Lvc3eTrDVH+/tb/qyt7PXI9uxJvjQzH/JEZE9Qps8ZaDTOERRYivBVSQ1oR/JDPo6V7b6dGubRIKPccmS77P6AC28TLMx1xjc7O16m7ter3fZ2zvY3jnY2u1u7u/9Y4F+Wg2g3lT4RaskeAMYXdACsmYmYHxCdFGlQ02LqPz1dO55my+9/s5lf/Og3z/o73V7m9vfQGcoYaslhXdz4zykzqPq12r1zUF3W0kwLnYarGWyDggaFSGlw4HTOgSqUq4BmgK8KyT4vBd9bOStahUKDWF4NuYF43VRvS6qf9iiujMf0u5QNZf7Ga7x8DEpCbw3nIC5L3XdmdODLjOYTFPja5Yr5MlVALC+vna7L/MBt2SXXoBUcxOp5FyNlyXW+b7NRLsq8CwJxLSsXu5mQCXDI44+f+8K3gfkmkQGHr1uaKRo12KZPiavO9vTQVO1y5J2Pal/twRe7gU9wNkg1MA74kQlkzw1XDjM4E0Pz39MzWgFMyHX+YoZJc/YHdsZ/1x0Sw0eAk/y+lBh9cPSftFcoYJ8j4r2DVgcRAETUAvZh1xLZul5iZ2XVlh1Ht5PFe8S1tIlfs1yxCC35C18N6rN37V6twpCDQ0XldtqxwWDd9RgexliPQSkguMc8zq0B2xV1eU1IsXIBLyhqiMUxdbGvhbNrkCtgcog1kNenHvIBE50pLxJIjVRaJfOfXR0siMhcX1shyzCBLdrOgUk0e2Jn2VQ7pgfOmZIjon0P2Gsx8Sud5FGf1F0oeBUJM0l0z64UUuQEcYtJ/U4U5YBzalfKYQv7YvQ+NDIvxmiSPIsIoAnf3zlwGM8MqTZtiWbjl6Rqc+0KSh+PnwrtneB5aJJzs/lZE4IkffuYhmcswOfJXqil+LPAv0cHZ8M3p1eEp47/t93xxeXKwDPICoyh+GFqKm5YYodAwSBUe5AHLRr2XajtsGQjNJ6Q21/pbfw1ZlwKybo4WZf0qM+tBgnZtZwJfabz5n4SXdVt4OkQDCcN8dGMuUEb5faCC7HmXfqJNl2a2wvGhs8vET1lds7lS4qUS5UJy6YnNaVQs4Byh+2k4Gf5bTnS2zWvbC0FkdiBYys5JrUXdaExiKlNQWfjpDQ4q9vANIByEY5F67ChSMu7RF4oqJdGbHqMZLD3WtLzFFm+B0DuYf97m2I8OMxa+WLa+Wcj6ubIpLXdr9dRHIL2ty5PD/jZFE4vl18WPvu2nfXvvtI351/ee7W6dxbhj69RejzLnJnxSh5LkCfRNkirDhQ9m+GN06RvJvvINJf31+6k2h0tOxzrPkQwnfDRzaVLxA/KPXh1lgLiFik/koXRCDL0XIwRiRSwQHTXVFsQSKLamtxthOTjDQMNFoCEakCFbcmt+eA8ijizZm0IwKj0uiPmduWKRd/iiN4nl3RXSPJNZJcZ6N1NvrNZKM1klz77tp3n6fv3oskS6rYWxxOSvPZTCa31tLce95NEWhQnY8pXY5VNY9WaDBRYqxWEzm0Rv3eqDfe9dV2ILeDl1v7477/si93dnu7vdF2f7dVz/VXlR+XTtb0qZq+rR5ZxABx18BxeQTjSjNjgubyX067/WM+SppVkBi6o1PqH0vs2N9fxI6XxojXdPjfIaS0gSGjSkYU09B2Rm2Toq2mbzMmiIsRnevRxq7+0/6mJ+j0guDDQ+S8xAXGTW69wZhWVd2RpOpIvZ1FR36Yg0KOBKEh1GxgWJrO94wJ82EERrATROfviE6dir4JyYtz4viUOBbHn32lyNFL5L6zbH13COITihEXVsErFnpttSMjGAAKAhuzSty5xudrfL7O8esc/9vI8Wt8vvbdte8+T9/9Cnzu0NBqfI4Gj8bnaNvdFCWWOuFD0/9pmM6u4ihg8xbG56NqQYXBGVfAlIigCX9bEctsih8btQNsXnUk1cJ+S1CehGhYnL79Yj+EvevKWHeLMxORueEjuNdbS6KOPYNBFoO4FeT2YC8d+LWTdFm6iSYKbLTjCays3TH0VnnS997xizMntyZP3Ae7HTpr44yJH4PMGJXEH1Nu3WXjWeARvL1LwruH+HEHl1fwYQdZwccy8d07F9oLUDnHHpH/kdQFhWMg1tc70HNow9QgJyVffay3uSBYbilcaFmlGirl+gsEnVGzvvhZyYROq/Duxk9/fX/5QkwIjHIwsKe+leYDLVK8hRlxsCuPeVInzj+1ewoaeynkXGIcQijCfVFRHL95gyxwjrDNYh9UVweg1+PPh8tGvxXfT3yIPHGkE3t83H4F7li035hcxQVfssbXU4n4QzGaZ0fzeDQ6m96gwor2yrdnc3x4OA0hw5Sl9eTJ7XhebTwqsfCERp2ngSTh6GjugPmF1p5MR2M8j8Zr0vEhej/V9I19o5uwgU2kU/6IaCj8qTGp+pMQZDrkKleTHJ72ZLJuaFKPPcLrb9ZI8uyUnvaAG5m+UzhGZI1JjihvM2wxQHRRYN32F9Ys4sIvfJT5lwbP/PgK6ZVaBsb/io8e5mimCT2a0LNxInX02+xFhgXfJh44DlgDOKz0z5HAEVqLi+4OhGWRn4ff4D6UPnwT2xCTxgf2x0EVBN1fgl9Q67INwjTB7nJPkE6murEohTWEVSwYzEtwkd7QIHPOyc3SWy5YUTb90fgljgfVugpdPPG9o/SKSPLjxN3/UsRbR5rfYqRxQJjMjaedO9tLRm4R3eIqnz3Kj3/xlj2VEbekT2aKT1vrw8ShzMim2af9qVa8PhArmdkLYMCCmbEfAhKXN79goAl/JJSAYBm6bzC64j0KsMiHiKn4ohMVGPVX46qwC0j5Ld9adFQoTtAJ5DyiY98gIp8JCfN4QLuBTv3cBiHUYpEqOLO3F5W9Co8ksyFRdLkMSWbp2ZgWklGj1pT4wFzQYfH1GwTJ30LZjxYrRs5VyFZG7ZoQ/aGxYTneVIUxlX+IoABTqjbD6+HlwogYLErBF8psk0w2XKd0g9piECqHrDFsdVH00aPYpBlq1dq4S276EvTt37xBfanWztcXf/1+Lv5yaZvqrY2YVhHJinJbI9p6/Kq1rB5H9TaFrdHrL19onYmK0zt6bD/3paoPhk99qi91Vxrc+pqvZ3LN1wqD+aRo2ap5Q5xbnmrx91ePN4Xf2tVg98iruBvtiZJ6Hldc3S8Be//XdzOV3/dlWPcIunah2BOF/bxuDrpHFMXFSE+Uw+/ryp975FheifTU8LW+v+fZ3d9zjzkUlzR9Uyz/we9p+UEu2rlHC9X1R0/Uw+/utpz702Z5V1Elzo/VnhrvY6EQ4ojEJY/tZnfaa70WzqLRKOXu56tjlPN3/w9cozT0
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 '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 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><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"}><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