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

97 lines
53 KiB
Plaintext
Raw Blame History

---
id: make-identity-decision
sidebar_label: Decide on a Certification Item
hide_title: true
hide_table_of_contents: true
api: eJztXG13GrcS/is63A9NcgwGDH7hSy/BJKXXsX0xTk7r+CRiV4CaZcXdF9tcH/77nRlp3xeM06Tt7aFpG1YrjUajmUczI60eK2ohPB5I5Q7sSqcy51/EwBZuIIPlqbCkDy8qe5WAT/1K56bSE14gJ9KiBn7ldq9iC9/y5AKfofloJlj3csCQjM84sw0JFijGFwtP3QmmPOaJO/UFfrn0NFeeYNJ0yiw+X3A5dZmV7ovJQMz9GusCpS/CZfcymLGL4dtP3dN3g3Ok0usPR+aJh8FMeUhM+tDXf0LpCRtZsLjjsGAGpcBkjQ3FnRT3wvPZBAhQebZTi7uMO36h4cj8YraCYboqYH64WCgvoN6EH2iKGWIgDt+HcWlO3oIkPJe7lmBvPRUu/BpIecE9PhcBMASyfqxIlOiCBzN45cILeJI2/PatmZjzSuexEiwXWOoHnnSnldVeJRpspRN4oSibncEpUxMYytMSh3/vZ9KaIbs4n/Fk+sCDeIBGDnYuJgfHk5PWQetInLTah81xezw+bjVbvH14cHJkH1dWt5ovEMtrZS+R781sdkGiblXMF8Ab9zy+RI7jzpGdsQCObIEys5QbwDiQKiiYY5jf/81HUo9FWRFBaEf6lCpX49+EFeAkeGgRgRT0FgRekHOZWKUdidUjpYr5faaskLZpuFW/mw0sxQ+OF3lxwzkacvfycnjxvg8lw/77i3/10ZQTPpO3oCBUkjH8GBhWWlzKF3bftU95IMq4BlOYc5ihig0VqoEETU531qw3jqr1o2qjMWocd1rtzsFRrX5y/Gv5eIEE44HRTM5CX3g/gGlZlvB95s9U6NioHgFHlOD3fFljV7pUuc4SX/kiIOv8rEf+OVGtGg5oHDpfUqMYK+UI7haYGbg2SgPM/34mQM5eMhUJF3PufQF75z4D0w5QQzhzuDeF2thNqZKgRZAlW2o+F67NA6MMbug4fBxV2XtCcYvtn1ambBs28dScDboDlDdqEs5cpOUR5wYLJ1LAiO8loCQMGzllcgJmnCd5D6KILDceMVbfyw2PJMB9BJunbTfBvzyQONInsRtaBufzI81wc1MZUmXWQOPQP5uV2xXawhwwDKptreRFEZMMY/0tskISwiLPFnYtZyfNerV+WK2DnRx0WidoJwfH7V8rq1Vip3pJG2Ynf4Uwic9BidTyXPZMzZgLVHA3M+nxNGb4I0VAe8R5d5SLWu4KYcfWCRBFS6ivQs8SxHayENzotS1lEWSIt/mhpbFnLt2BVoUGPPAH89Bs11fpCdUovhl8D8ftdO9pCNSAoG0uEWNquH6Aer9hqIgr2zCBK8B3YwIeFTByu9Jy9xdgDxoqmvU6/pWzHfdpByFCnueuwRvX2pTCWyeN4/rxQdtuinbj8LjeaNsHzcnxSd3ijfYx2udmVU4W5QzjqDran0r3dqWldHHvgjS7WoJa5Qg1+lBNLQXg/Y2W5+2T3WMfaxmIZFomloJVELemu6TpSD+mO8W58DzhAAbZVwEPQvTV5hyBQHlLY9pDTR5/on19ncMTuhJcupQ7GXGVBa1tPJ5oLp7uNCPR0v56kaqeI9FVNEVF4pEj1Ou+u+wO3p6XxzLYCjvUUwP9AnSDRY0FEAGAnAhPgAufA+qY5Co3VxvYeNc9777tD6Hk6uJ62Ot/uvhwrh/73WHvp83crRdHRDa/NG7nWsYl+U7IhxovqYzbAMOwRkCQBKss6B24mshE3l1JeZebSOvFKqfDBXRC/vK1CpJgF+jxpeUZv/MptANX5dpNyEB06WYKCtGgGT15ktK1nBC4yrYwmAnGxF6kIRRhOlNvAmJiM47RI+K1CnHJhU4w4jThK/QK3rxGm5e1tM5eDIf9s+6ofwqF1+epx4wXnypfbUaBJ/XhFKNSmOeUuxutQhCiiSTIRqhMQjU7RGo5MeqABGL5X1RI02AaJxSRCAbcMaE9E9BUSfKpYkXORuLAs9f4esJDJ9jLcohBejmXacl2z84+nfZ7g6vBxflVHBx9ujg/+yVTfn6ReswIPfMm7ZlFyDSMUMO4ZdAsEPYWEcdPHLQhIxZQYPDM0BH7sSSCSFSxV9KLhCUbPLRymA3nY5hhsKeUOqPMwMrnORZmyFXMB6ivTeKOBpaBo3bKTYb+D5qVDJsjFXBnSxYDrFvOqNTOaiZi3WNjFcxirohNMOAyJhv1Mi4NtuUclHrjGD3yZnvUrHeazU7zuNaot35dFw5strEIPrEFGayygf/v22fUR9xpPLHv0L1/rrqYDMS+ttZ9bn1x1b0j7KlI529wEc2qTWYCmqUTELf/PVqyDX8ZXlrlvITb5zlK1tXQpDHKXMN8yAeT3ahXGyf5kG+vonOJW/ORX47XpFaSjBHGFDpdqSYTXJkKRrU9rxHF75dvE94f5XeW9xelkmO/EyIe6WxHnapmyeOqGfkO2Y6i7v8ZCD+oAYJt4+QOTvvno8Hol6fdyKe6jyllMXG9s/dt8Yr8vhRObmI7B6F/JIsZWN3IYyF1A0Zicl9ofTnvLDaa/GCyRoSJu+9hahuQ6jvGees7zaDR9hFffzgavBn0uiPw0XIec+bVDrh2wLUDrucA12rNhlE+5tku6NRBPlVm8J/w0rnorO3rrHm0wZpT8HjfleJKsxeQG0EKbqEc4vK+5ymvJPOgN8cnFGiUABSF9BDTCmyeiDyJ6WLGJtzxMUyjmu+E7/OpKHZ3WpIpyfQXdbRmdyixqFSefiPPuKcHBVsCjBV6Hs4PNSlkYD66r9jnq1H3bf/0c4eN0hkk6cOkQcAGWqU3dLkVyDtKw1Crbm80eN8vaUX1hCE9eHsek47dVhxO0XWNaOzp4I/yeBb4+6DTqFhxLPjRTeGP5h0KNDuYj6Muc9ul0ctS5b8kaabVLTpgkd1UDRRUwmqtsnx8z5EoZ1JLVmVDEYSeqxNJ2kZpgx3CXJuSTdK94460v2aHfM0CZ4sA0L6n7C004410RXXqcYkcklqBfG3BMPqSNs45nfnQJCOtoXpZ0AZJ1BrsNbfZ0IyvZwaD0vQgfgNagy1W3mudrY6a4CocbQWWdCuOBB8f1k+arclhi/Pmcatx1B6fTPjBQf2kfXJCCK0ttmx7Mtv1W+EKT1rMURbMyH9BIBqAiIHIerc8jUA0trRMXTcepuGXBeIhABNgr3uXrHXEHO5OQyrn05wQ3Or1VQFYYOSa8IUnp7I0kxzZzmn/Tff6bERZtH9f96/gF9IqrOSYJtWb6YqC9Jm6J47NABDafeGAODBD+8pQfQUD4pRMiCtK/eQvfRBmlAWEFqb3khZp0nq3O21KZDcPAXsha6K2BxAFZbCmWjM2BoO2I1x5hXtFi6B6ZiT5is0EB0x5WWNd25Y4SO4wsEYgCu3pCAK3cV/VJKomIZiyoBNNKgwwUSmtbEYkJcoCzBtIOUtPChoHcP60nnStIATmaJhpK4y1xbBo5gd41pKrFRaUSGgk0qUbIErjoamlTtNbgEwwNhn4zMARTpcPwONG9WLESiNlP7U4aoDELZXQ38LuLh2AnyoNLX5xJ+KTALDoaDSi2YimySAS7ZxqW4lqxdMVGb4+87Cz3Z3t7mx3S9vNvxyaUwhp16dRdH2uXbMjhotnwfXxSHtwF81UMj4tTSTtEBkX6ecPI3N4FOqLhwXuBH1D/0gv5cVzFPF86PIxebzRZGXmAhkkOZrjV4BEwu4Q3wnHJCgtqoNib2+UN5agoG6Ji0jHRJYq1Bt2oesiJ9zfo0Os7g8mJ587OyJcu7pQ0g12nuTOk9ytRrvV6O+zGu08yZ3t7mz3/9N2N3qSMVdkLcZP8sP5nHtLrWnmvT6QDxVYdB42OdNKU5X3VpAYi32sStZzqIybjXFjcmSJls1b9uHByaRpHTZ5+6hx1Bi3mkeV9Fp/k9hxbGRZm0rNt55HEjE4cXfgx4UuKJcfKGVn038hnnKaIKzRFyGR30xn8ujsr/EdW0Xf8VwFMDYgDL6jtya9eD0808ceNXmUmz42i0abOiMZfxclHqT/DY8I71zHneu4W352y8/Oddy5jjvb3dnu93YdW0+5jq1nuI4thi7WBF2sP9N1tMHvQNdsIvGsdryD74kFDAV+meyjMfsAP1cNYkcv40U2T0q+zFCKvePuMnKW/Ewm0k3EhfCm8MtyqBt/NQ8VOJsCRLoMUEsqfVgKv5kEnxSPpDhyLsmOcUBA11tWu5MAN/3JZiJ9i3uJv9JAUMCPErFfPHgAVjRB9w8oUB50CkD9DXOc83UHOp6RD2ZDHPEZjpj1Hywh0Obj/G+77JTAAI/JIFxc6blec1xA58y5C2GEeFho+Ipd0J2rvnPVd8v9brn/eyz3O1d9Z7s72/3/tN1nuOrGG1rvqkOFrV11qFurs9iXeoPK9Yd77GQqhgNSb6Ys8tXtxAcnvwJUCRlaKEq00n1Rncp+9u6p/Udpr/bxGze6tENHApqx0HOg/iwIFn5nf/8R5gvmaVXjC1mLjnu76h4P7O/fHZSgDx421ZYG+GWHFkUPeDeW7qRGUvYkKrJGPepAy5zGhSoLsqdTBhvpRx8zLCESYZrMHn4DYJSKivEYL0QUP/hUu0ZKVBgjjO3ac1ZPjef9waZxaCJrxlEmvo19QX0GXOaGh+zf4nTBxAMhmq9r4Ken4aob4lzf3KbrXKF7rjks1EyWHNwYaBYYusBqTfZacA9iB31W5sXPH0Yv2RSdUgKF0Ed/WEiMIsCsLkGNCPS60bkRbETrkKfCqb7ipps5mYNGxiYOCIV9dK+EYDfReehzWA2GAN8kdmwkCDGw1e2LaPZscSccXChribRROaXt7oMU93mm3UtaFPUNc67+KAI/I/roVtmpRKyS0bVAZogUDLKbRTQunhrX1zLxj4haVVOrEjX/ZY4LLdobS5/0tsDSkQR3fJLWV3eu6VVT9DDUghKkmucBJWH4yJ6nsqJZ+2o+MvSqSC/Lx0f3g77UK9OMaYCLLtUaMGumlC9+ZAxVB03lZhqCpX01W3QTU5Usotqsp1iq6i6rsgr+I/F3BobhamXiY1y/yX1ROpNCZvuZZhZw4TN9ZfA5M2YqvoFlFmvayvK/mmfssIodVjVO+IZ/vYqhYoFt4xgIB7QC9JL5JyQwjKZwUdMqRX4iv09tcPmwgFWi4i86+qGTgKD5xegF1o7rAEyj+x2fMMObBAwtXMoywooSB3kJFvl1FKygOblpfuPtT1xV/2rjxRF3k/wK3lXyrVF6DZL8dXD3T0K8HdL8HZHGOMSYpxwm1432n3UN3IYb2AoXXW66uDJ9XVvxJsZ8ib4AMb7vcM0NhJkLCDfcBrjmgrgtL+WDbtBgaeJyn6shTGifuJgv9enqCJ9u/yWiFLtAZKhv6kUvME1m4fAAUYFQ0ZpJQZmWheAB+td7aJlqTkgGYkc+8eIhJDSlb2g9mHIOsbF08GNU9gFCWdeCAWAYiyecgepvysSzV6Cnl6jm7DRSfYZXIIUu3ssETIRzvJDxKfuwpW+FWl4Q1boiGpkK9N2fplWEaWh4KIoaBXTe3L+YYEoeov2UGTzRF1iBb/LxIEj6FFjfApwMZIjXSUl9JW82yHmKNthedSacBeoLrEHgjopUD+8GowJFIOaaTSDlTfdNI38f6wIRDCi1MhzUIHym70ghJIWoP8M5RqB0z1XuC96Bvp82d0tZvBexu1n6d90sbTwKDAX3F5joxOkJdfiqMwY3lSxNaNSJb+QEVwxwYYYZBqj4+IhJMYygV1gMbGHG5eY2CZAJbUHT8LdtPnXeMLcvzF1k9kva1vtGV1SXjjlKAbvLJPtTgZ9fBCaNYMArvOlVZ/VoFPqF2UaqmisXo4aF/TFMNugWOlO4se5tKntzeYE508rYXJA914koj99DIf6/U/kIf+BBLfT04DKC5Y+VKK0LdTRd/Od/SgNpBQ==
sidebar_class_name: "post 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 'Decide on a Certification Item' (make-identity-decision)"
---
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"}>Decide on a Certification Item</h1>
<MethodEndpoint method={"post"} path={"/certifications/{id}/decide"}></MethodEndpoint>
The API makes a decision to approve or revoke one or more identity campaign certification items. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups.
## 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 ID of the identity campaign certification on which to make decisions","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
A non-empty array of decisions to be made.
</div></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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The id of the review decision","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"decision"} required={true} schemaName={"CertificationDecision"} qualifierMessage={"**Possible values:** [`APPROVE`, `REVOKE`]"} schema={{"type":"string","description":"The decision to approve or revoke the review item","enum":["APPROVE","REVOKE"],"example":"APPROVE","title":"CertificationDecision"}}></SchemaItem><SchemaItem collapsible={false} name={"proposedEndDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z","description":"The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions."}}></SchemaItem><SchemaItem collapsible={false} name={"bulk"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates whether decision should be marked as part of a larger bulk decision","example":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>recommendation</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={"recommendation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made.","example":null,"nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"reasons"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"A list of reasons for the recommendation.","example":["Reason 1","Reason 2"]}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time at which the recommendation was recorded.","example":"2020-06-01T13:49:37.385Z"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"comments"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Comments recorded when the decision was made","example":"This user no longer needs access to this source"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
An identity campaign certification object
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"example":"2c9180835d2e5168015d32f890ca1581","type":"string","description":"id of the certification"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"example":"Source Owner Access Review for Employees [source]","type":"string","description":"name of the certification"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>campaign</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the campaign.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the campaign.","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`CAMPAIGN`]"} schema={{"type":"string","enum":["CAMPAIGN"],"description":"The type of object that is being referenced.","example":"CAMPAIGN"}}></SchemaItem><SchemaItem collapsible={false} name={"campaignType"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`MANAGER`, `SOURCE_OWNER`, `SEARCH`]"} schema={{"type":"string","enum":["MANAGER","SOURCE_OWNER","SEARCH"],"description":"The type of the campaign.","example":"MANAGER"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of the campaign set by the admin who created it.","nullable":true,"example":"A description of the campaign"}}></SchemaItem><SchemaItem collapsible={false} name={"correlatedStatus"} required={true} schemaName={""} qualifierMessage={"**Possible values:** [`CORRELATED`, `UNCORRELATED`]"} schema={{"description":"The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source).","enum":["CORRELATED","UNCORRELATED"],"example":"CORRELATED"}}></SchemaItem><SchemaItem collapsible={false} name={"mandatoryCommentRequirement"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`ALL_DECISIONS`, `REVOKE_ONLY_DECISIONS`, `NO_DECISIONS`]"} schema={{"type":"string","description":"Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions.","enum":["ALL_DECISIONS","REVOKE_ONLY_DECISIONS","NO_DECISIONS"],"example":"NO_DECISIONS"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Have all decisions been made?","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"identitiesCompleted"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of identities for whom all decisions have been made and are complete.","example":5,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"identitiesTotal"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of identities in the Certification, both complete and incomplete.","example":10,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"created date"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"modified date"}}></SchemaItem><SchemaItem collapsible={false} name={"decisionsMade"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of approve/revoke/acknowledge decisions that have been made.","example":20,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"decisionsTotal"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The total number of approve/revoke/acknowledge decisions.","example":40,"format":"int32"}}></SchemaItem><SchemaItem collapsible={false} name={"due"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The due date of the certification.","example":"2018-10-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={false} name={"signed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","nullable":true,"description":"The date the reviewer signed off on the Certification.","example":"2018-10-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reviewer</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 reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}></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"}>reassignment</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>from</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 certification.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the certification.","example":"Certification Name"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CERTIFICATION`]"} schema={{"type":"string","enum":["CERTIFICATION"],"example":"CERTIFICATION"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reviewer</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 reviewer.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the reviewer.","example":"Reviewer Name"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The email of the reviewing identity.","example":"reviewer@test.com"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"description":"The type of the reviewing identity.","example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The created date of the reviewing identity."}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"nullable":true,"example":"2018-06-25T20:22:28.104Z","format":"date-time","type":"string","description":"The modified date of the reviewing identity."}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The comment entered when the Certification was reassigned","example":"Reassigned for a reason"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"hasErrors"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Identifies if the certification has an error","type":"boolean","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"errorMessage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the certification error","nullable":true,"type":"string","example":"The certification has an error"}}></SchemaItem><SchemaItem collapsible={false} name={"phase"} required={false} schemaName={"CertificationPhase"} qualifierMessage={"**Possible values:** [`STAGED`, `ACTIVE`, `SIGNED`]"} schema={{"type":"string","description":"The current phase of the campaign.\n* `STAGED`: The campaign is waiting to be activated.\n* `ACTIVE`: The campaign is active.\n* `SIGNED`: The reviewer has signed off on the campaign, and it is considered complete.\n","enum":["STAGED","ACTIVE","SIGNED"],"example":"ACTIVE","title":"CertificationPhase"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"Source Owner Access Review for Employees [source]\",\n \"campaign\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Campaign Name\",\n \"type\": \"CAMPAIGN\",\n \"campaignType\": \"MANAGER\",\n \"description\": \"A description of the campaign\",\n \"correlatedStatus\": \"CORRELATED\",\n \"mandatoryCommentRequirement\": \"NO_DECISIONS\"\n },\n \"completed\": true,\n \"identitiesCompleted\": 5,\n \"identitiesTotal\": 10,\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\",\n \"decisionsMade\": 20,\n \"decisionsTotal\": 40,\n \"due\": \"2018-10-19T13:49:37.385Z\",\n \"signed\": \"2018-10-19T13:49:37.385Z\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n },\n \"reassignment\": {\n \"from\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Certification Name\",\n \"type\": \"CERTIFICATION\",\n \"reviewer\": {\n \"id\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"name\": \"Reviewer Name\",\n \"email\": \"reviewer@test.com\",\n \"type\": \"IDENTITY\",\n \"created\": \"2018-06-25T20:22:28.104Z\",\n \"modified\": \"2018-06-25T20:22:28.104Z\"\n }\n },\n \"comment\": \"Reassigned for a reason\"\n },\n \"hasErrors\": false,\n \"errorMessage\": \"The certification has an error\",\n \"phase\": \"ACTIVE\"\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={"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"}><p> An example of a 404 response object</p><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"}><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