DSS Key Policies

DSS Key Policies are formerly known as DSS Key Rules but the API remains DSSKeyRules to be compatible with earlier versions.

Quick Navigation

• GET DSSKeyRules
• GET DSSKeyRules/{id}

GET DSSKeyRules

Purpose

Returns a list of DSS Key Rules.

Required Permissions

Password Safe System Management (Read).

Request Body

None.

Response Body

Content-Type: application/json

[
    {
        DSSKeyRuleID: int, 
        Name: string, 
        Description: string, 
        KeyType: string, 
        KeySize: int, 
        EncryptionType: char,
        PasswordRuleID: int, // can be null
    },
    …
]

Response Body Details

• KeyType: (RSA, DSA) The type of key to generate.
• EncryptionType: The type of key encryption to use:
  • A: Auto-managed passphrase, generated using the associated password rule (see PasswordRuleID).
  • N: No encryption.
• PasswordRuleID: (given when EncryptionType is A) ID of the password rule used to auto-generate the passphrase for DSS key encryption.

Response Codes

200 - Request successful. DSS Key Rules in the response body.

For more information, please see Common Response Codes.

GET DSSKeyRules/{id}

Purpose

Returns a DSS Key Rule by ID.

Required Permissions

Password Safe System Management (Read).

URL Parameters

id: ID of the DSS Key Rule.

Request Body

None.

Response Body

Content-Type: application/json

{
    DSSKeyRuleID: int, 
    Name: string, 
    Description: string, 
    KeyType: string, 
    KeySize: int, 
    EncryptionType: char,
    PasswordRuleID: int, // can be null
}

Response Body Details

• KeyType: The type of key to generate (RSA, DSA).
• EncryptionType: The type of key encryption to use:
  • A: Auto-managed passphrase, generated using the associated password rule (see PasswordRuleID).
  • N: No encryption.
• PasswordRuleID: (given when EncryptionType is A) ID of the password rule used to auto-generate the passphrase for DSS key encryption.

Response Codes

200 - Request successful. DSS Key Rule in the response body.

For more information, please see Common Response Codes.