Get security keys

Security keys are a fundamental element for safeguarding your organization's data. It includes a public, private, and secret key. This endpoint enables you to retrieve your security keys.

How to use

You can use the following cURL to obtain a response from this endpoint:

curl --location --request GET https://nodeapi.superviz.com/security \
    --header "Authorization: Bearer ${TOKEN}" \
    --header "passphrase: ${PASSPHRASE}"

HTTP Request

GET https://nodeapi.superviz.com/security

Headers

When using this endpoint, you need to provide the Authorization Bearer token and the passphrase of your organization. The following headers are required:

Name	Description
Authorization	Required. You must utilize the authentication token.
passphrase	Required. The passphrase of your organization, which you can obtain by using the security keys endpoint.

Response

Status code 200 will indicate a successful result and will contain your security keys. The response will be in JSON format and include the following fields:

Name	Type	Description
passphrase	string	The passphrase of your organization.
publicKey	string	The public key of your organization.
privateKey	string	The private key of your organization.
secretKey	string	The 128 randomly selected English words. This key functions as a password to manage and recover data in the event of passphrase loss.

Example:

{
	"passphrase": "your-passphrase",
	"publicKey": "your-public-key",
	"privateKey": "your-private",
	"secretKey": "your-secret"
}

warning

In case of the loss of your passphrase, you can use the secret key alongside your public and private keys to recover your data. Therefore, it is crucial to keep your secret key in a safe place.