Skip to main content

Deputy

Overview​

The Deputy source connector connects to the Deputy API using a permanent token and validates access against the Deputy REST API.

At this time, the connector is not yet available for extraction (syncing data). Authentication and connection validation are implemented, but running a sync will fail with an “in development” error.

Setup​

Prerequisites​

  • A Deputy account with access to the Deputy installation you want to connect to
  • A Permanent Token generated in Deputy
  • Your Deputy installation subdomain and region

Create a Permanent Token in Deputy​

In Deputy, generate a Permanent Token for an account with the permissions you want the connector to use. Keep this token secure; it provides API access.

Authentication​

This connector authenticates using:

  • Bearer token: Deputy Permanent Token

During connection validation, the connector makes a request to:

https://{installation}.{region}.deputy.com/api/v1/resource/EmployeeRole

If the request fails, credential validation fails.

Configuration​

Provide the following configuration fields:

FieldTypeRequiredDescription
installationstring✅Your Deputy installation subdomain (DNS label). Example: acme for https://acme.us.deputy.com. Must be lowercase letters, digits, and hyphens only; cannot start or end with -; max length 63.
regionstring✅Deputy region for your account. Must be one of: au, eu, us.
permanent_tokenstring✅Deputy Permanent Token used as a Bearer token for API requests.

Streams​

No streams are currently available. The connector’s extraction/sync functionality is still in development.

Limitations​

  • Sync/extraction is not yet implemented; attempting to run a sync will fail.
  • Catalog discovery currently returns an empty catalog.