Cloud

Update AWS Credential

Update an existing credential for AWS.

patch/v1/credentials/aws/{awsCredentialId}

Request

Base URL: https://api.lucid.co
URL: https://api.lucid.co/v1/credentials/aws/{awsCredentialId}
Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: cloud.credential)

Path parameters

awsCredentialIdstring required

AWS credential ID

Example:aws_12345

The ID of the AWS credential to update

Request body

arnstring

When provided, the AWS resource identifier with which the trust relationship was formed via the externalId

namestring

When provided, the name to give the credential

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

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

Response

OK. Returns the updated 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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.