CryptoManagerKmsProvidersInfo

The Providers.Info structure contains fields that describe the details of a provider.

Properties

array of StdLocalizableMessage

details Required

Details regarding the health status of the provider. When the provider Providers.Health is not NONE or OK, this field will provide actionable descriptions of the issues.

CryptoManagerKmsProvidersHealth Enum

health Required

The Providers.Health enumerated type describes the health status of a provider.
NONE : No health status is available.
OK : Operating normally.
WARNING : Operating normally, but there is an issue that requires attention.
ERROR : There is a critical issue that requires attention.

Possible values are: NONE , OK , WARNING , ERROR

CryptoManagerKmsProvidersType Enum

type Required

The Providers.Type enumerated type contains the types of providers.
NATIVE : Native provider

Possible values are: NATIVE

CryptoManagerKmsProvidersConstraints

constraints Optional

The constraints on the provider. If unset, there are no constraints on the provider.

CryptoManagerKmsProvidersNativeProviderInfo

native_info Optional

Native provider information This field is optional and it is only relevant when the value of Providers.Info.type is NATIVE.

JSON Example

Show optional properties

{
	"details": [
		{
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string"
		}
	],
	"health": "NONE",
	"type": "NATIVE"
}

{
	"constraints": {
		"tpm_required": false
	},
	"details": [
		{
			"args": [
				"string"
			],
			"default_message": "string",
			"id": "string",
			"localized": "string",
			"params": {
				"key": {
					"d": 0,
					"dt": "string",
					"format": "SHORT_DATE",
					"i": 0,
					"l": {
						"id": "string",
						"params": "StdLocalizationParam Object"
					},
					"precision": 0,
					"s": "string"
				}
			}
		}
	],
	"health": "NONE",
	"native_info": {
		"key_id": "string"
	},
	"type": "NATIVE"
}

Returned By

Get KMS Providers

CryptoManagerKmsProvidersInfo

Properties

JSON Example

Returned By

Was this page helpful?