Theme switcher

Users

ActivTrak's SCIM API supports the retrieval, creation, update, and deletion of User entities.

Supported Fields

ActivTrak's SCIM API supports the following User fields:

User fields

idstring

Unique identifier for the User, as defined by the service provider.

userNamestring

The primary identifier value assigned to the User in ActivTrak. This value is read-only and is automatically set to the User Principal Name (UPN), or the primary email if UPN is not present.

nameobject

The components of the user's real name. Sub-properties include familyName, givenName, and middleName.

displayNamestring

A human-readable name for the User.

emailsarray Required

E-mail addresses for the user.

activeboolean

A Boolean value indicating the User's administrative status.

For ActivTrak's API, updating this value to false adds the User to the Do Not Track list and deletes their associated user agents.

Updating the value from false to true (re-provisioning) removes the User from the Do Not Track list, and attempts to restore any historical user agent data if it has not yet been deleted.

groupsarray

A list of groups to which the user belongs.

metaobject

API metadata information regarding the User resource.

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.employeeNumberstring

Numeric or alphanumeric identifier assigned to a User.

urn:ietf:params:scim:schemas:extension:activtrak:2.0:User.trackingstring

A Boolean value indicating the User's tracked status.

For ActivTrak's API, updating this value to false adds the User to the Do Not Track list.

Updating the value from false to true removes the User from the Do Not Track list.

urn:ietf:params:scim:schemas:extension:activtrak:2.0:User.userPrincipalNamesarray

User Principal Names (UPN) for the user.

Was this section helpful?

What made this section unhelpful for you?

Endpoints

GET
GET
GET
POST
PUT
PATCH
PATCH
PATCH
PATCH
PATCH
PATCH
PATCH
PATCH
PATCH
PATCH
DELETE
1 2 3 4 5 6 7 8 9 10 11 12 13 { "id": "", "userName": "", "name": {}, "displayName": "", "emails": [], "active": true, "groups": [], "meta": {}, "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User.employeeNumber": "", "urn:ietf:params:scim:schemas:extension:activtrak:2.0:User.tracking": "", "urn:ietf:params:scim:schemas:extension:activtrak:2.0:User.userPrincipalNames": [] }
Was this section helpful?

What made this section unhelpful for you?