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

93 lines
51 KiB
Plaintext
Raw Blame History

---
id: reassign-identity-certifications
sidebar_label: Reassign Identities or Items
hide_title: true
hide_table_of_contents: true
api: eJztXFlz4zYS/iso7UNmpqxbvvSS1cgaR1lfK8uZmnhcMxAJSUgoQsvDttbl/77dDYAiRVqWZ52ztKlNLBJoNBrdXx8A8VBScxHwSCq/75bapUDwMJQT+CH8SEaLrggiOZYOtQhLO6WIT8JS+7q08uJmp+SK0AnkHH8DoeFUhqxz0WeWYsjiOYsU260xqYlLETIVMBmJWcikz7hv3yyYw2dzDr2Ykx4H+3NfRVMRAN1bKe5EUGEdePyr8NmdjKbsfHD8pXN02j9D0t3eYGh+8TiaqgBJA1+B+E8sA+EiPYd7HosMtxU2MGRDNgYC9DzLggNsci/MdUwm7CqYFzDJwng+V0FEo4kw0hQzxEKmZaM5OVa3IvC57wh2HKh4HlZA3nMe8JmIgCGQ+kNJomznPJrCKx9ewC/pwt+hMxUzXmo/lKLFHJ+GUSD9Selxp2QnW2pHQSzy6ySelXr/CEYQ9/DSQ9Ji3DwYH7aarX1x2Nrda4x2R6ODVqPFd/eah/vuQenxRo8Kk36v3AVytcqEo/wIBsVXfD73zEjVX0Jk6iE/HTX6RTgRyiNAhUXd0WS1AFMteRDwBTQktXqeAkgvJ7QiGfWPmBqTrpLOWomNBHRIdFy4lRdKascMvQkL2GJzJvx4hnY67AyOe8Mvl1enp53BJ3jRH/ZO8T9HvbNhf/gpeXOTZpwaPWaU51orGrEJbWFgajkwow7EWAQCdNd000+H6iXSjdK6CAZxN5XOlJ5m9ZEs2E72xQLHrsrfjC/dljlqNgO2yIDvpgtiyXLA7njIZtwVGUaW/FGnUM0ssZxYEx3OiC3hMyNrxCYrcSCkSYVzQBKtzY1aDf+TnUjneVx1RcSlB3A0BqTB6cIsIlSq9ExRBKhar2S72vKWIms4h/WD2kFz122I3freQa2+6zYb44PDmsPruwd1q3xPLph0rRJlJodrrqEyPdqligMA2vM7HybccRwRhgb7acF60EwtBCD5dUgtb54dHsd4kgEr9yKx5GyMuDXDLbsO9c/0oLgWQSA8Hgn3MuJRjB56xn2XRypYdLXWDjR5/BOV6dvgL/Yl4HnKTi1XLwc8uxbPD5qRaOF4XavOZ0h0DZpaOOx2Ti86/eOzooBlibB6aWBcHiHYWHw1CLcC8gnJx5W1WsPGaeesc9wbwJPL86tBt/fl/OOZ/tnrDLo/rOfuaXFYso8r3TcRdurJ6iAsFBEbadjj7gxCtbspxD+AC6B34I6QCT/2PD5CLrSDXzLVWUeahLaqwzkEQ/5WW+Ukwc59b8HS8kzehRS1jQS78pdkIHD0Mw9ygZ6ZvUK60ne8GLjK9khFsm/SMAtKE2faoddmU46BIeOOo2If4kFFMa+NTGHUW8E02rxNu/Du+WDQO+kMexiGXZ2lfmZ8dur543oUeFYfjjDghHWGad1NBYXbxgWCiwjEMn5GqHSFI0MKZt0Yqa2IUcfpYYV9UjEtg+m8pIhEMJZOCO1gJwjpyyT51GNoCPJLHlTYe3w95rEX7WQ5xPi7mMu0ZDsnJ1+Oet3+Zf/87BKeD3o/nf8LlOfs5FPm+dl56mdG6Jk36I6tr7bIlIqLUNPJsYo06I6U8gT3c2vwAwdtyIgFFBiyHAw1vk9bPdob0F6qYrdgFAkueyKCYpiNZyNYYYwsl+qsQx01W2FhilwlfID6uiRuO7EMHO3ulIDKjEd6/GajlGFzqCLubchihG2LGQU0QhjI5KM7bARJYsIVsQkGXMRkvVbEpcG2lQClVj8o1/bKjd1ho9ZuNNqNg0q91vq5lKIANifKkVz67ydtzMIn9iCDVS7w/9uOacdIBk0W9hQD2JeqC0R/AeSsVW2tVe786qs7T7gTkdIYcqJZtcksQKNwAZL+/4+WbMJfhpdWMS9xoS8vlH+BX4WwCVsUhoZZ902LXa+V64fDerPdOmw39yvNg92fkQmT7GzKx6o7LuALedLhva54MJOvqPEYPVPOqDbn1VJ8vex7GdonZZ/fKe4sHs9WiZK4EzIe6W1GnZpmyaPXtLFDdiA7/D8jEUYVQLBNglyb2z8fRj43fEIpi4lPB3uvi1cU96Vwch3bKxD6e7KYgdW1PD6uJvNgJKlyyUp0lhjN6mSyRjQOQC1+A1Nbg1S/YZ739KAZNNo84+sNhv0P/W5nCDHaSsScebUFri1wbYHrJcCVTnfStrma82yWdOokXxda4f8CMzfIPgsiESq5PlEBHmQLrzxddV2tWRNf8Bzy8l4QqKCg8qD3wcaUaBQAFKX0kNMK7L4U+TKnSxgbcy/ENI1anoow5BORH+6ooFKSGc8OtKolOYtKBDJczzOwNIcHGwKMEwcBrg91yVVgPvvv2NfLYee4d/S1zYbpCpIMYdGkLikrrMRwJ5K3VIahXp3usP9Tr6AXtROGdP/4LCGdhK04nXzoamns6OSP6ngOxPug06hYSS742U/hj+YdHmh2sB5HQ2bdRvKyUPkvSJppdSvcSz2KlCngt4pq9l1PopxJLVmZDUQUB74uJGkbpd01SHNdKjZJ/5Z70n3F6rzeEegqdwPN+CB9UZ4EXCKHpFYgX1cwzL6ki2s+U4EwmwxWa6hdFrRBEpU6e89dNjDz65rJoDQDyN+AVn8Dz3ulq9W2C3phvZtbOKzYF3y0VztstMZ7Lc4bB636/u7ocMybzdrh7uEhIbS22PSGot1ozA59LHwRSId5yoEV+S8IxOwhIQPWejfcmyQaG1qmbptM0/DLInEfgQmw990L1tpnHvcnMT3nkxUh+OWryxywwMw14fNATmRhJdnazlHvQ+fqZEhVtH9f9S7hL6SV8+RYJvVdVEtFSfpU3RHHZgII7aHwQBxYoX1nqL6DCXEqJiQNpf4VLkLcDjVVQOhhRi/okSbNMGjOmBLZzX3E3siKqOwARMEz8KnOlI3AoF2LK+9wr2gelU+MJN+xqeCAKW8rrOO6EifJPQbWCESh/4KwznXRdDWBcQymLOiwgoojLFRKJ1sRSYkyB/MGUk7Si4LGAZw/rycdJ4qBOZpm2goTbTEsmvUBnrXkKjmHYoVGIl34EaI0nodY6DK9A8gEc5NRyAwc4XKFADy+bZcgVhopeynnqAESt1TicAO7u/AAfso0teTFrd1zDdHpaDSi1bDLZBAJXuK0qbNplSyXNXwGMYDnbm13a7tb293QdldfDsxJhXToU8+HPle+2RFD55kLfQLSHtxFM41MTEsLSTtEJkT68ePQnAuD9uJ+jjtBrxgfaVeeP2uRrId+PrKHKKzrX64FMkhy1DMYAxIJt018LzkmQWlRNfOjfVDBSIKC+gUhIqBmwBYq1ht2se8jJzzcofNp/nemJs/1yQdCQBzVd8tzJV/1nMc2ktxGkltvtPVG20hyG0lubXdru68dSSZckbWYOCmMZzMeLLSmmfd0JIBBA2bPzLLE5GipVqMVJMaSGKuUjRxKo0Z9VB/vO6Ll8pa71zwcN5y9Bt/dr+/XR63Gfint66+XdpwYWdamUuut15FEDEHcLcRxsQ/KFUZKudnyX4ynnMYIa/RphI2b6Uze480ydmzlY8czFcHcgDDEjsET5cWrwYk+9qjJo9z0sVk02tQZyeSTB3Evw2gbOm5Dx6372bqfv4372YaOW9vd2u5f03ZfFDq2ngsdWy8IHVsMQ6wxhlh/ZOjoQtyBodlY4lntZAc/EHOYCvxlqo/G7CMeTESUBHqZKLJxWPBlhlLslPsLGyyFmUqkvxQXwhu0nWHb5INY/OiXTQAifQaoJZU+LCVnAmNSPJLiyZkkO8YJAd1gUe7QJ2raZqy+JaMkX2kgKHhKnzbAgwdgRWMM/4AC1UEnANSvWOOcPXWg4wX1YDbAGZ/gjFnv3hECbT6p/+4WnRLo4zEZhItLvdZPHBfQNXPuQxoh7ucavpIQdBuqb0P1rbvfuvu/h7vfhupb293a7l/Tdl8Qqpto6OlQHRpsHKpD20qNJbHUB1Su3z1iJ1MxHJB6M+VQrO4uY3CKK0CVkKG5okIrXQXTLlWz18pUH6T7WE1dLKFzAc1aHHjQYxpF87BdrT7AisFKPVb4XFbsgW9f3eGR/eptswB/8LiptjVAMDd2KH/Ai2/0IBWScyBRlTXu0QBa6jQzVFqQPp0zWEvffs6wgFyEaTI7+BWAUSt6jAd5Iaf4LqTWFVKj3BxhbleB9/jcfH5qrpuHJvLEPIrEt3YsaM+Ay5XpIfs3uFyw9ECI1usK+OlqwOrEuNrXN+k2lxigaw5zLZdOB7cGGjmGzrFZg70XPIDsQZ+WefPjx+FbNsGwlGAhDjEiFhLzCDCsC1Ajgr2OPTmCncgTBSqe6OtaOpmzOWhmbOyBUNhn/1IIdm1PRJ+BPxgAgJPYsZMgzMBeN2/s6rniVnjoKitLaaNyStevghSrPNPvLblFyh+krz+LwA+JPvtldiQRreijVGxjpkjpILue23nx1Ly+lYl/WGplTa1M1MK3K1xo0V47+qy3A7aOJLgXkrS+eXBNr5yih8kWPEGqqzygJAwf2RNVjl21b+YjQ6+M9LJ8fPY/0gU/2W5MQxwLwWV6LuszZ6pUKL5nDFUHTeV6EoOlfTNbdKtQmSyi3KilWCrrIcuyDBEk8XcChuFrZeIj9OAUwChdSyGz/UorC7jwlb4z+JqZMz2+BkeLLV3lhN/MMw5YxgHLGidCw7+5t+ctfcWAcyAc0ArQXa4/IYFhNIWLmlYh8hP5KvVB9+EAq0QlnLf1j/YSBM1fjF5g66QNwDQG4MkZM7xLwNBCZ5YRli0drEowz6+nwIeuyE3zm2yAol/9s80XZ9xZVljwtpLXRuknkOTPg7t/EOJtkebviDQmJMZK5WB522DPJi/p2wGv9Re7z39um3xJp2/Au8leZbdJf3u93Nor4HZKaCQkrJWPxNA0dRyar1KGdGED/BveEr5QxgD5mL76EiOvNJm5xyO0REIiZyoF1TfmgkcY0+6gNagZoQcE8ghZeN0PEprQl6vAMsTZfCQ9/ASUfYQE0ndAMTB5xHPFQPUXZbLIS9CNC1QtdmTVjeHFQ7GPtyEBE/GM4TUgz+ikK0Mn1tAJuaQv7Mz0jZ9JL4sjqOwoigqlUcEsPB9jIRxy7JTqPTMWaF5oquAgSPoAV1+ruZzIAC9xkvr602xi8Rxt0PfyVHhzXHDAfQgBRWqE0/4wRxGI+WbrRQWTqukUVrEtEMEkTitDswJJK329CYkg5NopuvbzVqsM5p7VPhWicjeDJfX/7ZWtr3Rlq0EQTMOqcywz4jLFOnXU+fp1KUsTOrXp5r8EsQB4ppjhQ9OHByxKYf76iI+BMax4XN8s01PCN9A5/Ns1nxqvWec35i4w9y1tq210+2vhnGyB1V8saysl+PNXgSUZmNDjDX5dTTUz4lG/MJs0ZXOhoe2Y233CRF730HW4tW1vUrWRi3OsSJZG5u7ZmS7zBPwOJQz/bpc+wz/wQ821+NFX4POHki2aQhtNF//3P9SY18Y=
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 'Reassign Identities or Items' (reassign-identity-certifications)"
---
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"}>Reassign Identities or Items</h1>
<MethodEndpoint method={"post"} path={"/certifications/{id}/reassign"}></MethodEndpoint>
This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. 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 identity campaign certification ID","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><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul 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"}>reassign</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of item or identity being reassigned.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`TARGET_SUMMARY`, `ITEM`, `IDENTITY_SUMMARY`]"} schema={{"type":"string","description":"The type of item or identity being reassigned.","enum":["TARGET_SUMMARY","ITEM","IDENTITY_SUMMARY"],"example":"ITEM"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"reassignTo"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the identity to which the certification is reassigned","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The reason comment for why the reassign was made","example":"reassigned for some reason"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
An identity campaign certification details after completing the reassignment.
</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