Returns the specified encryption key.
A VPN encryption key defines shared secret between a tenant and the Intelligent Risk Platform. The VPN encryption key enables on-premise SQL Server instances on the tenant's network to connect to the tenant's Data Bridge cluster via a VPN connection.
At any point in time an encryption key is defined by one of three statuses: AVAILABLE, IN-USE, or REVOKED.
| Status | Description |
|---|---|
AVAILABLE | The key is unassigned or assigned to a VPN connection with an off VPN status. |
IN-USE | The key is assigned to a VPN connection with an on VPN status. |
REVOKED | The encrypton key has been revoked. Once revoked, the encryption key cannot be assigned to a VPN connection. |
To perform this operation, the client must belong to a group that has been assigned the Admin or Data Bridge Admin role.
Entitlements
IC-VPN
/platform/tenantdata/v1/encryption-keys/id, AVAILABLE, IN-USE, PRE-SHARED-KEY, REVOKED, VPN, activatedAt, createdAt, createdBy, encryptionKeyName, encryptionKeySubType, encryptionKeyType, encryptionKeyValue, expiredAt, id, status, tenantId