Skip to main content

Validate the specified AWS account credentials

POST 
/v1/clouds/aws/account/validate

Validate the specified AWS account credentials

Request​

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

required

Request payload to validate AWS cloud account

    accessKeystring

    AWS account access key

    credentialTypestring

    Possible values: [secret, sts]

    Default value: secret

    Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

    partitionstring

    Possible values: [aws, aws-us-gov]

    Default value: aws

    AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

    policyARNsstring[]

    List of policy ARNs required in case of credentialType sts.

    secretKeystring

    AWS account secret key

    sts

    object

    Aws sts credentials

    arnstring

    Arn for the aws sts credentials in cloud account

    externalIdstring

    ExternalId for the aws sts credentials in cloud account

Responses​

Ok response without content

Response Headers

  • AuditUid

    string

    Audit uid for the request

Loading...