Discard a pending ExternalId and stay on the current value
POST
/v1/integrations/aws-identity-center/external-id/cancel
const url = 'https://example.com/v1/integrations/aws-identity-center/external-id/cancel';const options = { method: 'POST', headers: { 'X-Tenant-ID': '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0', Authorization: 'Bearer <token>' }};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/integrations/aws-identity-center/external-id/cancel \ --header 'Authorization: Bearer <token>' \ --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” X-Tenant-ID
required
string format: uuid
Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.
Responses
Section titled “ Responses ”Pending cleared
Media type application/json
object
external_id
required
Current (committed) ExternalId.
string format: uuid
external_id_pending
Pending ExternalId during a rotation window; null otherwise.
string format: uuid
Example generated
{ "external_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "external_id_pending": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Unauthenticated
Media type application/json
object
code
required
Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).
string
message
required
Human-readable description of the error.
string
details
Optional additional context about the error.
object
key
additional properties
any
notices
Policy notices from determining Cedar rules, if applicable.
Array<string>
Example generated
{ "code": "example", "message": "example", "details": {}, "notices": [ "example" ]}