This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Secrets Manager

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of Secrets Manager and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

VersionStatusSupported Until
1.0CURRENT-

OpenAPI URL

https://secretsmanager.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Create Secret

1.1.1 - 1.0

post /v1/secrets

Description

Create secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SecretsManagerCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedSecretsManagerCreateResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
    "description": "description",
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
    "name": "name",
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
    "tags": []
}

Example HTTP response

Response 201

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.2 - Delete Secret

1.2.1 - 1.0

delete /v1/secrets/{secret_id}

Description

Delete secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerTerminatedRequest

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "waiting_time_ndays": 7
}

Example HTTP response

Response 204

1.3 - Generate Random Password

1.3.1 - 1.0

post /v1/secrets/random-password

Description

Generate random password.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
SecretsRandomPasswordRequest

Responses

HTTP CodeDescriptionSchema
200OKSecretsRandomPasswordResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/secrets/random-password

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "exclude_characters": "abcdefg",
    "exclude_lowercase": "false",
    "exclude_numbers": "false",
    "exclude_punctuation": "false",
    "exclude_uppercase": "false",
    "include_space": "false",
    "password_length": 32,
    "require_each_included_type": "true"
}

Example HTTP response

Response 200

{
    "random_password": "random-value"
}

1.4 - List Secrets

1.4.1 - 1.0

get /v1/secrets

Description

List secrets.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		Secret Name
Example : name
any of [string, null]None
querystate
optional		Secret State
Example : Active
any of [array[string], null]None

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/secrets

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "secret": [
        {
            "account_id": "3265ab469f0d406d83073da3e11e7a6c",
            "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "deleted_at": "2025-02-25 03:07:17.000",
            "description": "description",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
            "kms_name": "kmsname",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "my-secret-name",
            "recent_searched_at": "2025-02-25 03:07:17.000",
            "state": "Active",
            "type": "General"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.5 - List Versions of Secret

1.5.1 - 1.0

get /v1/secrets/{secret_id}/versions

Description

List versions of secrets.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerVersionListResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/versions

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "version_list": [
        ""
    ]
}

1.6 - Restore Secret

1.6.1 - 1.0

put /v1/secrets/{secret_id}/restore

Description

Cancel process of deleting secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/restore

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.7 - Set CIDR of Secret

1.7.1 - 1.0

put /v1/secrets/{secret_id}/acl-cidr

Description

Edit the IP CIDR value for access control when retrieving the value of a Secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerSetCidrRequest

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/acl-cidr

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "acl_cidr": "192.168.1.1/24, 10.0.0.1/16"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.8 - Set Description of Secret

1.8.1 - 1.0

put /v1/secrets/{secret_id}/description

Description

Set description of secret.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerSetDescriptionRequest

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/description

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "description": "description"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.9 - Set KMS ID of Secret

1.9.1 - 1.0

put /v1/secrets/{secret_id}/kmsid

Description

Modify the KMS ID used to encrypt the secret value.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerSetKmsRequest

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/kmsid

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "kms_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.10 - Set Label of Version

1.10.1 - 1.0

put /v1/secrets/{secret_id}/label

Description

Labels are added, moved, or removed from a version. If only the move_to_version_id value is used, the label is added. If only the remove_from_version_id value is used, the label is removed. If both values are used, the label is moved from remove_from_version_id to move_to_version_id.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerUpdateLabelRequest

Responses

HTTP CodeDescriptionSchema
200OKNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/label

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "label": "My Custom Label",
    "move_to_version_id": "3265ab469f0d406d83073da3e11e7a6c",
    "remove_from_version_id": "3265ab469f0d406d83073da3e11e7a6c"
}

Example HTTP response

Response 200

1.11 - Show Secret Detail

1.11.1 - 1.0

get /v1/secrets/{secret_id}

Description

Show secret detail.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

1.12 - Show Secret Value

1.12.1 - 1.0

post /v1/secrets/{secret_id}/values

Description

Show secret value.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerShowSecretValueRequest

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowSecretValueResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "label": "CURRENT",
    "version_id": "e7b638507d9f4feeb6032a22b7640bf7"
}

Example HTTP response

Response 200

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

1.13 - Update Secret Value

1.13.1 - 1.0

put /v1/secrets/{secret_id}/values

Description

Update secret value.

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathsecret_id
required		Secret ID
Example : 3265ab469f0d406d83073da3e11e7a6c
stringNone
bodybody
required
SecretsManagerSetSecretValueRequest

Responses

HTTP CodeDescriptionSchema
200OKSecretsManagerShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/secrets/{secret_id}/values

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = secretsmanager 1.0"

Request body

{
    "secret_value": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
}

Example HTTP response

Response 200

{
    "secret": {
        "account_id": "3265ab469f0d406d83073da3e11e7a6c",
        "acl_cidr": "192.168.1.1/24, 10.0.0.1/16",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "deleted_at": "2025-02-25 03:07:17.000",
        "description": "description",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "kms_id": "3265ab469f0d406d83073da3e11e7a6c",
        "kms_name": "kmsname",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "my-secret-name",
        "recent_searched_at": "2025-02-25 03:07:17.000",
        "state": "Active",
        "type": "General"
    }
}

2 - Models

2.1 - SecretsManager

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 3265ab469f0d406d83073da3e11e7a6c
string
acl_cidr
required		Access control list of secret in CIDR
Example : 192.168.1.1/24, 10.0.0.1/16
any of [string, null]
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
deleted_at
required		Date of deletion
Example : 2025-02-25 03:07:17.000
any of [string (date-time), null]
description
required		Description of secret
Example : description
any of [string, null]
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
kms_id
required		Resource ID created in the Key Management Service (KMS) product
Example : 3265ab469f0d406d83073da3e11e7a6c
string
kms_name
required		Resource name of KMS key
Example : kmsname
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Name of key
Example : my-secret-name
any of [string, null]
recent_searched_at
required		Date of recent search
Example : 2025-02-25 03:07:17.000
any of [string (date-time), null]
state
required		State of key(Creating, Active, Error, Stop, To_Be_Terminated)
Example : Active
any of [string, null]
type
required		Type of secret
Example : General
any of [string, null]

2.2 - SecretsManagerCreateRequest

NameDescriptionSchemaDefault
acl_cidr
required		Access control list of secret in CIDR
Example : 192.168.1.1/24, 10.0.0.1/16
string
description
optional		Description of secret
Example : description
any of [string, null]
kms_id
required		Resource ID created in the Key Management Service (KMS) product
Example : 3265ab469f0d406d83073da3e11e7a6c
string
name
required		Secret Name
Example : name
Pattern : ^[A-Za-z0-9_-]*$
Minimum length : 3
Maximum length : 63
string
secret_value
required		The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.
Example : {"key1":"value1","key2":"value2"}
string
tags
optional		Tag List’
any of [array[Tag], null]

2.3 - SecretsManagerCreateResponse

NameDescriptionSchemaDefault
secret
required
SecretsManager

2.4 - SecretsManagerListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
page
required		page
Example : 0
integer
secret
required
array[SecretsManager]
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.5 - SecretsManagerSetCidrRequest

NameDescriptionSchemaDefault
acl_cidr
required		Access control list of secret in CIDR
Example : 192.168.1.1/24, 10.0.0.1/16
any of [string, null]

2.6 - SecretsManagerSetDescriptionRequest

NameDescriptionSchemaDefault
description
required		Description of secret
Example : description
any of [string, null]

2.7 - SecretsManagerSetKmsRequest

NameDescriptionSchemaDefault
kms_id
required		Resource ID created in the Key Management Service (KMS) product
Example : 3265ab469f0d406d83073da3e11e7a6c
string

2.8 - SecretsManagerSetSecretValueRequest

NameDescriptionSchemaDefault
secret_value
required		The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.
Example : {"key1":"value1","key2":"value2"}
string

2.9 - SecretsManagerShowResponse

NameDescriptionSchemaDefault
secret
required
SecretsManager

2.10 - SecretsManagerShowSecretValueRequest

NameDescriptionSchemaDefault
label
optional		Label of secret version. Not allow duplication.
Example : CURRENT
Minimum length : 1
Maximum length : 256
string
version_id
optional		Secret Version ID
Example : e7b638507d9f4feeb6032a22b7640bf7
string

2.11 - SecretsManagerShowSecretValueResponse

NameDescriptionSchemaDefault
secret_value
required		The value of a Secret can be entered as a JSON string in key/value format, up to 10 pairs.
Example : {"key1":"value1","key2":"value2"}
string

2.12 - SecretsManagerTerminatedRequest

NameDescriptionSchemaDefault
waiting_time_ndays
required		Days remaining until deletion
Example : 7
Minimum : 7
Maximum : 30
integer

2.13 - SecretsManagerUpdateLabelRequest

NameDescriptionSchemaDefault
label
required		Label of secret version. Not allow duplication.
Example : My Custom Label
Minimum length : 1
Maximum length : 256
string
move_to_version_id
optional		Secret Version ID
Example : 3265ab469f0d406d83073da3e11e7a6c
any of [string, null]
remove_from_version_id
optional		Secret Version ID
Example : 3265ab469f0d406d83073da3e11e7a6c
any of [string, null]

2.14 - SecretsManagerVersionListResponse

NameDescriptionSchemaDefault
version_list
required
array[object]

2.15 - SecretsRandomPasswordRequest

NameDescriptionSchemaDefault
exclude_characters
optional		Characters to exclude when generating password
Example : abcdefg
Maximum length : 4096
string
exclude_lowercase
optional		Option to exclude lowercase letters
Example : false
boolean
exclude_numbers
optional		Option to exclude numbers
Example : false
boolean
exclude_punctuation
optional		Option to exclude punctuation
Example : false
boolean
exclude_uppercase
optional		Option to exclude uppercase letters
Example : false
boolean
include_space
optional		Option to include spaces
Example : false
boolean
password_length
optional		Length of the password to generate
Example : 32
Minimum : 5
Maximum : 1024
integer32
require_each_included_type
optional		Require all included character types
Example : true
booleanTrue

2.16 - SecretsRandomPasswordResponse

NameDescriptionSchemaDefault
random_password
required		Generate random password.
Example : random-value
string

2.17 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example :
string
value
required		tag value
Example :
string