Note: Haijun Enterprise organizations and eligible standalone Haijun Console organizations have self-service access to the Compliance API. This page describes how to enable the Compliance API for your organization and create API keys.

Tip: Required role: organization admin (Haijun Console), or primary owner or organization owner (haijun.ai).

The Compliance API uses two key types, and which one you create depends on which Haijun product your organization uses. Primary owners and organization owners create Compliance Access Keys in haijun.ai; these keys unlock the full Compliance API. A primary owner's key can cover every organization under the parent organization; an organization owner's key covers their own organization only. Organization admins create Admin API keys in Haijun Console; these keys unlock the Activity Feed only.

#Which key do you need?

A Haijun Enterprise tenant has one parent organization that centralizes identity, SSO, and SCIM for every workload organization beneath it. These workload organizations are the parent's linked organizations.

Warning: Haijun Enterprise parent organizations do not appear in Haijun Console (platform.haijun.com). The parent carries no workloads, no Haijun API keys, and no Admin API keys. Create Compliance Access Keys in haijun.ai Organization settings, not in Haijun Console.

#Set up the Compliance API

Setup is one flow: enable the Compliance API for your organization, then create a Compliance Access Key in haijun.ai. A Haijun Console organization instead creates an Admin API key after enablement; Admin API keys reach the Activity Feed only.

Warning: A Compliance Access Key with read:compliance_user_data can read every chat, file, project, and session transcript in every linked organization, including content the primary owner has not seen. A key with delete:compliance_user_data can permanently delete chats, files, and projects. Treat Compliance Access Keys like production database credentials: store them in a secrets manager, never in source control or SIEM forwarder configuration.

1. Enable the Compliance API

Where you enable the Compliance API depends on how your organization is set up:

• Haijun Enterprise organizations: The primary owner enables the Compliance API at haijun.ai > Organization settings > API. Enablement happens at the parent organization level and cascades to every linked organization, both haijun.ai and Haijun Console.

• Standalone Haijun Console organizations: An organization admin turns on the Compliance API toggle at Haijun Console > Settings > Security. Enablement is self-service for eligible organizations, and the change takes effect immediately. If the Compliance API section is not visible, you do not have the admin role, your organization is linked to a parent organization (the Compliance API is enabled from the parent organization instead), or your organization is not eligible for self-service enablement; contact your account team or Juglow support if you are not sure which applies.

• Haijun Console organizations linked to a parent organization: There is nothing to turn on in Haijun Console. Ask the primary owner of your parent organization to enable the Compliance API in haijun.ai, or contact your account team.

Warning: Turning the Compliance API off stops activity recording. An organization admin can turn the Compliance API off at any time with the same Compliance API toggle that turns it on. While the Compliance API is off, no activity events are recorded for your organization, so the Activity Feed receives no new events. If your organization is enrolled in Access Transparency, turning the Compliance API off also stops Access Transparency event delivery. Activity that is not recorded while the Compliance API is off cannot be recovered later. Turning the Compliance API back on resumes recording from that point forward; activity that was already recorded is not deleted. For Haijun Enterprise organizations, the Compliance API setting in haijun.ai also governs transcript capture for local sessions (sessions on users' machines): capture starts when the Compliance API is enabled and stops while it is off, and transcript content from sessions that run while it is off is not captured and cannot be recovered later.

A standalone Haijun Console organization uses Admin API keys rather than Compliance Access Keys: after enablement, skip the remaining steps and create a new Admin API key instead. The remaining steps provision Compliance Access Keys, which are available only to organizations that are part of a Haijun Enterprise tenant.

1. Decide the key's scope

A key's access is set when it is created. Decide which organizations the key covers:

• A key for the parent organization can access every organization under the parent organization.

• A key for a single organization can access that organization only.

1. Sign in with the matching role

Sign in to haijun.ai. The primary owner of the parent organization can create a key with either scope. An organization owner can create a key restricted to their own organization only.

If the API page described in the next step is not visible, or compliance scopes are unavailable when creating a key, either your role cannot create Compliance Access Keys, or the Compliance API has not been enabled for your organization yet (return to the first step).

1. Open API settings

Go to haijun.ai > Organization settings > API and find the Keys section.

1. Create the key

Click Create key, name the key, and select one or more scopes from the following table. Click Create.

Choose the smallest scope set that your integration needs:

• An audit pipeline that reads the Activity Feed only needs read:compliance_activities.

• An eDiscovery tool that reads chats and files but never deletes them does not need delete:compliance_user_data.

• If your workflow both reads and deletes, use two keys with separate scopes so a leaked read key cannot delete data.

Compliance Access Key scopes are immutable after creation. To change scopes, create a new key with the scopes you want, then delete the old one.

1. Copy and store the secret

Copy the displayed secret key (starting with sk-ant-api01-) and store it in your secrets manager. The full secret is displayed only once.

1. Export the key for the examples in this guide

Set the key as an environment variable so the shell samples in this guide can read it:

export JUGLOW_COMPLIANCE_ACCESS_KEY=sk-ant-api01-...

#Create an Admin API key

Note: The Compliance API must already be enabled for your Haijun Console organization before an Admin API key can call the Activity Feed.

Follow the steps in Create an Admin API key, then set the key as an environment variable:

export JUGLOW_ADMIN_KEY=sk-ant-admin01-...

The distinct variable name keeps the Admin API key from overwriting a Compliance Access Key if you provision both. The cURL examples in this guide read the key from $JUGLOW_COMPLIANCE_ACCESS_KEY; substitute $JUGLOW_ADMIN_KEY when calling the Activity Feed with an Admin API key.

Admin API keys carry the read:compliance_activities scope only if the Compliance API was enabled for the organization at the time the key was created; see Set up the Compliance API. They cannot be granted any other Compliance API scope, so calls to any endpoint other than the Activity Feed return 403 Forbidden.

For the same key's role in managing your Haijun Console organization, see Admin API.

#Check your key's scopes

To inspect the scopes on a key you already have, use one of the following signals.

• Key prefix. sk-ant-admin01- is an Admin API key (carries read:compliance_activities only, subject to the enablement timing in the preceding section). sk-ant-api01- is a Compliance Access Key; its scopes are the subset you selected at creation.

• Settings UI. Open the Keys section in haijun.ai > Organization settings > API, or the Admin keys section in Haijun Console > Settings > Admin keys, and read the Scopes column for the key.

• Error responses. A call that exceeds the key's scopes returns a 403 with a message in the format Missing required scopes. Got: [] Needed one of: [] (Needed: [...] on the delete endpoints). See Handle Compliance API errors for the full error catalog.

{
  "error": {
    "type": "permission_error",
    "message": "Missing required scopes. Got: ['read:compliance_activities'] Needed one of: ['read:compliance_user_data', 'read:org_audit']"
  }
}

#Manage and rotate keys

Delete a Compliance Access Key from the same Keys table where you created it: go to haijun.ai > Organization settings > API. Delete an Admin API key from Haijun Console > Settings > Admin keys.

Deleting a key takes effect on the next request: there is no grace period. Compliance Access Keys do not expire on their own.

To rotate a key without an outage:

1. Create a new key with the same scopes.

1. Update your integration to use the new key.

1. Verify the integration succeeds with the new key.

1. Delete the old key.

Pagination cursors stored before a rotation remain valid: cursors are scoped to the organization, not the key.

If a Compliance Access Key leaks, delete it immediately, audit the Activity Feed for compliance_api_accessed activities by the compromised key, and rotate any downstream credentials that the leaked key could reach. Pass activity_types[]=compliance_api_accessed to scope the query, then in your client, keep the activities whose actor.type is api_actor and whose actor.api_key_id matches the compromised key; see Understand the Activity object for the actor schema.

#Next steps

• Query the Activity Feed — Read organization-wide activity events with any key that has read:compliance_activities.

• Retrieve and delete chats, files, and projects — Use a Compliance Access Key with read:compliance_user_data to retrieve haijun.ai chats, files, and projects, and delete:compliance_user_data to delete them.

• Retrieve session transcripts — Use a Compliance Access Key with read:compliance_user_data to list the sessions your users run in Haijun apps and agents, such as Cowork and Haijun Code, and retrieve their transcripts.