Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
  • CipherTrust Manager
  • CipherTrust Application Data Protection (CADP)
  • CipherTrust Application Key Management (CAKM)
  • CipherTrust Batch Data Transformation (BDT)
  • CipherTrust Cloud Key Management (CCKM)
  • CipherTrust Data Discovery and Classification (DDC)
  • CipherTrust Data Protection Gateway (DPG)
  • CipherTrust Database Protection (CDP)
  • CipherTrust Intelligent Protection (CIP)
  • CipherTrust Integrations
  • CipherTrust Migrations
  • CipherTrust RESTful Data Protection (CRDP)
  • CipherTrust Transparent Encryption (CTE)
  • CipherTrust Transparent Encryption Userspace (CTE-U)
  • CipherTrust Secrets Management (CSM)
  • CipherTrust Vaulted Tokenization (CT-V)
  • CipherTrust Vaultless Tokenization (CT-VL)
  • CTE-Linux
  • CTE-Windows
  • CTE-AIX
  • CTE-K8s
  • CTE-U
  • Crypto Command Center
  • Data Protection on Demand
  • Luna Cloud HSM
  • Luna Network HSM
  • Luna PCIe HSM
  • Luna USB HSM
  • OneWelcome Identity Platform
  • ProtectApp LUKS
  • ProtectServer 2 HSM
  • ProtectServer 3 HSM
  • SafeNet Trusted Access (STA)
  • SafeNet MobilePASS+
  • SafeNet MobilePASS+ for Android
  • SafeNet MobilePASS+ for Chrome
  • SafeNet MobilePASS+ for macOS
  • SafeNet MobilePASS+ for iOS
  • SafeNet MobilePASS+ for WatchOS
  • SafeNet MobilePASS+ for Windows
  • SafeNet Synchronization Agent
  • SafeNet Logging Agent
  • SafeNet Agent for FreeRADIUS
  • SafeNet Agent for NPS
  • SafeNet Agent for Windows Logon
  • SafeNet Authentication Service Private Cloud Edition (SAS PCE)
  • SafeNet Remote Logging Agent
  • SafeNet Keycloak Agent
  • SafeNet IDPrime Virtual (IDPV)
  • SafeNet FIDO Key Manager
  • SafeNet FIDO Key Manager for Android
  • SafeNet FIDO Key Manager for iOS
  • SafeNet FIDO Key Manager for Windows
API docs by Redocly

Luna Cloud HSM Google Marketplace Service API (1.3.1)

Download OpenAPI specification:Download

Bundle

Create a Client zip bundle using service binding details

Create a Client zip bundle from the user provided service binding details. The bundle contains configuration files, certificates, and Linux and Windows binaries for connecting to a Luna Cloud HSM.

Authorizations:
OAuth2
path Parameters
instance_id
required
string

An OSB service instance id for a service in your tenant.

binding_id
required
string

An OSB service binding id for a Client bound to a service in your tenant.

Request Body schema: application/json

Input parameters for Client zip bundle generation.

clientId
required
object non-empty
clientSecret
required
string non-empty
metadataUrl
required
string non-empty
host
required
string
port
required
integer

Responses

Request samples

Content type
application/json
{
  • "clientId": "37cf2a58-9196-4db7-bf7f-e58e0783ed5b",
  • "clientSecret": "ElIphJlj0RRusYeOg74PZFgrTbDzYKFBnkwQ8Ys8Be7208pnyTbvu0a89X02jmPN",
  • "metadataUrl": "string",
  • "host": "string",
  • "port": 0
}

Response samples

Content type
No sample

Create a Client zip bundle using a Client ID and Client secret

Create a Client zip bundle using a Client ID and Client secret. The Client zip bundle contains Linux and Windows binaries. The bundle contains configuration files, certificates, and binaries for connecting to a Luna Cloud HSM.

Authorizations:
OAuth2
Request Body schema: application/json
clientId
required
string

The Client unique identifier.

clientSecret
required
string

The Client secret.

Responses

Request samples

Content type
application/json
{
  • "clientId": "caf85feb-21f7-41cc-8277-002b5b0942dc",
  • "clientSecret": "ElIphJlj0RRusYeOg74PZFgrTbDzYKFBnkwQ8Ys8Be7208pnyTbvu0a89X02jmPN"
}

Info

Return the DPoD Tenant login page for the service

Returns the DPoD login page and tenant id associated with the service instance. The endpoint is only available for services which have a unique dashboard instance.

query Parameters
dashboard_id
required
string

Responses

Response samples

Content type
application/json
{}

Partitions

Return available service partitions and partition details

Returns a list of all provisioned service partitions and associated partition details.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a partition

Create a service partition. If not specified, the default partition deviceType is cryptovisor.

Authorizations:
OAuth2
Request Body schema: application/json
name
string [ 1 .. 100 ] characters

The partition name.

deviceType
string (DeviceTypeEnum)
Default: "cryptovisor"
Enum: "cryptovisor" "cryptovisor_fips"

Responses

Request samples

Content type
application/json
{
  • "name": "My Luna Cloud HSM Service Partition",
  • "deviceType": "cryptovisor"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "partitionCertificate": "string",
  • "partitionCACertificate": "string",
  • "serviceId": "string",
  • "metadata": { },
  • "name": "My Luna Cloud HSM Service Partition",
  • "serialNumber": 1269045577436,
  • "deviceType": "cryptovisor",
  • "createdAt": "2021-02-02T19:13:59Z",
  • "createdBy": "john.dursley@gmail.com"
}

Return a partitions details

Returns the details of the specified partition.

Authorizations:
OAuth2
path Parameters
serialNumber
required
string

The partition unique identifier. Example: 1269045577436

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "partitionCertificate": "string",
  • "partitionCACertificate": "string",
  • "serviceId": "string",
  • "metadata": { },
  • "name": "My Luna Cloud HSM Service Partition",
  • "serialNumber": 1269045577436,
  • "deviceType": "cryptovisor",
  • "createdAt": "2021-02-02T19:13:59Z",
  • "createdBy": "john.dursley@gmail.com"
}

Delete a partition

Delete a specific partition identified by its serial number. This operation is permanent and the partition cannot be recovered.

Authorizations:
OAuth2
path Parameters
serialNumber
required
string

The partition unique identifier. Example: 1269045577436

Responses

Update partition attributes

Update the specified partition attributes, such as the name of a specific partition.

Authorizations:
OAuth2
path Parameters
serialNumber
required
string

The partition unique identifier. Example: 1269045577436

Request Body schema: application/json
name
required
string [ 1 .. 100 ] characters

The partition name.

Responses

Request samples

Content type
application/json
{
  • "name": "My Luna Cloud HSM Service Partition"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "partitionCertificate": "string",
  • "partitionCACertificate": "string",
  • "serviceId": "string",
  • "metadata": { },
  • "name": "My Luna Cloud HSM Service Partition",
  • "serialNumber": 1269045577436,
  • "deviceType": "cryptovisor",
  • "createdAt": "2021-02-02T19:13:59Z",
  • "createdBy": "john.dursley@gmail.com"
}

Return a list of Clients bound to a partition

Returns a list of all Clients bound to a specific service partition.

Authorizations:
OAuth2
path Parameters
serialNumber
required
string

The partition unique identifier. Example: 1269045577436

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Grants

Configure Client access to a partition

Allow or revoke a Client's access to a service partition.

Authorizations:
OAuth2
Request Body schema: application/json
action
required
string
Enum: "allow" "revoke"
serialNumber
required
string [ 1 .. 255 ] characters

The partition unique identifier.

clientId
required
string [ 1 .. 255 ] characters

The Client unique identifier.

Responses

Request samples

Content type
application/json
{
  • "action": "allow",
  • "serialNumber": 1269045577436,
  • "clientId": "caf85feb-21f7-41cc-8277-002b5b0942dc"
}

Clients

Return a list of available Clients

Returns a list of all Clients which have been created for the service and associated partitions.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Client

Create a Client bound to a specified partition.

Authorizations:
OAuth2
Request Body schema: application/json
name
string [ 1 .. 100 ] characters

The Client name.

partitionSerialNumber
required
string [ 1 .. 255 ] characters

The partition unique identifier for the first partition this Client has access to.

Responses

Request samples

Content type
application/json
{
  • "name": "My Client",
  • "partitionSerialNumber": 1269045577436
}

Response samples

Content type
application/json
{
  • "clientId": "37cf2a58-9196-4db7-bf7f-e58e0783ed5b",
  • "clientSecret": "ElIphJlj0RRusYeOg74PZFgrTbDzYKFBnkwQ8Ys8Be7208pnyTbvu0a89X02jmPN",
  • "metadataUrl": "string",
  • "host": "string",
  • "port": 0
}

Return Client details

Return the details of the specified Client.

Authorizations:
OAuth2
path Parameters
clientId
required
string

The Client unique identifier. Example: caf85feb-21f7-41cc-8277-002b5b0942dc

Responses

Response samples

Content type
application/json
{
  • "name": "My Client",
  • "clientId": "caf85feb-21f7-41cc-8277-002b5b0942dc",
  • "metadataUrl": "string",
  • "createdAt": "2021-02-02T19:13:59Z",
  • "createdBy": "john.dursley@gmail.com"
}

Delete a Client

Delete the specified client.

Authorizations:
OAuth2
path Parameters
clientId
required
string

The Client unique identifier. Example: caf85feb-21f7-41cc-8277-002b5b0942dc

Responses

Update Client attributes

Update the specified Client attributes, such as the name of a specific Client.

Authorizations:
OAuth2
path Parameters
clientId
required
string

The Client unique identifier. Example: caf85feb-21f7-41cc-8277-002b5b0942dc

Request Body schema: application/json
name
required
string [ 1 .. 100 ] characters

The Client name.

Responses

Request samples

Content type
application/json
{
  • "name": "My Client"
}

Response samples

Content type
application/json
{
  • "name": "My Client",
  • "clientId": "caf85feb-21f7-41cc-8277-002b5b0942dc",
  • "metadataUrl": "string",
  • "createdAt": "2021-02-02T19:13:59Z",
  • "createdBy": "john.dursley@gmail.com"
}

Return a list of the partitions to which a Client is bound

Returns a list of the partitions to which a specific Client is bound.

Authorizations:
OAuth2
path Parameters
clientId
required
string

The Client unique identifier. Example: caf85feb-21f7-41cc-8277-002b5b0942dc

Responses

Response samples

Content type
application/json
[
  • {
    }
]
Float Icon 5