Skip to main content
ZStack
Identity & Access/Credentials

CreateCredential

Create a new credential and store it securely in the federation platform.

POST/api/v1/credentials

Operation ID

CreateCredential

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • name
    StringRequired

    Human-readable name to identify the credential.

    Example: prod-db-password

  • description
    StringRequired

    Free-text description of the credential's purpose.

    Example: Primary database password for production environment

  • type
    StringRequired

    Type of the credential (e.g. password, API key, TLS cert, SSH key).

    Example: CREDENTIAL_TYPE_UNSPECIFIED

  • value
    StringRequired

    Sensitive credential value to be securely stored.

    Example: s3cr3t-v@lue

  • expiresAt
    StringRequired

    Timestamp when the credential will expire.

    Example: 2026-01-15T08:00:00Z

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the credential.

    Example: cred-a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • name
    String

    Human-readable name of the credential.

    Example: prod-db-password

  • description
    String

    Free-text description of the credential's purpose.

    Example: Primary database password for production environment

  • type
    String

    Type of the credential (e.g. password, API key, TLS cert, SSH key).

    Example: CREDENTIAL_TYPE_UNSPECIFIED

  • healthStatus
    String

    Current health status indicating whether the credential is valid or expiring.

    Example: CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

  • expiresAt
    String

    Timestamp when the credential will expire.

    Example: 2026-01-15T08:00:00Z

  • createdBy
    String

    Account or principal that originally created the credential.

    Example: admin@example.com

  • createDate
    String

    Timestamp when the credential record was created.

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the most recent operation performed on this credential.

    Example: 2026-01-15T08:00:00Z