Table Of Contents

  1. Docs
  2. ABEJA Secret SDK documentation
  3. API Client

API Client

API Client represents a low level interface for Secret Manager API. All API operation can be performed using this.

class abeja.secret.api.client.APIClient(credential: Optional[dict] = None, timeout: Optional[int] = None, max_retry_count: Optional[int] = None)

A Low-Level client for Secret Manager API

from abeja.secret import APIClient

api_client = APIClient()
create_secret(organization_id: str, name: str, value: str, description: Optional[str] = None, expired_at: Optional[str] = None, integration_service_type: Optional[str] = None, integration_service_ids: Optional[List[str]] = None) → dict

create a secret

API reference: POST /secret-manager/organizations/<organization_id>/secrets

Request Syntax:
organization_id = "1410000000000"
name = "AWS_ACCESS_KEY"
value = "AKIAIOSFODNN7EXAMPLE"
description = "AWS access key"
expired_at = "2024-12-15T16:50:33+09:00"
integration_service_type = "abeja-platform-labs"
integration_service_ids = ["9909389711171", "9916291917033"]
response = api_client.create_secret(
    organization_id, name, value, description, expired_at, integration_service_type, integration_service_ids)
Params:

  • organization_id (str): organization identifier (required)

  • name (str): secret name (required) 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.

  • value (str): secret value (required)

  • description (str): [optional] secret description

  • expired_at (str): [optional] expiration date (ISO 8601 format)

  • integration_service_type (str): [optional] ABEJA Platform service to integrate secret. Currently, only abeja-platform-labs is supported.

  • integration_service_ids (List[str]): [optional] ABEJA Platform resource ids to integrate secret. If integration_service_type is “abeja-platform-labs”, the integration service ids must be a list of labs app ids.

Return type:

dict

Returns:

Response Syntax:

{
    "id": "2372152227971",
    "organization_id": "3617229248589",
    "user_id": "3614618482910",
    "name": "test-1612",
    "description": null,
    "properties": null,
    "provider": "aws-secret-manager",
    "rotation": false,
    "integration_service_type": "abeja-platform-labs",
    "integration_service_ids": ["9909389711171", "9916291917033"],
    "expired_at": null,
    "created_at": "2025-05-01T07:12:23.319068Z",
    "updated_at": "2025-05-01T07:12:23.319071Z",
    "versions": [
        {
            "id": "1235028292438",
            "organization_id": "3617229248589",
            "secret_id": "2372152227971",
            "value": "test",
            "version": 1
            "status": "active",
            "provider": "aws-secret-manager",
            "created_at": "2025-05-01T07:12:23.321625Z",
            "updated_at": "2025-05-01T07:12:23.321628Z",
        }
    ]
}
Raises:

  • BadRequest: Invalid parameters (organization_id, name, or value is missing)

  • Unauthorized: Authentication failed

  • InternalServerError

delete_secret(organization_id: str, secret_id: str) → dict

delete a secret

API reference: DELETE /secret-manager/organizations/<organization_id>/secrets/<secret_id>

Request Syntax:
organization_id = "1410000000000"
secret_id = "3053595942757"
response = api_client.delete_secret(
    organization_id, secret_id)
Params:

  • organization_id (str): organization identifier (required)

  • secret_id (str): secret identifier (required)

Return type:

dict

Returns:

Response Syntax:

{
    "message": "secret_id 2372152227971 successfully deleted"
}
Raises:

  • BadRequest: Invalid parameters (organization_id or secret_id is missing)

  • Unauthorized: Authentication failed

  • InternalServerError

get_secret(organization_id: str, secret_id: str) → dict

get secret

API reference: GET /secret-manager/organizations/<organization_id>/secrets/<secret_id>

Request Syntax:
organization_id = "1410000000000"
secret_id = "3053595942757"
response = api_client.get_secret(
    organization_id, secret_id)
Params:

  • organization_id (str): organization identifier (required)

  • secret_id (str): secret identifier (required)

Return type:

dict

Returns:

Response Syntax:

{
    "id": "3471958194321",
    "organization_id": "3617229248589",
    "user_id": "3614618482910",
    "name": "test",
    "description": "test",
    "properties": null,
    "provider": "aws-secret-manager",
    "rotation": false,
    "integration_service_type": "abeja-platform-labs",
    "integration_service_ids": ["9909389711171", "9916291917033"],
    "expired_at": "2025-05-21T19:01:00Z",
    "created_at": "2025-04-30T19:01:19.209973Z",
    "updated_at": "2025-04-30T19:01:19.209975Z",
    "versions": [
        {
            "id": "4914543680412",
            "organization_id": "3617229248589",
            "secret_id": "3471958194321",
            "value": "test",
            "version": 1
            "status": "active",
            "provider": "aws-secret-manager",
            "created_at": "2025-05-01T04:02:20.962352Z",
            "updated_at": "2025-05-01T07:10:00.646086Z",
        }
    ]
}
Raises:

  • BadRequest: Invalid parameters (organization_id or secret_id is missing)

  • Unauthorized: Authentication failed

  • InternalServerError

get_secrets(organization_id: str, offset: Optional[int] = 0, limit: Optional[int] = 50) → dict

get secrets

API reference: GET /secret-manager/organizations/<organization_id>/secrets

Request Syntax:
organization_id = "1410000000000"
offset = 0
limit = 50
response = api_client.get_secrets(organization_id, offset, limit)
Params:

  • organization_id (str): organization identifier (required)

  • offset (int): [optional] offset of secrets (which starts from 0)

  • limit (int): [optional] max number of secrets to be returned (between 1 and 100)

Return type:

dict

Returns:

Response Syntax:

{
    "organization_id": "3617229248589",
    "secrets": [
        {
            "id": "3354488798882",
            "organization_id": "3617229248589",
            "user_id": "3614618482910",
            "name": "test",
            "description": "",
            "expired_at": "2025-05-29T04:13:00Z",
            "properties": null,
            "provider": "aws-secret-manager",
            "rotation": false,
            "integration_service_type": "abeja-platform-labs",
            "integration_service_ids": ["9909389711171", "9916291917033"],
            "created_at": "2025-05-01T04:13:32.861378Z",
            "updated_at": "2025-05-01T04:13:32.861380Z",
            "versions": [
                {
                    "id": "9960370863434",
                    "organization_id": "3617229248589",
                    "secret_id": "3354488798882",
                    "value": "test",
                    "status": "inactive",
                    "version": 1
                    "provider": "aws-secret-manager",
                    "created_at": "2025-05-01T04:14:20.657971Z",
                    "updated_at": "2025-05-01T07:05:00.613985Z",
                }
            ]
        }
    ],
    "offset": 0,
    "limit": 50,
    "has_next": false
}
Raises:

  • BadRequest: Invalid parameters (organization_id is missing, offset < 0, limit < 1 or limit > 100)

  • Unauthorized: Authentication failed

  • InternalServerError

update_secret(organization_id: str, secret_id: str, description: Optional[str] = None, expired_at: Optional[str] = None, integration_service_type: Optional[str] = None, integration_service_ids: Optional[List[str]] = None) → dict

update a secret

API reference: PATCH /secret-manager/organizations/<organization_id>/secrets/<secret_id>

Request Syntax:
organization_id = "1410000000000"
secret_id = "3053595942757"
description = "Updated AWS access key"
expired_at = "2025-12-15T16:50:33+09:00"
integration_service_type = "abeja-platform-labs"
integration_service_ids = ["9909389711171", "9916291917033"]
response = api_client.update_secret(
    organization_id, secret_id, description, expired_at, integration_service_type, integration_service_ids)
Params:

  • organization_id (str): organization identifier (required)

  • secret_id (str): secret identifier (required)

  • description (str): [optional] secret description

  • expired_at (str): [optional] expiration date (ISO 8601 format)

  • integration_service_type (str): [optional] ABEJA Platform service to integrate secret. Currently, only abeja-platform-labs is supported.

  • integration_service_ids (List[str]): [optional] ABEJA Platform resource ids to integrate secret. If integration_service_type is “abeja-platform-labs”, the integration service ids must be a list of labs app ids.

Return type:

dict

Returns:

Response Syntax:

{
    "id": "2372152227971",
    "organization_id": "3617229248589",
    "user_id": "3614618482910",
    "name": "test",
    "description": "test",
    "properties": null,
    "rotation": false,
    "provider": "aws-secret-manager",
    "expired_at": null,
    "integration_service_type": "abeja-platform-labs",
    "integration_service_ids": ["9909389711171", "9916291917033"],
    "created_at": "2025-05-01T07:12:23.319068Z",
    "updated_at": "2025-05-01T07:13:37.031149Z",
    "versions": [
        {
            "id": "1235028292438",
            "organization_id": "3617229248589",
            "secret_id": "2372152227971",
            "value": "test",
            "version": 1,
            "status": "active",
            "provider": "aws-secret-manager",
            "created_at": "2025-05-01T07:12:23.321625Z",
            "updated_at": "2025-05-01T07:12:23.321628Z",
        }
    ]
}
Raises:

  • BadRequest: Invalid parameters (organization_id or secret_id is missing)

  • Unauthorized: Authentication failed

  • InternalServerError

ABEJA Secret SDK documentation
ABEJA Secret Version SDK documentation
© Copyright 2018, ABEJA, Inc.. Created using Sphinx.