Skip to main content

Create or synchronize secret entities

POST 
/apis/v1/storage/secretEntities

Use this method to create a secret entity or synchronize secret entities between the portal and connected hubs.

A secret entity is a secure object that is used to store the encryption details used by the hubs to decrypt sensitive data (such as passwords).

After creating the secret entity, you need to call the PATCH /apis/v1/storage/secretEntities/:id PATCH /apis/v1/storage/secretEntities/:id to add the encrypted encryption details that is generated by encrypting the sensitive data using the AES_128_GCM algorithm with a 16-byte random key and a 12-byte random nonce (also known as iv) and then encrypting the encryption details (key, nonce and authTag). For more information, see Using sensitive data in custom scripts in the XClarity One online documentation.

Request​

Responses​

Success - Secret entities were synchronized