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
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-historical-identity-events.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

135 lines
87 KiB
Plaintext
Raw Blame History

---
id: get-historical-identity-events
sidebar_label: Lists all events for the given identity
hide_title: true
hide_table_of_contents: true
api: eJztXHtvGzcS/yrE3h9JDEnW07IEHA6O7fQcOInPj+ZwroFSu5TEZkWqy13bquHvfjND7ksPy3aSpklVFK28Sw7nzR+HXN55eioiHkutjgKv741E/G9pYh1Jn4dHgVCxjGeH1/B/41W8mI+M17/00hfMtp15VxUvEMaP5BQpAZ3zsTRsIuKxDlgk4kiKa2EYD0PGfV8YwwTRZEMdsXgsmEwpnorfExlh2wQ6R/IP4o0ZH/hkesheyED109bVsR2/HwkevGDA4ZRHHIYVEfJ550nkZcrjMbxS8AL+kgH8Nv5YTLjXv/Pi2RSfGmBRjbz7ihdZBkAZcZSIRbkKvBIpccsn0xBp7PqNXl3sdHe7nLdF0OO9+iDoBZ1Wu91ptoYDoO44+j0RoLSMpWGkJw8ztciEpj94yKQyMVcxQyLsZiz9MYs16jyJFKm2pPASw816vVutt6r1xnmj1a/X4d//rWSS+p8DY2YZqzyKODaWsZiYJSIsyLCnchFCsCLaloZg2NPkMtQYOxoylYDrgK+IyTSeVciRnAfxSLiWomSOS2+PBN8LAhGQB8Nb++hUTPR1+vBqlcBWb0cg0NeV2tkHaTjZX/LptILPdaLiCiNvC8VE0B+xX6vVXpX0s0JBBcLGUV6trMIg8MKNvVo5oZxIbFgW7x2/BUYmAxGhYBDFSRgXTfmLOhOCXf7cYnsnR+wM/DbgUcD2dRgKn+L8JIvfq5fjOJ6a/vZ2AJYOMU3VDJfhVEsV13w92YZMsM2ncts4OlU/o1PN88AryjETDZJLBT8nlFBqXjHShzw0oqCOZqe+xNowrhiJCHpaMvZRqwkPJlLJSTLx+tBvwm/tb6ISiCEHLdBf96u0qYdDIxbV+YEeA9ugQYzkIdrYapXBixq7MAkYesbMVPhyKEXAbmQ8ZltknS1U/JSPpOKxgP6RTkZjouMM892Y4zOMkal/tfKtp8/rHkJqCyeALYgf0CoofqqnSWhVKdjWf6vnOuZhdR97b6FKp1oZwcYwE4H7kx2w4ZJwGHOgqJMwYIM8GpkcZnYD/bEt6xNb7EagqkYKNBaAxcBmUvnYD8QwMaQZxsHQwAojQZjPFRvza8j7DGxEysH2cjLlPuQPkAZm5kiAxSDWITUypWP0FCNw1C0i8k+SfAt5Im6veZgIqwVsDWwnJuXmu/AgO5UvONFA61Bw5RX8hHre318hNWtSSuwwVeL/Fufh0ty1iGeAtK/BVcHDoDvk9RCAFXbf/s0gjbtHTCpczT4MCc64FnrwG2gF8RimbJxWsqlqzxjtS/DSgCby9R3cXLi0daY+4CGGKW2QxGJ/zNXI6iRFLzIyMf0G+BWJa6kT8zM6DMoScEQ2StykT/4AkhwhTYYnkJ2UurHkcW5KNUiwdJfv1nebu8Oddito77aH9Qb8Eo12s94UzfrOEC0YE6Jp9AjR7J43m/1Wt99q1Xr1BqKaXPaFwdZr6tRG25q2KSzeF1FM6XitVt00Cz8litn0ew0QlHe7w2GzsdOqN7q7zVazyzv1Yb03GFLSiuW1SEfy+o1mt9frgfjSTEM+e29tckZDsPfWKkYnkS8eq0jb2hF6e/B6nx3m2MCwM3qNcuRP960U9YoDTc6sqXigfAjpOHEKR3FTRzmj5wgvFR+EZHhwluwpSGUfzzuMpXxWoPosn4FAeazXLBvx/gohnjMoxcTSSFxIHAAD9wqoj2dNbRoBzq5tuFzeFWBo5iZrFxor7LDaez7L5qtdb9Fqi8r50pFe8UaQ0CKFs55F+Hmqckp30cw6u4+gFmc6zPNAaZCj9ZErGtBD36hsWYpdBv5OrzWsd0V3sNPudFq9neaO3+z0Om2/s9vptL15zb6F6fRM6RvPzk7XUtx8QYIBQEgD7vmOfwJY1f98mjCJ3leWzDTroiGy7f4uoZCq5c+Mg3dccQDPzE1UFpEQdsnM9+jA8Is0nhoYNKX9TQNjAYYsC4wMdzHftloWFgvY7PLzwNnVn47O8kyRI62l6rB5IkobzWvjbi5Pw4O0bfRYd3QdnNle4wprP4fjoNqsYoo8BUGWYtJSETyOYF2RrzBP4a9qw8tdCTuenJx++PnwYGHhiYsK7M7sYxdVnwHhbMbC4WH5EWnQ1BEsm0pe8laPs7CX68eAtVCK6FASomrR0NXSNJfb9Is7Doy3iLqXeU5WtPXTZksiqZzLnoTKSY/IAnPRZmDNLoKDNQizko5ZSliP0ctcchk/nAKfTPGAC8jKM8POeTTi0UwoIk1S5VnwyWTPZxFONcdcKYlBSRYsesyiNb9WslmE8ysyDpVVrLs/lIU3a7k0Ixy+33t9TKmtuJY7ODqzj7/SWm6d0fGfitdeVsjZDyXuPBxGEUCgKqwP8pqcrZfa9cJABzOsnkkFZpdB7RnFnawKADlzii5ul42BiLkM93UgFncR5ieIN1KJ6ijiEjkUxLIPHRlmYRngdEW1MUsSS1MoArWrlXZ/QBO1BnvNg2w9tO+EwWVvxP1PQOsoWM/QhZLQn6VdINVmZbAlw4qu4IOdeq/ZBmty3txtN7qdQW/IW616r9Pr4egT8DvuqkxzVbHy0D9hkpI+C7UPFvlD4GYjNw7L0uBLdmdW2IBoPEL/VPWjtpmYjl8Wi9u4wjh7vX/C2l0Wgi8n9JyP5pSgqhdnGB9JGGKBw1YoQXJL+EMkR1ItY0UoLGxfegeHb/Yujs/hyenhfy4Oz+AX0lrYh8WZTwXolpqK0GN9Qxw7AW64YUZgjVUENbblqG6BQFyZYkNp/zIzg0s0Vy2FHm70JT2KpO3mZDGUKG5uY/ZS1kStwgb4bMJjf8wG3EAHbfcutxBATOPqsdPklquvv6oxQF7S7aRREjbQf4alaY4bfiC12zKBUBZUjtdJjNVr6YuyLXJVlq2R136Oi0bB4ADO1/vJnh8nwByJWYzCzFsci84+wLPVXJm784LSSKUzFXM/xu35EMCMjiLQMAN0Dotnw1w6QnMZSDwqbZdlrPtCSYvS3TvLzEGs6Z3PE/OIuDsJIf1USbTsxbVwwUc7fjYbkTVSM7mM5DazqLNrlZkrDXwGM38YbGJ3E7ub2H1k7M6/PHXbV+4tQZ/GIvS5UOlBGxBiAfpE5D1Kz53GsYas4HkDB5HefjyHwP4kFLYXt1PchvuC+MhO5Yv4PLOHfT5A+JEZq2QLZJD06GpdkIlE0Ce+c45JUVZVrcXR3uhoIMFB1RKICFkzYjOd2BMWCaxucGPWVFighVEvYrcla8sXlAFxVBVU7e7nBklukORmNtrMRj/MbLRBkpvY3cTu9xm7DyLJ8nEHh5NMMpnwaGY9zb2no60MGuRn47KQy3ZrimgFibEMY3ll5OANmo1BY9j1RTvg7WCn1Rs2/Z0m73Qb3cag3ex6xbn+Mo/jLMjKMVWwt7UjqRhA3DXguESBc5lY66Bc/gP1RmKIaQ1TT4abQee1tMBI2LG9iB3f6xhkA8KAHaMV5cWL02OkD0MTedQb1WcRZlvV2dN4CCnpHJ64lXQWYQMdN9BxM/1spp8fY/rZQMdN7G5i9/uM3SdBx/Y66Nh+AnRsM4RYQ4RY3xI6BtJ+UDEEo4AMfgLqVQgbpyAK/MpP2lH64dFIxBnQK6HIZm/JBwdas3dczVKwZEqVSJWrC9MbtJ1g2yhtCw04G0GKVPhliAR0i14lJwIxKX7YQp+fYByjQEA3mlX3hjFI5T5qcf6WjSKVHybAISWFUGPtVYOPSfxCZIjwDyhQHXQEifoL1jidtT6rHsxOUeJjlJgd3vpCYMxn9d/OslMCR8B8hOnizNp6xXEBWzPnCpYR4nZq01cGQTdQfQPVN9P9Zrr/Mab7DVTfxO4mdr/P2H0CVHdoaDVUhwaPhurQtlZnGZZ6Q5/d/tmInULFcUDuzbRPWD3IMTjhCrzAxKNrUTCH4EUifW97nN2QUnWnVCGtbN/J4H47u2XDrgcse0kUQrf06+c7sBpY677Gp7KWnnJV+oY+gR6AqpZkITx0aiMOG9DH1naAGuk5kujKNu8Rcat190mzl31l/SBlPLeO5pzBWoRZMhW8NsK5FT0GFqewpnhhqHWN3GhBPpDrIgrvP18WS2iFLMvU9+Bo0J4Bp3Mi0uc4aC4wPx3CBntdAD/7NmntJWjyy6timzME6ZbDhZb5xIPbA80Fhj5gsyZ7LXgEKwh7Yubl24/nr9gIoSmlhsQgKhYS1xIQXCfgRpT69tLTI9iJZqP8Soe90vkcDDU2DEEpzH2hnx4yfw9zwikkcVI7dhKUN7DX47/P56V+K77H/0VV2YGM7Of79sN4J6K9s+BymsrFC3I9l4l/pNSqllqVqJlXc1xY1V769ry3D/GOJHhoSFvPHtzSqxbo4YILniDVeR5QE46P8qkqP7Xas/ko0asivTIfv6iPdEFQuVt6T5MZ06UUR8wfa23EvxhD18FQuRwlEGnPZotuJapSRFSb9QJLVTtkVVYBRRJ/xxAYyjoTH+AsTiBG23oKhe2vZFnIC7/SPRm/lmSmx5cw2WLLQPtPuHRijmccsIoDVm2eMI5/O5ehY0FsowyUB6wD7Of2p0zgGC3kRktraeYn8tvUB6cPvO+KqJhp3/7Rz5Og+2VvxcLWWRtI1V76sTLtIoYhc7RwQispKy0fzGtwkd9Qwzw6pzfLb7YJinPrX01elHgvr7J8UOHsS2fpFZnkr5N3v1HG22SaHzHTOFiM7kbDzt17gk7+2mG6xaqfoZuT4L/wlmKVEDisb/LLkoqEpiGP0aspqv0xXiCIZXTBY8SHFfQsPaFIhKU9hj+sConQKII2ELYGcCsfyBDoUUU7HZlTwFjwiXbFv03izldo94VfjX2EJZzywSy4fMOTvfDuN+3WcWdgmRM0LDtIjQ2gazJJFH5iCmwnE8bBpdZ4RCCNn9jEBas5JVJdaIJ+Wa80itHVUIQaLWSiifkwxFI0rHILhl8zFtjduDo0qL5wJ0AuyKkIyTOxXRnar6MN3lYdi3CKC0jIugDARPHWgaPzBYpATLnNDx2Ntl0ns41tgQguoaz7tGqNWr1KSwp4PtUmhiVvgfixxC2Owr2Aab3GbngU7mMqueVdXpH/ZndWurkIFxHbUyyUoYSJXfjYJeelt3TJCX379g5Ku+qENcpY41fvl97dHdZWcBl2j4/tlWe4tslu1EnvyHpAHZ9zy+RSoT4JrB646y5decCjS5Iez9bXujjyAYZLV19+Qba/4c2PD0i7eO/lM0X+vm6DfEAj6WWXz9TD3+saxwf0mF1z+UxFbu5k/P7uZHzAHdKbmHJvuMoLgE+crF66OTh4RYcXylc0L+Uh3a9SsyILKW8ysPdEWNchZuwLu0lR6LKwjY9SZIXjnw4Bx9z/H8DRXOE=
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 'Lists all events for the given identity' (get-historical-identity-events)"
---
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"}>Lists all events for the given identity</h1>
<MethodEndpoint method={"get"} path={"/historical-identities/{id}/events"}></MethodEndpoint>
This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read'
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"from","schema":{"type":"string"},"description":"The optional instant from which to return the access events","example":"2007-03-01T13:00:00Z"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"eventTypes","schema":{"type":"array","items":{"type":"string"}},"description":"An optional list of event types to return. If null or empty, all events are returned","example":["AccessAddedEvent","AccessRemovedEvent"]}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"accessItemTypes","schema":{"type":"array","items":{"type":"string"}},"description":"An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned","example":["entitlement","account"]}}></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></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
The list of events for the identity
</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><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"AccessItemAssociated"} value={"0-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>accessItem</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"AccessItemAccessProfileResponse"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the access profile name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the access profile will create"}}></SchemaItem><SchemaItem collapsible={false} name={"appDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AppName","description":"the name of app"}}></SchemaItem></TabItem><TabItem label={"AccessItemAccountResponse"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"account","description":"the access item type. account in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the account will create"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemAppResponse"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"app","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Display Name","description":"the access profile display name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"appName","description":"the associated source name if it exists"}}></SchemaItem></TabItem><TabItem label={"AccessItemEntitlementResponse"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"groups","description":"the entitlement attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Upward mobility access","description":"the associated value"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the type of entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemRoleResponse"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"role","description":"the access item type. role in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the role display name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></SchemaItem><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the event type","example":"AccessItemAssociated"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the date of event","example":"2019-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>governanceEvent</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the governance event, such as the certification name or access request ID.","example":"Manager Certification for Jon Snow"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The date that the certification or access request was completed.","example":"2019-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`certification`, `accessRequest`]"} schema={{"type":"string","enum":["certification","accessRequest"],"description":"The type of governance event.","example":"certification"}}></SchemaItem><SchemaItem collapsible={false} name={"governanceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the instance that caused the event - either the certification ID or access request ID.","example":"2c91808a77ff216301782327a50f09bf"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owners</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owners of the governance event (the certifiers or approvers)
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></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"}>reviewers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owners of the governance event (the certifiers or approvers), this field should be preferred over owners
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></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"}>decisionMaker</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The decision maker
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"AccessItemRemoved"} value={"1-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>accessItem</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"AccessItemAccessProfileResponse"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the access profile name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the access profile will create"}}></SchemaItem><SchemaItem collapsible={false} name={"appDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AppName","description":"the name of app"}}></SchemaItem></TabItem><TabItem label={"AccessItemAccountResponse"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"account","description":"the access item type. account in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the account will create"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemAppResponse"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"app","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Display Name","description":"the access profile display name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"appName","description":"the associated source name if it exists"}}></SchemaItem></TabItem><TabItem label={"AccessItemEntitlementResponse"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"groups","description":"the entitlement attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Upward mobility access","description":"the associated value"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the type of entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemRoleResponse"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"role","description":"the access item type. role in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the role display name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></SchemaItem><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the event type","example":"AccessItemRemoved"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the date of event","example":"2019-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>governanceEvent</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the governance event, such as the certification name or access request ID.","example":"Manager Certification for Jon Snow"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The date that the certification or access request was completed.","example":"2019-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`certification`, `accessRequest`]"} schema={{"type":"string","enum":["certification","accessRequest"],"description":"The type of governance event.","example":"certification"}}></SchemaItem><SchemaItem collapsible={false} name={"governanceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the instance that caused the event - either the certification ID or access request ID.","example":"2c91808a77ff216301782327a50f09bf"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owners</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owners of the governance event (the certifiers or approvers)
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></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"}>reviewers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The owners of the governance event (the certifiers or approvers), this field should be preferred over owners
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></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"}>decisionMaker</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The decision maker
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></TabItem><TabItem label={"AttributesChanged"} value={"2-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>changes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the attribute name"}}></SchemaItem><SchemaItem collapsible={false} name={"previousValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the old value of attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"newValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the new value of attribute"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the event type"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the identity id"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the date of event"}}></SchemaItem></TabItem><TabItem label={"AccessRequested"} value={"3-item-properties"}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>accessRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
the access request details
</div><SchemaItem collapsible={false} name={"requesterId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c91808a77ff216301782327a50f09bf","description":"the requester Id"}}></SchemaItem><SchemaItem collapsible={false} name={"requesterName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bing C","description":"the requesterName"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>items</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Add","description":"the access request item operation"}}></SchemaItem><SchemaItem collapsible={false} name={"accessItemType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"role","description":"the access item type"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Role-1","description":"the name of access request item"}}></SchemaItem><SchemaItem collapsible={false} name={"decision"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`]"} schema={{"type":"string","example":"APPROVED","enum":["APPROVED","REJECTED"],"description":"the final decision for the access request"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"The role descrition","description":"the description of access request item"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"8a80828f643d484f01643e14202e206f","description":"the source id"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Source1","description":"the source Name"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvalInfos</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"8a80828f643d484f01643e14202e2000","description":"the id of approver"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"John Snow","description":"the name of approver"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Approved","description":"the status of the approval request"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"8a80828f643d484f01643e14202e206f","description":"the identity id"}}></SchemaItem><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AccessRequested","description":"the event type"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2019-03-08T22:37:33.901Z","description":"the date of event"}}></SchemaItem></TabItem><TabItem label={"IdentityCertified"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"certificationId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certification item","example":"2c91808a77ff216301782327a50f09bf"}}></SchemaItem><SchemaItem collapsible={false} name={"certificationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the certification item name","example":"Cert name"}}></SchemaItem><SchemaItem collapsible={false} name={"signedDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the date ceritification was signed","example":"2019-03-08T22:37:33.901Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>certifiers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
this field is deprecated and may go away
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></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"}>reviewers</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The list of identities who review this certification
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></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"}>signer</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Identity who signed off on the certification
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the id of the certifier","example":"8a80828f643d484f01643e14202e206f"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the certifier","example":"John Snow"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the event type","example":"IdentityCertified"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the date of event","example":"2019-03-08T22:37:33.901Z"}}></SchemaItem></TabItem><TabItem label={"AccountStatusChanged"} value={"5-item-properties"}><SchemaItem collapsible={false} name={"eventType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the event type"}}></SchemaItem><SchemaItem collapsible={false} name={"identityId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the identity id"}}></SchemaItem><SchemaItem collapsible={false} name={"dt"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the date of event"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>account</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the ID of the account in the database"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the native identifier of the account"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the display name of the account"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the ID of the source for this account"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the source for this account"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"the number of entitlements on this account"}}></SchemaItem><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"this value is always \"account\""}}></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"}>statusChange</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"previousStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`enabled`, `disabled`, `locked`]"} schema={{"type":"string","description":"the previous status of the account","enum":["enabled","disabled","locked"]}}></SchemaItem><SchemaItem collapsible={false} name={"newStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`enabled`, `disabled`, `locked`]"} schema={{"type":"string","description":"the new status of the account","enum":["enabled","disabled","locked"]}}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></div><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 {},\n {\n \"attributeChanges\": {\n \"name\": \"firstname\",\n \"previousValue\": \"adam\",\n \"newValue\": \"zampa\"\n },\n \"eventType\": \"AttributesChanged\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\"\n },\n {},\n {},\n {\n \"account\": {\n \"id\": \"2c91808a77ff216301782327a50f09bf\",\n \"nativeIdentity\": 127999,\n \"displayName\": \"Sample Name\",\n \"sourceId\": \"8a80828f643d484f01643e14202e206f\",\n \"sourceName\": \"JDBC Entitlements Source\",\n \"entitlementCount\": 0,\n \"accessType\": \"account\"\n },\n \"statusChange\": {\n \"previousStatus\": \"enabled\",\n \"newStatus\": \"disabled\"\n },\n \"eventType\": \"AccountStatusChanged\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"date\": \"2019-03-08T22:37:33.901Z\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"AccessItemAssociated"} value={"AccessItemAssociated"}><ResponseSamples responseExample={"[\n {\n \"accessItem\": {\n \"id\": \"8c190e6787aa4ed9a90bd9d5344523fb\",\n \"accessType\": \"account\",\n \"nativeIdentity\": 127999,\n \"sourceName\": \"JDBC Entitlements Source\",\n \"entitlementCount\": 0,\n \"displayName\": \"Sample Name\"\n },\n \"eventType\": \"AccessItemAssociated\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\",\n \"governanceEvent\": {\n \"name\": \"Access Request 58\",\n \"dt\": \"2019-03-08T22:37:33.901Z\",\n \"type\": \"accessRequest\",\n \"governanceId\": \"2c91808a77ff216301782327a50f09e1\",\n \"owners\": [\n {\n \"id\": \"bc693f07e7b645539626c25954c58554\",\n \"displayName\": \"Jon Snow\"\n }\n ],\n \"reviewers\": [\n {\n \"id\": \"bc693f07e7b645539626c25954c58554\",\n \"displayName\": \"Jon Snow\"\n }\n ],\n \"decisionMaker\": {\n \"id\": \"bc693f07e7b645539626c25954c58554\",\n \"displayName\": \"Jon Snow\"\n }\n }\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"AccessItemRemoved"} value={"AccessItemRemoved"}><ResponseSamples responseExample={"[\n {\n \"accessItem\": {\n \"id\": \"8c190e6787aa4ed9a90bd9d5344523fb\",\n \"accessType\": \"account\",\n \"nativeIdentity\": 127999,\n \"sourceName\": \"JDBC Entitlements Source\",\n \"entitlementCount\": 0,\n \"displayName\": \"Sample Name\"\n },\n \"eventType\": \"AccessItemRemoved\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\",\n \"governanceEvent\": {\n \"name\": \"Manager Certification for Jon Snow\",\n \"dt\": \"2019-03-08T22:37:33.901Z\",\n \"type\": \"certification\",\n \"governanceId\": \"2c91808a77ff216301782327a50f09bf\",\n \"owners\": [\n {\n \"id\": \"bc693f07e7b645539626c25954c58554\",\n \"displayName\": \"Jon Snow\"\n }\n ],\n \"reviewers\": [\n {\n \"id\": \"bc693f07e7b645539626c25954c58554\",\n \"displayName\": \"Jon Snow\"\n }\n ],\n \"decisionMaker\": {\n \"id\": \"bc693f07e7b645539626c25954c58554\",\n \"displayName\": \"Jon Snow\"\n }\n }\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"AttributesChanged"} value={"AttributesChanged"}><ResponseSamples responseExample={"[\n {\n \"attributeChanges\": [\n {\n \"name\": \"firstname\",\n \"previousValue\": \"adam\",\n \"newValue\": \"zampa\"\n }\n ],\n \"eventType\": \"AttributesChanged\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"AccessRequested"} value={"AccessRequested"}><ResponseSamples responseExample={"{\n \"accessRequest\": {\n \"requesterId\": \"2c91808a77ff216301782327a50f09bf\",\n \"requestName\": \"Bing C\",\n \"items\": [\n {\n \"operation\": \"Add\",\n \"accessItemType\": \"role\",\n \"name\": \"Role-1\",\n \"decision\": \"APPROVED\",\n \"description\": \"The role descrition\",\n \"sourceId\": \"8a80828f643d484f01643e14202e206f\",\n \"sourceName\": \"Source1\",\n \"approvalInfos\": [\n {\n \"name\": \"John Snow\",\n \"id\": \"8a80828f643d484f01643e14202e2000\",\n \"status\": \"Approved\"\n }\n ]\n }\n ]\n },\n \"eventType\": \"AccessRequested\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"IdentityCertified"} value={"IdentityCertified"}><ResponseSamples responseExample={"[\n {\n \"certification\": {\n \"id\": \"2c91808a77ff216301782327a50f09bf\",\n \"name\": \"Cert name\",\n \"signedDate\": \"2019-03-08T22:37:33.901Z\",\n \"certifiers\": [\n {\n \"id\": \"8a80828f643d484f01643e14202e206f\",\n \"displayName\": \"John Snow\"\n }\n ],\n \"reviewers\": [\n {\n \"id\": \"8a80828f643d484f01643e14202e206f\",\n \"displayName\": \"Daenerys Targaryen\"\n }\n ],\n \"signer\": {\n \"id\": \"8a80828f643d484f01643e14202e206f\",\n \"displayName\": \"Tyrion Lannister\"\n }\n },\n \"eventType\": \"IdentityCertified\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"AccountStatusChanged"} value={"AccountStatusChanged"}><ResponseSamples responseExample={"[\n {\n \"account\": {\n \"id\": \"2c91808a77ff216301782327a50f09bf\",\n \"nativeIdentity\": 127999,\n \"displayName\": \"Sample Name\",\n \"sourceId\": \"8a80828f643d484f01643e14202e206f\",\n \"sourceName\": \"JDBC Entitlements Source\",\n \"entitlementCount\": 0,\n \"accessType\": \"account\"\n },\n \"statusChange\": {\n \"previousStatus\": \"ENABLED\",\n \"newStatus\": \"DISABLED\"\n },\n \"eventType\": \"AccountStatusChanged\",\n \"identityId\": \"8a80828f643d484f01643e14202e206f\",\n \"dt\": \"2019-03-08T22:37:33.901Z\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
Not Found - returned if the request URL refers to a resource or object that does not exist
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink