1. Partner API v2
  2. Resources
  3. Collections

Collections

Admin-managed groups of users used as audiences for training, frameworks, and policies.
3 endpointsScope readCollectionUser
GET/v2/clients/{client_id}/collections

List collectionsLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of Collection

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

Query parametersall optional unless marked

limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/collections" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of Collection
dataarray of Collection
Show item properties(8)
idstring
client_idstring
namestring
descriptionstringNullable
member_countinteger
created_bystring
One ofdashboardapi
created_atstring (date-time)
updated_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
GET/v2/clients/{client_id}/collections/{collection_id}

Get a collectionLink to this endpoint

RequiresreadscopeReturns Collection

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

collection_idstringRequired

Collection id (the collection's INFIMA id).

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/collections/6f1c2a7e-3b9d-4c1a-9e8f-0a1b2c3d4e5f" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectCollection
idstring
client_idstring
namestring
descriptionstringNullable
member_countinteger
created_bystring
One ofdashboardapi
created_atstring (date-time)
updated_atstring (date-time)
Errors404Not found within the key's accessError envelope →
GET/v2/clients/{client_id}/collections/{collection_id}/members

List collection membersLink to this endpoint

RequiresreadscopeCursor-paginatedReturns Page of User

Path parameters

client_idstringRequired

Client id (the client's INFIMA id).

collection_idstringRequired

Collection id (the collection's INFIMA id).

Query parametersall optional unless marked

limitinteger

Default 100min 1 · max 500

cursorstring

Opaque cursor from the previous page's page.next_cursor.

curl "https://app.infimasecapis.com/v2/clients/3f2a9c1e-7b44-5d2e-9a1f-0c6d8e4b2a10/collections/6f1c2a7e-3b9d-4c1a-9e8f-0a1b2c3d4e5f/members" \
  -H "X-API-Key: $INFIMA_API_KEY"
Response objectPage of User
dataarray of User
Show item properties(17)
idstring
client_idstring
emailstring (email)
first_namestring
last_namestring
departmentstringNullable
job_titlestringNullable
manager_emailstring (email)Nullable
statusstring
One ofactiveinactive
rolestring

The role used to weight a user's risk signals.

One ofadminexecutivehrfinancestandard
preferred_languagestring
One ofenesfr-ca
sourcestring

Where the user record came from.

One ofmicrosoftgooglemanualapi
groupobjectNullable

The directory group or manual group the user belongs to.

Show properties(2)
idstring
namestring
riskobject
Show properties(2)
scoreinteger
gradestring

Letter grade derived from the score. A is 800 and above, B 700, C 600, D 400, F below 400.

One ofABCDF
trainingobject
Show properties(3)
on_trackboolean
overdue_countinteger
next_courseobjectNullable
Show properties(3)
course_idstring
titlestring
due_onstring (date)
created_atstring (date-time)
updated_atstring (date-time)
pageobject
Show properties(2)
next_cursorstringNullable

Pass as cursor to fetch the next page. Null on the last page.

has_moreboolean
Coming in 2.x4 more Collections operations are specified for a later 2.x release.See the roadmap