Custom Integrations

Overview

Custom integrations enable companies to automatically manage their employee information on Work Accounts, by integrating with their existing identity management tools via SCIM API.

Custom integrations are scoped to the Work Accounts instance where they were created.

You must be a Work Accounts admin to create and manage custom integrations for your company.

Create a Custom Integration

In order to develop an integration with SCIM API, you'll first need to create a custom integration within Work Accounts. This allows you to control the permissions and access token for API usage.

The following process outlines the steps you'll need to follow before developing your app:

  1. Log into Work Accounts as an admin. Navigate to the Integrations tab and click Create.
  2. Give your integration a name and a description.
  3. List all IP addresses of the services which will be allowed to make API calls for this integration. See Permissions: Security for more information on IP allow-lists.
  4. Click Create to create your new integration.
  5. On the Permissions tab, enable the permissions required for your app. See Permissions for more information on permissions.

You can now begin generating access tokens for your app and using Work Accounts APIs.

Edit Existing Integrations

You may revisit and make edits to existing integrations at any time. Each integration profile can be accessed from the Integrations menu. You may edit static details, reset access tokens, change permissions or adjust the security settings as required.

Useful Links

The resources below provide useful information for using the APIs and the policies you'll need to adhere to when building your app.

Permissions & Access Tokens

Details on how API Access for Work Accounts is controlled by permissions and access tokens.

SCIM API

Documentation for the SCIM API schemas supported in Work Accounts, as well as example requests and guides.

Guides

Guides for common Work Accounts tasks using SCIM API, describing a sequence of steps that may include multiple API calls or administrative tasks.

Security Recommendations

These recommendations provide suggestions to protect access to your customer data while using integrations.

FAQ

  • A service that logs an organization's internal IDs to their Work Accounts instance.
  • A service that modifies user accounts based on activity within another service.
  • A service that creates or deactivates user accounts based on activity within another service.