GroupKeyEncryptionProfile

Represents a Group Key Profile

Overview

associatedEnterpriseID string
creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
DRSeedLifetime integer read only  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string filterable   orderable  
owner string autogenerated  
seedGenerationInterval integer
seedLifetime integer
seedPayloadAuthenticationAlgorithm enum (HMAC_SHA1 | HMAC_SHA256 | HMAC_SHA512)
seedPayloadAuthenticationBCAlgorithm string read only  
seedPayloadAuthenticationKeyLength integer read only  
seedPayloadEncryptionAlgorithm enum (AES_128_CBC | AES_256_CBC | TRIPLE_DES_CBC)
seedPayloadEncryptionBCAlgorithm string read only  
seedPayloadEncryptionKeyLength integer read only  
seedPayloadSigningAlgorithm enum (SHA1withRSA | SHA224withRSA | SHA256withRSA | SHA384withRSA | SHA512withRSA)
SEKGenerationInterval integer
SEKLifetime integer
SEKPayloadEncryptionAlgorithm enum (RSA_1024)
SEKPayloadEncryptionBCAlgorithm string read only  
SEKPayloadEncryptionKeyLength integer read only  
SEKPayloadSigningAlgorithm enum (SHA1withRSA | SHA224withRSA | SHA256withRSA | SHA384withRSA | SHA512withRSA)
trafficAuthenticationAlgorithm enum (HMAC_MD5 | HMAC_SHA1 | HMAC_SHA256 | HMAC_SHA384 | HMAC_SHA512)
trafficEncryptionAlgorithm enum (AES_128_CBC | AES_192_CBC | AES_256_CBC | TRIPLE_DES_CBC)
trafficEncryptionKeyLifetime integer

API Resource

/groupkeyencryptionprofiles/id
get put

Parents

/enterprises/id/groupkeyencryptionprofiles
get

Children

/groupkeyencryptionprofiles/id/permissions
delete get post put
/groupkeyencryptionprofiles/id/metadatas
get post
/groupkeyencryptionprofiles/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedEnterpriseID string
Discussion

The ID of the associated Enterprise

Charateristics

Format: free
SDK attribute: associatedEnterpriseID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

A description of the Profile instance created.

Charateristics

Format: free
Max length: 255
SDK attribute: description

DRSeedLifetime integer read only  
Discussion

DR Seed Lifetime in seconds

Charateristics

SDK attribute: DRSeedLifetime

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string filterable   orderable  
Discussion

Name of the Encryption Profile

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

seedGenerationInterval integer
Discussion

Group Key SEED Generation Interval in Seconds.

Charateristics

Default value: 1200
Min value: 15
Max value: 86400
SDK attribute: seedGenerationInterval

seedLifetime integer
Discussion

Group Key SEED Lifetime in Seconds. Min=1, Max=604800

Charateristics

Min value: 30
Max value: 604800
SDK attribute: seedLifetime

seedPayloadAuthenticationAlgorithm enum
Discussion

Group Key SEK Payload Signature Algorithm.

Charateristics

Allowed values: HMAC_SHA1, HMAC_SHA256, HMAC_SHA512
SDK attribute: seedPayloadAuthenticationAlgorithm

seedPayloadAuthenticationBCAlgorithm string read only  
Discussion

Group Key Seed Payload Authentication Algorithm (read only)

Charateristics

Format: free
SDK attribute: seedPayloadAuthenticationBCAlgorithm

seedPayloadAuthenticationKeyLength integer read only  
Discussion

Group Key Seed Payload Authentication Key Length (read only)

Charateristics

SDK attribute: seedPayloadAuthenticationKeyLength

seedPayloadEncryptionAlgorithm enum
Discussion

Group Key SEED Payload Encryption Algorithm.

Charateristics

Allowed values: AES_128_CBC, AES_256_CBC, TRIPLE_DES_CBC
SDK attribute: seedPayloadEncryptionAlgorithm

seedPayloadEncryptionBCAlgorithm string read only  
Discussion

Group Key Seed Payload Encryption Algorithm (read only)

Charateristics

Format: free
SDK attribute: seedPayloadEncryptionBCAlgorithm

seedPayloadEncryptionKeyLength integer read only  
Discussion

Group Key Seed Payload Encryption Key Length (read only)

Charateristics

SDK attribute: seedPayloadEncryptionKeyLength

seedPayloadSigningAlgorithm enum
Discussion

Group Key Seed Payload Signature Algorithm.

Charateristics

Allowed values: SHA1withRSA, SHA224withRSA, SHA256withRSA, SHA384withRSA, SHA512withRSA
SDK attribute: seedPayloadSigningAlgorithm

SEKGenerationInterval integer
Discussion

Group Key SEK Generation Interval in Seconds. Min=1, Max=86400

Charateristics

Min value: 15
Max value: 86400
SDK attribute: SEKGenerationInterval

SEKLifetime integer
Discussion

Group Key SEK Lifetime in Seconds. Min=1, Max=604800

Charateristics

Min value: 60
Max value: 604800
SDK attribute: SEKLifetime

SEKPayloadEncryptionAlgorithm enum
Discussion

Group Key SEK Payload Encryption Algorithm.

Charateristics

Allowed values: RSA_1024
SDK attribute: SEKPayloadEncryptionAlgorithm

SEKPayloadEncryptionBCAlgorithm string read only  
Discussion

Group Key Sek Payload Encryption BC Algorithm (read only)

Charateristics

Format: free
SDK attribute: SEKPayloadEncryptionBCAlgorithm

SEKPayloadEncryptionKeyLength integer read only  
Discussion

Group Key Sek Payload Encryption Key Length (read only)

Charateristics

SDK attribute: SEKPayloadEncryptionKeyLength

SEKPayloadSigningAlgorithm enum
Discussion

Group Key SEK Payload Signature Algorithm.

Charateristics

Allowed values: SHA1withRSA, SHA224withRSA, SHA256withRSA, SHA384withRSA, SHA512withRSA
SDK attribute: SEKPayloadSigningAlgorithm

trafficAuthenticationAlgorithm enum
Discussion

Group Key traffic Authentication Algorithm. Possible values are HMAC_SHA1, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_MD5, .

Charateristics

Allowed values: HMAC_MD5, HMAC_SHA1, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512
SDK attribute: trafficAuthenticationAlgorithm

trafficEncryptionAlgorithm enum
Discussion

Group Key traffic Encryption Algorithm. Possible values are AES_128_CBC, AES_192_CBC, AES_256_CBC, TRIPLE_DES_CBC, .

Charateristics

Allowed values: AES_128_CBC, AES_192_CBC, AES_256_CBC, TRIPLE_DES_CBC
SDK attribute: trafficEncryptionAlgorithm

trafficEncryptionKeyLifetime integer
Discussion

Group Key Traffic Encryption Key Lifetime in Seconds. Min=1, Max=86400

Charateristics

Min value: 5
Max value: 86400
SDK attribute: trafficEncryptionKeyLifetime