Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Cloud

Create AWS Credential

Create a new credential for AWS. The external ID generated in the request to Get AWS External ID will be retrieved and included in the request to AWS automatically.

post/v1/credentials/aws

Request body

namestring required

The name to give the created credential

arnstring required

The AWS resource identifier with which the trust relationship was formed via the external ID

orgMemberAccountRoleNamestring

When provided, the IAM role that exists in each of your AWS member accounts to be included by Lucid when making requests on your behalf

Example request

{
  "name": "Example AWS Credential",
  "arn": "arn:aws:iam::123456789012:role/LucidCloudRole",
  "orgMemberAccountRoleName": "OrganizationAccountAccessRole"
}

Response

Created. Returns the newly created AWS credential.

credentialIdstring required

AWS credential ID

type'aws' required

Example response

{
  "credentialId": "aws_12345",
  "params": {
    "name": "Example AWS Credential",
    "arn": "arn:aws:iam::123456789012:role/lucidimport",
    "orgMemberAccountRoleName": "LucidCloudMemberAccountRole"
  }
}