mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
91 lines
31 KiB
Plaintext
91 lines
31 KiB
Plaintext
---
|
|
id: delete-workgroup-members
|
|
sidebar_label: Remove members from Governance Group
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21v2zgS/iuE7sO2QfwaJ47z4Q5uk3a9aDe5xEFxSIIrLdE2txKpJaWm3iD//WaGlCzZzku7vbvdhVEgtSVqOK/PPKSpu0CnwvBMajWKgqMgErHIxAdtPs2MztP3IpkIY4PdwIowNzJbBEdXd8GlFea1Vpn4kg3zbA7XAhmpo9visaNbGCqCm/ub3SDjM4sD3urPwiiuQsHe4hgbwM1I2NDIFKeHycdzadnwbMSMSGC0ZVoJpg1LtBGMJU4XNjU6YZytymsyNmSZ/iQUu5XZHOXsstPzt/8eHr8f/cw46KnRAAZzGPFrLo2IYDwLeRyzzM/cvFbX6u+M7ey80XGsb6WasakUccT0lI0ioTIvgSumSW0e+wFSgRRBooXNmjs7pSjFE7GzAz5MuYGPGToUvYjXwerSaxCA3UCiI1IOTl31zugYlcA51kyHsYVJwVFmcgHxCuci4cHRXZAtUpzGZgasgZHiC0/SGC91w0HnsH3I+4edvfagzdsd+NTrdDuDzkCEIQ/uMYDeolc6WqC4ulLvpM1QLel8IyFo4NOJ8CGMXLQ2hKsMZwwSNhkQYn6pDKfkaRrLkJK09YvFee8q9j1TIR5FoA5kU6EZXH6GWt573Bi+wPBkIrEVr+rJLyLM1mPlU+UHyybcypBFIuMytigxNVhyqNlSznqUHpR3PD5lOBhFCZUnWFuj45Ofx6Pxv7CkluEtr96D3tHzJ2Gj4+ZKnvQhT3jvYMp5JESv3TmYTnqi3TkMu+2DXhcncMn8FXZE0qYxXzB8sD7dexnOuYiZ/99CGt5X7l+Vk5QGOvuC3kGPi/5k2h90RG8wjSb93kH7gHdFjx8ODvb2g0LNYBhFUrCLBIAiIJCSGU39Ko8/rYLfuct/1OIe09SmWlkXvG67/3AGOiiNACoipnRWfq9kJhXHkyn4jZWAtmDWPzzBubfla/K8nr0urTbFGEDRVOpwgfg4QY3c5KRYy5ViiZlLNTaA1ZPBheDYjGe5XVfpWo0BNn8cj89YET/mxrJQR6hAlhuFaAX4ANAuVSQ/yygHcC/0zeY8K1oH6OrHUkxhDhblqDAACtnoQs3K1urbSrfdY4w1ao2khpOPp4IT0tsgBNPL6wkuX2sP1+pRz4Ja6Lyay1Y9+GOegF+M4BGfxKXzKmMozTFTuVTkCagw3x9DxxTAq+CyhLvRE51nzOZhKKxFVJ4CPOYQHCay8CmF0Q2l+UVZPduB52IqjIAhGyrDlbwjEEs4jNh1MAn3eL/XO+gf7u/1xKR/yA/b7a4Q3fbhfjQ96F0H7Ja7SEx1riK0weFF0daQIwVljlZAZwVwjsmgERRgsAJ7zwW5ogwosg+i/Fc4roaRK+oizDiVCzjxSNlrt9fz6HUsYXp2YgzEvAGx8IUnp1X2xCZANjCxpfrMYxl9FQo+jliuEb+Gqn+6W72RSjRmBjIaNBSkMsEFSAR0wCwnZupEFuSMxtUbGnii2WGveMR8L2GvvTHgpszw8BPIGj2jQ18qCc+z4hEAV0KhB6YVfcEnB+1Btwf5yXn3sNfp708GU74HbG9/MMDZEyg/PqtSkbIF1Kd+K5QwQGRiDYRZ/gYOATAA35MCNPnzuwbJeIb/EbTd2NJMry9DQNkFuH31+oz1+izmapbTdT5bcYJqXF5g48/jGKHL0Uuw3Ak+NXIm1Uaa7LnV8cmb4eW7MVw5P/nn5ckFfEJZa4uXoWsbkJaaUHiub0ljbwCCg4UyCaHkmmzHS90Bg7iy1YHSfbMLaDIJ5NaU53EGT/jZNzxRFe2quVpKBfq+kE3R3AUmDNcAhMM5MlNkxG7dsjMEKE6zxjvvyR02B7AX5mWTDZdQDtUIQuH5xZJS+4XPNIdSFgSdCO0AhDJcIXZLV9ajscSWd9WgYHGA5k/nyTDMsFWTmdUqLLPFq+jjAzo7z9W1G1ecRi5dQDMLwQpYIC7AjcaAh6G/QyPLLPNwhOGyADyqGFciFkJgYRbB3XunzHGm6V7Ic/uMujuLAX4aZFp5gygTFh+tbRwaiWrH9YgEN9FsetiPKsNVFL5bvW5rd1u729p9Zu2u3ix4j79L1KezTn0uld+Dwua5Rn2McES+2Kj6zfFkF8hdZMieIv30Yey3uWC8+JIiufyO/Mi18jXlh2U83PUJ0o8yWLVYoILkR2cBEnsRHZHeS43JUc5Ve+uzvdFmIiFB1QaKCKhp2ELnjIPLTK7casPuskgLq37I2JwDPnK3sCAExFlV1Ei1VF+3nt4yyS2T3HajbTf6Q3ejLZPc1u62dv+ctfsokyy1omrxPMnmScLNwmWav4/WcgYDlpvbZclRqFbZCgpjJccK6swhmHQ7k860H4pexHvRwd5g2g0Puny/3+l3Jr1uP6j2+qtlHZdFVq+pSrxdHMnFQOI+A4/LFSSXzbSO6tt/4F4jpghr9DNdwZvB57gXWXLH7mCdO461Zu+5WhQMydY4pFr6CDENxiY41hRjYQBnM8BFxQCqpKYffjOZCJBiIGlYLBNJxYtWgFyzaAynGZjiCmX5M7CfRaowzkFDQoJYI2vWkFgSjBRT5HwggRjsDND5O7JTH6LfxeTZOVr8Di1mJ19CIbDQS+a+v2l/dwTKG8SICxfgBzZ63WqHK0gAWBA4zCp555afb/n5tsdve/xfo8dv+fm2dre1++es3a/g554NPczPYcCz+TmMbbZZyaXeYHL9z2k6lYrXgNKb6TDMDW03FxyceAWkEiqUaksggmcXj4JWeazRtu4qRxzvW/5kQQtPyjTcIQQ8s0B80amamxgkzLMstUet1h1EECJ33+SpbBbHiZS+bYY6aU3AbRsQCY8OuOrDAXSm1E3QJJ8biWntMJCEuwiQlZjAEAnaLX5UMh4lw9AudA6oR2J28WSeTzG6DCqmsL74wfpjbuixNfvArksT3/9+W5ygB2zZ5L5HZ4PxDDRdMRFNuFkeB75AMu5mXzsUvGwwuIDrrk12isO67JXgBg9Y0W8aL376MH7JZkhBCQJyi+xXSFwzQBGdQYoQxA2L/X18iLoOpNdsTooPa7+gYEmxaQwGs2t1IQS7Kk7A/AzYfw5gTS7FhwThAz5186KITiQ+ixjbYnPpSUw8GakWeKjFa8+9pBZIa4XKaafmtWqwY4nIJLGV4xhvojs0dpUWdvGKXd+qxN8KaQ0nrUHS7MsVLZxrr0J3IieEukYRPLbkrW+e3MlrVOThwgquoNRVHdATXo/6715hEbVv1qMmr4Hy6npcqw9zCf21/hhzcMYstMc4YiMWzrW24h+MYepgGVzNcqiib1brFidtUEU0uu2KSg03ZUM2gC2Sfu+gMJRLJndcjsiKBh6nIleSHymyUPMf6fjdx5rNdPkKmiqOjHRov1lnnLCBEzYcBlivvz/U/JKO66ENhAMuAV4v409I4BWt4J6TtRHVSXyLnsHWEIKqJMWmR+7L0RLg/CdGN3B0OQZgGMl2+UsgHvT3srBx1ZxVbBOsenBd31hDv1zxm9O33KbCHvpHsxctHi53U05VvPjeKP0AkvxxcPf/hHhbpPkrIo2nv7greb58Q+bkv/mWAqY2mejXJNWCeuW54fpOIm51zwX8hbuEC8TqYc3kjjkjY6oKSmOeYQURgoRzKWgPIhU8Q565i1msE6r61GiEGlhpkqCZgTEAERb4L5/IGOTRLnkxM6fidCQWcwi/25wWQvQe1hzWtKLJPsCyUIWQArgkxHMecO8X7deGF5AFZ5hE7LhILCB4SZIrPNEMaucJ45C+T2RfJG2YO5CEFaIShS800czyqQIxMK3RBHpBQZjEnk5xextWzpUke2IuyDHr97bB9RhFH+SlIecipirAcfUlwlOyIbMbcxGnuCgFhBd4CHs5w/vReE0iCFMW7ILFvzazln/ItnAsCMGlmEufvWan2W7Q0gSu4xoPltEV4efuFY7ay3mrh8lXc/JuucX/l3/nz4MAropaKe7woRtzt0pzS+Wr5RuAGPmj+vuASfkGZnW9DGAwx+U2PHx3hztEuIC8x8ugCW4/XN0s14YERpAq+BkAaApAKR6JyItz76mX7PFXDjeaVmxxqsVydyOAj58EbopUbbu/geFu+4o0dCP87yWN8YLYTSFh7YcgXEe7J9yW2KNjbyrbFGenuDkYTPzrjInbcTH8Fi7i36PgGv7BFxdr6gZ0/S4o9i9hjJNb0MhNLMp/gEjAsP8A5qK5VQ==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Remove members from Governance Group' (delete-workgroup-members)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Remove members from Governance Group</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workgroups/{workgroupId}/members/bulk-delete"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API.
|
|
|
|
> **Following field of Identity is an optional field in the request.**
|
|
|
|
> **name**
|
|
|
|
## 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={{"name":"workgroupId","in":"path","description":"ID of the Governance Group.","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}}></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"}}>
|
|
|
|
List of identities to be removed from a Governance Group members list.
|
|
|
|
</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={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Identity's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity ID.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's display name.","example":"Michael Michaels"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"207"} value={"207"}><div>
|
|
|
|
List of deleted and not deleted identities from Governance Group members list.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Identifier of identity in bulk member add /remove request.","type":"string","example":"464ae7bf791e49fdb74606a2e4a89635"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"\nThe HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation.\n\n> 204 - Identity is removed from Governance Group members list.\n\n> 404 - Identity is not member of Governance Group.\n","type":"string","example":"204"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Human readable status description and containing additional context information about success or failures etc.\n","type":"string","example":"\n> Identity deleted from Governance Group members list.\n\n> Referenced Governance Group Member with Identity Id \"bc3a744678534eb78a8002ee2085df64\" was not found.\n"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n \"status\": \"204\",\n \"description\": \"Identity deleted from Governance Group members list.\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |