update

Description

Update an existing secret’s metadata such as description or expiration date.

Synopsis

$ abeja secret update [--help]
Usage: abeja secret update [OPTIONS]

  Update an existing secret

Options:
  -s, --secret_id, --secret-id TEXT
                                  Secret ID  [required]
  -d, --description TEXT          Secret description
  -e, --expired-at TEXT           Expiration date in ISO 8601 format
                                  (e.g. 2025-12-31T23:59:59+09:00)
  --integration_service_type, --integration-service-type TEXT
                                  Service Type of the ABEJA Platform to integrate secret. Currently, only `abeja-platform-labs` is supported.
  --integration_service_ids, --integration-service-ids TEXT (comma separated)
                                  Resource IDs of the ABEJA Platform to integrate secret.
                                  If `integration_service_type` is "abeja-platform-labs", the integration service ids must be a list of labs app ids with comma separated (e.g. "1111111111111,2222222222222").
  --organization_id, --organization-id TEXT
                                  Organization ID. If not specified, the current
                                  organization ID is used.
  --help                          Show this message and exit.

Options

-s, --secret_id, --secret-id

Specify the ID of the secret you want to update. This option is required.

-d, --description

Update the description of the secret.

-e, --expired-at

Update the expiration date of the secret in ISO 8601 format (e.g., 2025-12-31T23:59:59+09:00).

--integration_service_type, --integration-service-type

Specify the service type of the ABEJA Platform to integrate secret. Currently, only abeja-platform-labs is supported.

--integration_service_ids, --integration-service-ids

Specify the resource IDs of the ABEJA Platform to integrate secret. If integration_service_type is “abeja-platform-labs”, the integration service ids must be a list of labs app ids with comma separated (e.g. “1111111111111,2222222222222”).

--organization_id, --organization-id

Specify the organization ID. If not specified, the current organization ID from the configuration is used.

Example

Update a secret’s description

Command:

$ abeja secret update --secret-id secret-abcdef123456 --description "Updated description for production database password"

Output:

{
  "id": "secret-abcdef123456",
  "name": "database-password",
  "description": "Updated description for production database password",
  "integration_service_type": null,
  "integration_service_ids": [],
  "created_at": "2023-05-01T10:30:00.000000Z",
  "updated_at": "2023-05-12T16:00:00.000000Z",
  "expired_at": "2025-05-01T10:30:00.000000Z",
  "versions": [
    {
      "version": 1,
      "created_at": "2023-05-01T10:30:00.000000Z"
    }
  ]
}

Update a secret’s expiration date

Command:

$ abeja secret update --secret-id secret-abcdef123456 --expired-at 2026-12-31T23:59:59+09:00

Output:

{
  "id": "secret-abcdef123456",
  "name": "database-password",
  "description": "Updated description for production database password",
  "integration_service_type": null,
  "integration_service_ids": [],
  "created_at": "2023-05-01T10:30:00.000000Z",
  "updated_at": "2023-05-12T16:05:00.000000Z",
  "expired_at": "2026-12-31T23:59:59+09:00",
  "versions": [
    {
      "version": 1,
      "created_at": "2023-05-01T10:30:00.000000Z"
    }
  ]
}

Update a secret with ABEJA Platform Labs integration

Command:

$ abeja secret update --secret-id secret-abcdef123456 --integration-service-type "abeja-platform-labs" --integration-service-ids "1111111111111,2222222222222"

Output:

{
  "id": "secret-abcdef123456",
  "name": "database-password",
  "description": "Updated description for production database password",
  "integration_service_type": "abeja-platform-labs",
  "integration_service_ids": ["1111111111111", "2222222222222"],
  "created_at": "2023-05-01T10:30:00.000000Z",
  "updated_at": "2023-05-12T16:05:00.000000Z",
  "expired_at": "2026-12-31T23:59:59+09:00",
  "versions": [
    {
      "version": 1,
      "created_at": "2023-05-01T10:30:00.000000Z"
    }
  ]
}