Cloud

Get Credential

Get details about a specific credential.

get/v1/credentials/{credentialId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/credentials/{credentialId}
  • 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:readonly)

Path parameters

credentialIdstring required

Cloud credential ID with provider prefix

Example:aws_12345

The ID of the credential to retrieve

Response

OK. Returns the specified credential.

OR
OR

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.