Reference: API Endpoints

This reference lists the system operations available for identity management. All operations require an active AccessHive session.

Session authentication

All operations use your current AccessHive login session. Separate API key authentication is not supported for these operations.

Dedicated identities

Operation Method Description
List identities GET Retrieves identities filtered by client and, optionally, by platform.
Create identity POST Creates a new agency-owned dedicated identity. See Identity Field Requirements for required fields per type.
Get identity GET Returns the full identity record including provider statuses.
Delete identity DELETE Removes a dedicated identity.
Filtering the identity list

When listing identities, you can filter by client (required) and by platform (optional) to narrow results.

Credential reveal

Operation Method Description
Reveal credentials POST Decrypts and returns the stored credentials for an identity.
Time-limited reveal

Revealed credentials expire after 30 seconds. The system displays a countdown, and you must reveal again after expiry.

For more on how credentials are stored and accessed, see Credential Vault.

Google Workspace operations

Google Workspace (GWS) operations manage the connection between AccessHive and your GWS directory.

Operation Method Description
Sync directory POST Reconciles the GWS directory with AccessHive identities and reports any mismatches.
Identity source status GET Returns all identity sources with their connection state and configuration.
Retry provisioning POST Re-runs provisioning for an identity that is stuck or failed.

For setup and troubleshooting of your GWS connection, see Google Workspace Guide. For an explanation of provisioning states, see Provisioning States.

Job history

Operation Method Description
List jobs GET Returns recent background job records, filtered by job type. Default limit is 10 results.

Job records include status, timing, input data, results, and error details for failed jobs. For a full breakdown of job types, see Background Jobs.