SEseqeralabs
credentials

Describe credentials

Changed on

Retrieves the details of the credentials identified by the given credentialsId. Include workspaceId when accessing workspace credentials; omit it for user-owned credentials.

get/credentials/{credentialsId}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

credentialsIdstring required

Credentials string identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier; required for workspace credentials and omitted for user-owned credentials

Response

OK

setupSnippetstring nullable

Server-rendered, read-only provider-side setup snippet (e.g. AWS IAM role trust policy) to paste at the cloud provider. Populated when a renderer is available for the credential type and the installation is configured for it; otherwise omitted.

Changes

  • 24f327d93421Revision changes
    • info

      the response optional property /// became write-only for the status

  • ca2c61bb3604Revision changes
    • info

      added the optional property to the response with the status