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

Return to the regular view of this page.

Models

1: PrivateAclResource
2: PrivateAclResourceId
3: SecretsManager
4: SecretsManagerCreateRequest
5: SecretsManagerCreateRequestV1Dot1
6: SecretsManagerCreateResponse
7: SecretsManagerCreateResponseV1Dot1
8: SecretsManagerIncludeKmsInfo
9: SecretsManagerIncludePrivateAcl
10: SecretsManagerIncludePrivateAclAndSrn
11: SecretsManagerListResponse
12: SecretsManagerSetCidrRequest
13: SecretsManagerSetDescriptionRequest
14: SecretsManagerSetKmsRequest
15: SecretsManagerSetPrivateAclRequest
16: SecretsManagerSetSecretValueRequest
17: SecretsManagerShowResponse
18: SecretsManagerShowResponseV1Dot1
19: SecretsManagerShowResponseV1Dot2
20: SecretsManagerShowSecretValueRequest
21: SecretsManagerShowSecretValueResponse
22: SecretsManagerTerminatedRequest
23: SecretsManagerUpdatedPrivateAclResponse
24: SecretsManagerUpdateLabelRequest
25: SecretsManagerVersionListResponse
26: SecretsManagerVersionListResponseV1Dot1
27: SecretsRandomPasswordRequest
28: SecretsRandomPasswordResponse
29: Tag

1 - PrivateAclResource

Name	Description	Schema
resource_id optional	Resource identifier Example :	string
resource_name optional	Resource name Example :	string
resource_type optional	Resource type Example :	string

2 - PrivateAclResourceId

Name	Description	Schema	Default
resource_id optional	Resource identifier Example :	string

3 - SecretsManager

Name	Description	Schema
account_id required	Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr optional	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]

4 - SecretsManagerCreateRequest

Name	Description	Schema
acl_cidr optional	Access control list of secret in CIDR Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]
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]

5 - SecretsManagerCreateRequestV1Dot1

Name	Description	Schema
acl_cidr optional	Access control list of secret in CIDR Example : `192.168.1.1/24, 10.0.0.1/16`	any of [string, null]
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
private_acl_enabled optional	Enable private access control Example : `true`	boolean
private_acl_resources optional	Private access control resources Example : `[{'resource_id': 'vs-xxxxx'}]`	any of [array[PrivateAclResourceId], null]
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]

6 - SecretsManagerCreateResponse

Name	Description	Schema	Default
secret required		SecretsManager

7 - SecretsManagerCreateResponseV1Dot1

Name	Description	Schema	Default
secret required		SecretsManagerIncludePrivateAcl

8 - SecretsManagerIncludeKmsInfo

Name	Description	Schema
account_id required	Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr optional	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
managed_type required	scp or user Example :	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]
offering required	Name of offering Example :	string
private_acl_enabled optional	Enable private access control Example : `true`	boolean
private_acl_resources optional	Private access control resources Example : `[{'resource_id': 'vs-xxxxx', 'resource_name': 'my-server', 'resource_type': 'virtual_server'}]`	any of [array[PrivateAclResource], null]
recent_searched_at required	Date of recent search Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
region required	Name of region Example :	string
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]

9 - SecretsManagerIncludePrivateAcl

Name	Description	Schema
account_id required	Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr optional	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]
private_acl_enabled optional	Enable private access control Example : `true`	boolean
private_acl_resources optional	Private access control resources Example : `[{'resource_id': 'vs-xxxxx', 'resource_name': 'my-server', 'resource_type': 'virtual_server'}]`	any of [array[PrivateAclResource], 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]

10 - SecretsManagerIncludePrivateAclAndSrn

Name	Description	Schema
account_id required	Account ID Example : `3265ab469f0d406d83073da3e11e7a6c`	string
acl_cidr optional	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]
offering required	Name of offering Example :	string
private_acl_enabled optional	Enable private access control Example : `true`	boolean
private_acl_resources optional	Private access control resources Example : `[{'resource_id': 'vs-xxxxx', 'resource_name': 'my-server', 'resource_type': 'virtual_server'}]`	any of [array[PrivateAclResource], null]
recent_searched_at required	Date of recent search Example : `2025-02-25 03:07:17.000`	any of [string (date-time), null]
region required	Name of region Example :	string
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]

11 - SecretsManagerListResponse

Name	Description	Schema
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]

12 - SecretsManagerSetCidrRequest

Name	Description	Schema	Default
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]

13 - SecretsManagerSetDescriptionRequest

Name	Description	Schema	Default
description required	Description of secret Example : `description`	any of [string, null]

14 - SecretsManagerSetKmsRequest

Name	Description	Schema	Default
kms_id required	Resource ID created in the Key Management Service (KMS) product Example : `3265ab469f0d406d83073da3e11e7a6c`	string

15 - SecretsManagerSetPrivateAclRequest

Name	Description	Schema	Default
private_acl_enabled optional	Enable private access control Example : `true`	boolean
private_acl_resources optional	Private access control resources Example : `[{'resource_id': 'vs-xxxxx'}]`	any of [array[PrivateAclResourceId], null]

16 - SecretsManagerSetSecretValueRequest

Name	Description	Schema	Default
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

17 - SecretsManagerShowResponse

Name	Description	Schema	Default
secret required		SecretsManager

18 - SecretsManagerShowResponseV1Dot1

Name	Description	Schema	Default
secret required		SecretsManagerIncludePrivateAclAndSrn

19 - SecretsManagerShowResponseV1Dot2

Name	Description	Schema	Default
secret required		SecretsManagerIncludeKmsInfo

20 - SecretsManagerShowSecretValueRequest

Name	Description	Schema	Default
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

21 - SecretsManagerShowSecretValueResponse

Name	Description	Schema	Default
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

22 - SecretsManagerTerminatedRequest

Name	Description	Schema	Default
waiting_time_ndays required	Days remaining until deletion Example : `7` Minimum : `7` Maximum : `30`	integer

23 - SecretsManagerUpdatedPrivateAclResponse

Name	Description	Schema	Default
secret required		SecretsManagerIncludePrivateAcl

24 - SecretsManagerUpdateLabelRequest

Name	Description	Schema
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]

25 - SecretsManagerVersionListResponse

Name	Description	Schema	Default
version_list required		array[object]

26 - SecretsManagerVersionListResponseV1Dot1

Name	Description	Schema
count required	count Example : `20`	integer
page required	page Example : `0`	integer
size required	size Example : `20`	integer
sort optional	sort Example : `['created_at:asc']`	any of [array[string], null]
version_list required		array[object]

27 - SecretsRandomPasswordRequest

Name	Description	Schema	Default
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`	integer	32
require_each_included_type optional	Require all included character types Example : `true`	boolean	True

28 - SecretsRandomPasswordResponse

Name	Description	Schema	Default
random_password required	Generate random password. Example : `random-value`	string

29 - Tag

Name	Description	Schema	Default
key required	tag key Example :	string
value required	tag value Example :	string