Skip to content
Veraproof Veraproof Docs

ClickSend Integration

ClickSend Integration

Scimify enables SCIM provisioning for ClickSend, allowing you to manage subaccounts and dashboard access permissions through your identity provider.

Overview

This integration (de)provisions subaccounts under a single ClickSend parent account using the Subaccounts API. Scimify accepts standard SCIM requests from your IdP and translates them into create, update, and delete subaccount API calls.

Key behaviors:

  • User-only — no group provisioning
  • Direct provisioning — new users are created as ClickSend subaccounts (not invite-based)
  • Permission management — optional clicksend_permissions SCIM attribute maps to ClickSend access flags
  • Deprovisioning — removing access deletes the subaccount (hard delete)

For background on ClickSend accounts and subaccounts, see Managing your account and Managing subaccounts.

Prerequisites

  • A ClickSend account with permission to manage subaccounts
  • Your ClickSend username and API key (Basic authentication credentials)
  • Your IdP or identity governance platform (IGA) configured for SCIM provisioning (see SCIM Configuration)

Configuration Steps

1. Get your ClickSend API credentials

  1. Sign in to the ClickSend dashboard
  2. Go to Developers → API keys
  3. Copy your account Username and API Key

From the same Developers → API keys menu you can also copy existing API keys and regenerate API keys for subaccounts.

ClickSend authenticates API requests with HTTP Basic Auth: username as the Basic Auth username, and API key as the Basic Auth password. See the ClickSend API documentation.

Use credentials from the parent account that should own the provisioned subaccounts. If a key is compromised, regenerate it from Developers → API keys and update the Scimify integration config.

2. Configure the Integration in Scimify

  1. Navigate to the Integrations page in your Scimify admin console
  2. Create a new ClickSend integration instance
  3. Set an instance display name (for example, Production ClickSend) so you can distinguish multiple connections
  4. Enter your ClickSend Username
  5. Enter your ClickSend API Key (stored encrypted)
  6. Save the configuration and use Test connection to verify API access
  7. Enable the integration and copy the Scimify SCIM endpoint and API key for your IdP

3. Configure SCIM in your IdP or IGA

Follow the SCIM Configuration guide to connect Okta or Lumos to your Scimify ClickSend instance, then assign users as needed.

Map a phone number into SCIM phoneNumbers for each user. ClickSend requires phone_number (E.164 recommended, for example +61411111111) when creating a subaccount; provisioning fails if it is missing.

How It Works

User Provisioning

When a user is assigned in your IdP:

  1. Scimify checks whether a subaccount already exists for the email or userName
  2. If not, Scimify creates a new subaccount with:
    • api_username from SCIM userName
    • email, first name, and last name from the SCIM profile
    • phone from SCIM phoneNumbers
    • access flags from clicksend_permissions (all disabled when omitted)
    • a temporary random password generated by Scimify

New subaccounts are created with a temporary random password that meets ClickSend’s requirements (at least 12 characters, including uppercase and lowercase letters, numbers, and special symbols). If SSO is not used for ClickSend login, users should use ClickSend’s forgot password flow to set their own password after they are provisioned.

User Updates

  • Profile fields (userName / api_username, email, name, phone) and clicksend_permissions are updated via the ClickSend update subaccount API
  • Passwords are not rotated on update
  • Setting active=false deletes the subaccount (same as deprovisioning)

User Deprovisioning

When a user is unassigned or deactivated in your IdP, Scimify deletes the ClickSend subaccount. This is a hard remove (not a soft disable).

Custom SCIM Attribute Configuration

Configure the following custom attribute under the shared extension schema
urn:ietf:params:scim:schemas:extension:custom:2.0:User.

Attribute: clicksend_permissions

SettingValue
TypeString (multi-valued)
External namespaceurn:ietf:params:scim:schemas:extension:custom:2.0:User
Attribute nameclicksend_permissions
DescriptionList of ClickSend dashboard access permissions to enable for the subaccount
DefaultEmpty (all access flags set to disabled / 0)

Allowed values:

ValueClickSend flag
access_usersUsers
access_billingBilling
access_reportingReporting
access_contactsContacts
access_settingsSettings

If a value is present in the array, Scimify sets that flag to 1. If it is absent, Scimify sets that flag to 0. Unknown values are ignored.

Example (Okta-style multi-valued string):

access_users
access_reporting
access_contacts

That mapping enables Users, Reporting, and Contacts, and disables Billing and Settings.

Troubleshooting

  • Authentication failed — confirm the Username and API key from Developers → API keys in the ClickSend dashboard, and that the key has not been regenerated
  • Phone number is required — ensure the IdP sends SCIM phoneNumbers with a valid value on create
  • Permission changes not applied — confirm clicksend_permissions is mapped into the custom extension schema and uses the exact allowed values above