---
title: "Describe credentials"
method: GET
path: "/credentials/{credentialsId}"
tags: ["credentials"]
---

# Describe credentials

`GET /credentials/{credentialsId}`

Retrieves the details of the credentials identified by the given `credentialsId`.

## Path parameters

- `credentialsId` string, required

## Query parameters

- `workspaceId` integer

## Response `200`

OK

- DescribeCredentialsResponse
  - `credentials` Credentials
    - `id` string
    - `name` string, required
    - `description` string
    - `provider` 'aws' | 'azure' | 'azure_entra' | 'google' | 'github' | 'gitlab' | 'bitbucket' | 'ssh' | 'k8s' | 'container-reg' | 'tw-agent' | 'codecommit' | 'gitea' | 'azurerepos' | 'seqeracompute' | 'azure-cloud', required
    - `baseUrl` string
    - `category` string
    - `deleted` boolean
    - `lastUsed` string, date-time
    - `dateCreated` string, date-time
    - `lastUpdated` string, date-time
    - `keys` union
      - object
        - `discriminator` string
        - `accessKey` string
        - `secretKey` string
        - `assumeRoleArn` string
      - object
        - `discriminator` string
        - `data` string
      - object
        - `discriminator` string
        - `username` string
        - `password` string
      - object
        - `discriminator` string
        - `username` string
        - `password` string
        - `token` string
      - object
        - `discriminator` string
        - `username` string
        - `password` string
      - object
        - `discriminator` string
        - `username` string
        - `password` string
      - object
        - `discriminator` string
        - `privateKey` string
        - `passphrase` string
      - object
        - `discriminator` string
        - `certificate` string
        - `privateKey` string
        - `token` string
      - object
        - `discriminator` string
        - `batchName` string
        - `storageName` string
        - `batchKey` string
        - `storageKey` string
      - object
        - `discriminator` string
        - `username` string
        - `password` string
      - object
        - `discriminator` string
        - `userName` string
        - `password` string
        - `registry` string
      - object
        - `discriminator` string
        - `connectionId` string
        - `workDir` string
        - `shared` boolean
      - object
        - `discriminator` string
        - `username` string
        - `password` string
      - object
        - `discriminator` string
        - `batchName` string
        - `storageName` string
        - `batchKey` string
        - `storageKey` string
        - `tenantId` string
        - `clientId` string
        - `clientSecret` string
      - object
        - `discriminator` string
        - `accessKey` string
        - `secretKey` string
        - `assumeRoleArn` string

## Other responses

- `400` — Bad request
- `403` — Operation not allowed

---

[API](https://skmtc.dev/seqeralabs/apis/seqera-api.md) · [All operations](https://skmtc.dev/seqeralabs/apis/seqera-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/seqeralabs/seqera-api/revisions/d86e2935c8e2/schema)