create

Description

Create a new secret in your organization with a name, value, and optional description and expiration date.

Synopsis

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

  Create a new secret

Options:
  -n, --name TEXT                 Secret name  [required]
  -v, --value TEXT                Secret value  [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

-n, --name

Specify the name of the secret. The secret name can contain ASCII letters, numbers, and the following characters: _-. Do not end your secret name with a hyphen followed by six characters. The secret name must be unique within the same organization. This option is required.

-v, --value

Specify the value of the secret. This is the sensitive data you want to store securely. This option is required.

-d, --description

Provide an optional description for the secret to help identify its purpose.

-e, --expired-at

Specify an optional expiration date for 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

Create a new secret

Command:

$ abeja secret create --name api-key-dev --value my-api-key-123456 --description "Development API key for external service"

Output:

{
  "id": "secret-mnopqr456789",
  "name": "api-key-dev",
  "description": "Development API key for external service",
  "integration_service_type": null,
  "integration_service_ids": [],
  "created_at": "2023-05-12T15:30:00.000000Z",
  "updated_at": "2023-05-12T15:30:00.000000Z",
  "expired_at": null,
  "versions": [
    {
      "version": 1,
      "created_at": "2023-05-12T15:30:00.000000Z"
    }
  ]
}

Create a secret with expiration date

Command:

$ abeja secret create --name db-password-test --value test-db-pass --description "Test database password" --expired-at 2025-12-31T23:59:59+09:00

Output:

{
  "id": "secret-stuvwx789012",
  "name": "db-password-test",
  "description": "Test database password",
  "integration_service_type": null,
  "integration_service_ids": [],
  "created_at": "2023-05-12T15:35:00.000000Z",
  "updated_at": "2023-05-12T15:35:00.000000Z",
  "expired_at": "2025-12-31T23:59:59+09:00",
  "versions": [
    {
      "version": 1,
      "created_at": "2023-05-12T15:35:00.000000Z"
    }
  ]
}

Create a secret with ABEJA Platform Labs integration

Command:

$ abeja secret create --name db-password-test --value test-db-pass --description "Test database password" --integration-service-type "abeja-platform-labs" --integration-service-ids "1111111111111,2222222222222"

Output:

{
  "id": "secret-stuvwx789012",
  "name": "db-password-test",
  "description": "Test database password",
  "integration_service_type": "abeja-platform-labs",
  "integration_service_ids": ["1111111111111", "2222222222222"],
  "created_at": "2023-05-12T15:35:00.000000Z",
  "updated_at": "2023-05-12T15:35:00.000000Z",
  "expired_at": "2025-12-31T23:59:59+09:00",
  "versions": [
    {
      "version": 1,
      "created_at": "2023-05-12T15:35:00.000000Z"
    }
  ]
}