BucktDocs

Validate AWS account

POST/v1/aws-accounts/{id}/validateaws-accounts:writeSDK: awsAccounts.validate

Calls sts:AssumeRole against the configured roleArn using the externalId Buckt generated. On success the account flips to active, lastValidatedAt is updated, and the real 12-digit AWS account number is recorded. On failure the account is marked failed and the underlying STS error is returned.

Path parameters

NameTypeDefaultDescription
idrequiredstring—The AWS account record ID. Must already have `roleArn` set via [Update](/api/aws-accounts/update).

Example request

import { Buckt } from "@buckt/sdk";

const client = new Buckt({ apiKey: process.env.BUCKT_API_KEY });

await client.awsAccounts.validate("acc_01J5AAAAAAAAAAAAAAAAAAAAAA");
// On success, the account moves to "active" and lastValidatedAt is set.

Responses

{
  "data": {
    "object": "aws_account",
    "id": "acc_01J5AAAAAAAAAAAAAAAAAAAAAA"
  },
  "error": null,
  "meta": null
}