{
  "schema_version": 2,
  "id": "operate/rs/references/rest-api/objects/bootstrap/credentials",
  "title": "Credentials object",
  "url": "https://redis.io/docs/latest/operate/rs/references/rest-api/objects/bootstrap/credentials/",
  "summary": "Documents the credentials object used with Redis Software REST API calls.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-08-12T11:52:45-05:00",
  "page_type": "content",
  "content_hash": "275870cf1c8772f4e8772dbdf0f6a071cd639767226dc31e7bf95896ecaa24a5",
  "sections": [
    {
      "id": "content",
      "title": "Content",
      "role": "content",
      "text": "| Name | Type/Value | Description |\n|------|------------|-------------|\n| client_cert | string      | Client certificate as a PEM string. Use certificate credentials instead of a username and password to join a node to a cluster. Required with `client_key`. See [Certificate-based authentication for cluster management](https://redis.io/docs/latest/operate/rs/security/certificates/certificate-based-authentication#certificate-based-authentication-for-cluster-management). |\n| client_key | string       | The client certificate's private key as a PEM string. Required with `client_cert`. |\n| password   | string       | Admin password. Required unless you use certificate credentials. |\n| trusted_ca | string       | CA that validates the API certificate the cluster presents, as a PEM string. If you omit it, the cluster uses the certificates in its `mtls_trusted_ca.pem` file. |\n| username   | string       | Admin username (pattern does not allow special characters &,\\<,>,\"). Required unless you use certificate credentials. |"
    }
  ],
  "examples": []
}