Given an Azure configuration, fetch a list of available Azure key vaults which can be used to back a group.

Published on Apr 2, 2025

2 minute(s) read

Prev Next

Post

/sys/v1/groups/hmg/azure_vaults

Given an Azure configuration, fetch a list of available Azure key vaults which can be used to back a group.

Security

HTTP

Type bearer

API Key

Header parameter nameAuthorization

Body parameters

Expand All

OneOf

object

kind

string Required

Valid values[ "Ncipher" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

slot

integer Required

string

hsm_order

integer (int32) | null

object

kind

string Required

Valid values[ "Safenet" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

slot

integer Required

string

hsm_order

integer (int32) | null

object

kind

string Required

Valid values[ "AwsCloudHsm" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

slot

integer Required

string

hsm_order

integer (int32) | null

object

kind

string Required

Valid values[ "AwsKms" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

access_key

string | null

secret_key

string

region

string

Valid values[ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "af-south-1", "ap-east-1", "ap-southeast-3", "ap-southeast-4", "ap-south-1", "ap-south-2", "ap-northeast-3", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ca-central-1", "ca-west-1", "eu-central-1", "eu-central-2", "eu-west-1", "eu-west-2", "eu-south-1", "eu-south-2", "eu-west-3", "eu-north-1", "me-south-1", "me-central-1", "sa-east-1", "us-gov-east-1", "us-gov-west-1", "il-central-1" ]

service

string

Valid values[ "kms", "kms-fips" ]

account_id

string | null

object

kind

string Required

Valid values[ "Fortanix" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

string

object

kind

string Required

Valid values[ "FortanixFipsCluster" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

string

credentials

Array of string | null

string

hsm_order

integer (int32) | null

object

kind

string Required

Valid values[ "AzureKeyVault" ]

url

string Required

tls

OneOf

object

mode

string Required

Valid values[ "disabled" ]

object

mode

string Required

Valid values[ "opportunistic" ]

object

mode

string Required

Valid values[ "required" ]

validate_hostname

boolean Required

OneOf

CaConfigVariantCaSet

object (CaConfigVariantCaSet)

ca_set

string Required

Valid values[ "global_roots" ]

CaConfigVariantPinned

object (CaConfigVariantPinned)

pinned

Array of string Required

string (byte)

client_key

string (byte)

client_cert

string (byte)

auth_config

OneOf

object

mode

string Required

Valid values[ "client_secret" ]

client_secret

string Required

object

mode

string Required

Valid values[ "token_auth_config" ]

client_cert

string (byte) Required

client_key

string (byte) Required

secret_key

string

tenant_id

string (uuid) Required

client_id

string (uuid) Required

subscription_id

string (uuid) Required

key_vault_type

string

Valid values[ "STANDARD", "PREMIUM", "MANAGED" ]

endpoints

object

management

string Required

key_vault

string Required

key_vault_managed_hsm

string Required

iam

string Required

object

kind

string Required

Valid values[ "GcpKeyRing" ]

service_account_email

string Required

project_id

string Required

location

string Required

key_ring

string | null

private_key

string (byte)

Responses

2XX

Success result

Array of object

object

string

name

string

vault_type

string

Valid values[ "STANDARD", "PREMIUM", "MANAGED" ]

location

string