Get the credit accounts for the tenants with free tier access

GET 
/v1/tenants/:tenantUid/creditAccount/aws

Get the credit accounts for the tenants with free tier access

Request

Path Parameters

tenantUid stringrequired

Responses

200

OK

application/json

Schema

Schema

creditLimitInDollarsfloat64
creditUsedInDollarsfloat64

loginCredentials

object

iamUserstring

passwordpassword

userCloudAccount

accountIdstring

cloudAccount

object

AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

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 in case of credentialType sts, will be empty in case of credential type secret

arnstring

Arn for the aws sts credentials in cloud account

externalIdstring

ExternalId for the aws sts credentials in cloud account

Example (from schema)

{
  "creditLimitInDollars": 0,
  "creditUsedInDollars": 0,
  "loginCredentials": {
    "iamUser": "string",
    "password": "string"
  },
  "userCloudAccount": {
    "accountId": "string",
    "cloudAccount": {
      "accessKey": "string",
      "credentialType": "secret",
      "partition": "aws",
      "policyARNs": [
        "string"
      ],
      "secretKey": "string",
      "sts": {
        "arn": "string",
        "externalId": "string"
      }
    }
  }
}

Loading...