Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActivTrak Administration - SCIM API

SCIM 2.0 user and group management. Beta.

ActivTrak Administration - SCIM API is one of 4 APIs that ActivTrak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Administration - SCIM. The published artifact set on APIs.io includes an OpenAPI specification, a changelog, API documentation, and an API reference.

This API exposes 13 operations across 7 paths. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against 5 base URLs: https://api.activtrak.com, https://api-eu.activtrak.com, https://api-uk.activtrak.com, https://api-ca.activtrak.com, https://api-au.activtrak.com.

13 operations 7 paths 0 schemas 2 DELETE7 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.activtrak.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

ActivTrak Administration - SCIM API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Public API key sent in the x-api-key header. Some endpoints also accept Authorization: Bearer {apiKey}. Keys are created in the ActivTrak app under API & Integ…

Paths & Operations 13

Across 7 paths, the API surfaces 13 operations — 2 DELETE, 7 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Administration - SCIM 13

SCIM 2.0 user and group management. Beta.

POST
/scim/v1/groups
Creates a new ActivTrak Group.
createGroup 1 param body → 201400409
GET
/scim/v1/groups
Returns a list of ActivTrak Groups.
getGroups 3 params → 200400500
DELETE
/scim/v1/groups/{groupId}
Deletes an ActivTrak Group.
deleteGroup 1 param → 204400404
GET
/scim/v1/groups/{groupId}
Returns a single ActivTrak Group by ID.
getGroup 2 params → 200400404
PUT
/scim/v1/groups/{groupId}
Updates an existing ActivTrak Group by replacing it with the provided entity.
updateGroup 2 params body → 200400500
GET
/scim/v1/ping
Returns the API's uptime status.
ping → 200
GET
/scim/v1/schemas/{schemaUri}
Returns a specified SCIM schema by URI.
getSchema 2 params → 200400404
GET
/scim/v1/schemas
Returns a list of supported SCIM schemas.
getSchemas 1 param → 200
POST
/scim/v1/users
Creates a new ActivTrak User. If the User already exists in ActivTrak, the new information associated with the User is
createUser 1 param body → 201400409
GET
/scim/v1/users
Returns a list of ActivTrak Users.
getUsers 3 params → 200400500
DELETE
/scim/v1/users/{userId}
Adds an ActivTrak User to the Do Not Track list and deletes their associated user agents.
deleteUser 1 param → 204400404
GET
/scim/v1/users/{userId}
Returns a single ActivTrak User by ID.
getUser 2 params → 200400404
PUT
/scim/v1/users/{userId}
Updates an existing ActivTrak User by replacing it with the provided entity.
updateUser 2 params body → 200400500

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activtrak-administration-scim-api-openapi.yml Raw ↑

Other APIs ActivTrak publishes across the network.

ActivTrak Administration API
ActivTrak Bulk Import API
ActivTrak Reports API