S-Sign Licensing (Apex)

Use Apex to read and manage S-Sign seat assignments when licensing is managed inside S-Sign.

S-Sign Licensing (Apex)

Use these Apex methods to read and manage S-Sign seat assignments when S-Sign manages licensing.

Use this class only for in-product S-Sign licensing.

If the org uses Salesforce package licensing, use Identifying S-Sign Licensing.

Controller: SSign.SSLicensesController

Use SSLicensesController — plural.

This class manages seats only when licensing is handled inside S-Sign.

getSSignLicensedUsers()

Method Signature

global static List<Id> getSSignLicensedUsers()

Details

• Input: None.
• Output: Returns a List<Id> of Salesforce User IDs with active S-Sign seats.

Use Cases

Use this method when you need to:

• Audit current seat assignments.
• Check whether a user holds a seat.
• Capture a baseline before updates.

Example

// Read the current seat assignments
List<Id> licensedUserIds = SSign.SSLicensesController.getSSignLicensedUsers();

// Review the result
System.debug('Licensed user IDs: ' + licensedUserIds);
System.debug('Total licensed users: ' + licensedUserIds.size());

removeSSignUserLicenses()

Method Signature

global static void removeSSignUserLicenses(List<Id> removeUserIds)

Details

• Input:

  • removeUserIds (List<Id>): Salesforce User IDs to remove from S-Sign licensing.
• Output: Returns void.

Use Cases

Use this method when you need to:

• Reclaim unused seats.
• Remove access during offboarding.
• Sync seat removals from automation.

Example

// Define the users to remove
List<Id> removeUserIds = new List<Id>{
    '005XXXXXXXXXXXX',
    '005YYYYYYYYYYYY'
};

// Remove the seats
SSign.SSLicensesController.removeSSignUserLicenses(removeUserIds);

Calling this method with an empty list succeeds and makes no seat changes.

addSSignUserLicenses()

Method Signature

global static void addSSignUserLicenses(List<Id> addUserIds)

Details

• Input:

  • addUserIds (List<Id>): Salesforce User IDs to grant an S-Sign seat.
• Output: Returns void.

Use Cases

Use this method when you need to:

• Assign seats to new users.
• Restore access for returning users.
• Apply seat changes from admin workflows.

Example

// Define the users to license
List<Id> addUserIds = new List<Id>{
    '005XXXXXXXXXXXX',
    '005YYYYYYYYYYYY'
};

// Assign the seats
SSign.SSLicensesController.addSSignUserLicenses(addUserIds);

Calling this method with an empty list succeeds and makes no seat changes.

Recommended workflow

Use this sequence for predictable seat updates:

1. Call getSSignLicensedUsers().
2. Compare the current set with the target set.
3. Build separate toAdd and toRemove lists.
4. Apply only the delta.
5. Re-run getSSignLicensedUsers() to verify the result.

Build the add and remove lists first.

This keeps updates easy to validate.

Best practices

• Capture the current seat state before updates.
• Calculate deltas instead of sending raw lists.
• Validate Salesforce User ID format first.
• Remove duplicates before each method call.
• Use try/catch inside larger automation.
• Verify the final state after changes.