Table of Contents

Workspace API Authentication

Create a Workspace API key after Diggle enables Workspace API for the selected workspace.

Enable access and create a key

  1. Ask Diggle to enable Workspace API for the workspace. The Workspace API card offers Contact Diggle when it is not enabled.
  2. As a workspace admin, open Manage Workspace → Integrations.
  3. On the Workspace API card, select Create API key and confirm.
  4. Copy the secret in the Copy your API key dialog. Store it securely before closing the dialog.

The secret is displayed once. Its plaintext cannot be retrieved later. Newly generated Workspace API keys begin with diggle_api_; existing older keys may have no prefix.

Authenticate

Authorization: Bearer <workspace-api-key>

Use the exact Bearer spelling shown above. Send the key only in the authorization header over HTTPS. Keep it in server-side secret storage; never expose it in browser or client code, logs, URLs or source control.

Scope and authority

The key is created for the selected workspace and is not a global Diggle account credential. Use a workspace admin-managed key for the documented user-management flows. Do not use a provisioning token or a Microsoft access token as a Workspace API key. Credential management requires a signed-in workspace admin; an API key cannot create or rotate credentials.

Credential lifecycle

ActionResult
Create API keyA new secret is shown once.
Rotate API keyA replacement secret is shown once; the replaced key stops working immediately. Update connected systems.
Revoke API keyThe selected existing key stops working immediately.
Disable Workspace APIDiggle disables the capability and invalidates all Workspace API keys in that workspace. Re-enablement requires a new key.

Rotation and revocation affect the selected key. If older separate keys exist, do not assume rotating one revokes all of them. Removing the key-bearing membership also invalidates its key.

Disabling Workspace API does not delete workspace users or the workspace, change SCIM or SSO, or change Enterprise licensing by itself.

Related articles