Security API: Users

Retrieves one specific user connection

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

fromUserstring · uuidRequired

toUserstring · uuidRequired

fromstringRequired

tostringRequired

Responses

200

OK

application/jsontext/json

fromUserIdstring · uuidOptional

toUserIdstring · uuidOptional

isLeaderbooleanOptional

isManagerbooleanOptional

isSupervisorbooleanOptional

isValidatorbooleanOptional

connectedstring · date-timeOptional

get

/api/security/users-connections/{from}/{to}

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/users-connections/{from}/{to} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "fromUserId": "123e4567-e89b-12d3-a456-426614174000",
  "toUserId": "123e4567-e89b-12d3-a456-426614174000",
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-03-13T10:20:38.160Z"
}

Checks for the existence of one specific user connection

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

fromUserstring · uuidRequired

toUserstring · uuidRequired

fromstringRequired

tostringRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/security/users-connections/{from}/{to}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/users-connections/{from}/{to} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of user connections that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

isLeaderboolean · nullableOptional

isManagerboolean · nullableOptional

isSupervisorboolean · nullableOptional

isValidatorboolean · nullableOptional

connectedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

fromUserIdstring · uuidOptional

toUserIdstring · uuidOptional

isLeaderbooleanOptional

isManagerbooleanOptional

isSupervisorbooleanOptional

isValidatorbooleanOptional

connectedstring · date-timeOptional

post

/api/security/users-connections/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-connections/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 607

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "fromUserId": "123e4567-e89b-12d3-a456-426614174000",
    "toUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isLeader": true,
    "isManager": true,
    "isSupervisor": true,
    "isValidator": true,
    "connected": "2026-03-13T10:20:38.160Z"
  }
]

Counts the user connections that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

isLeaderboolean · nullableOptional

isManagerboolean · nullableOptional

isSupervisorboolean · nullableOptional

isValidatorboolean · nullableOptional

connectedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/security/users-connections/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-connections/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 607

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of user connections that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

isLeaderboolean · nullableOptional

isManagerboolean · nullableOptional

isSupervisorboolean · nullableOptional

isValidatorboolean · nullableOptional

connectedstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/security/users-connections/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-connections/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 607

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of user connections that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

isLeaderboolean · nullableOptional

isManagerboolean · nullableOptional

isSupervisorboolean · nullableOptional

isValidatorboolean · nullableOptional

connectedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

fromUserIdstring · uuidOptional

toUserIdstring · uuidOptional

post

/api/security/users-connections/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-connections/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 607

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "fromUserId": "123e4567-e89b-12d3-a456-426614174000",
    "toUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific user

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

userstring · uuidRequired

Responses

200

OK

application/jsontext/json

userIdstring · uuidOptional

accessGrantedToCmdsbooleanOptional

multiFactorAuthenticationbooleanOptional

defaultPasswordstring · nullableOptional

emailstring · nullableOptional

emailAlternatestring · nullableOptional

emailVerifiedstring · nullableOptional

firstNamestring · nullableOptional

fullNamestring · nullableOptional

honorificstring · nullableOptional

imageUrlstring · nullableOptional

initialsstring · nullableOptional

lastNamestring · nullableOptional

loginOrganizationCodestring · nullableOptional

middleNamestring · nullableOptional

multiFactorAuthenticationCodestring · nullableOptional

oAuthProviderUserIdstring · nullableOptional

oldUserPasswordHashstring · nullableOptional

phoneMobilestring · nullableOptional

soundexFirstNamestring · nullableOptional

soundexLastNamestring · nullableOptional

timeZonestring · nullableOptional

userPasswordHashstring · nullableOptional

primaryLoginMethodinteger · int32 · nullableOptional

secondaryLoginMethodinteger · int32 · nullableOptional

userPasswordChangeRequestedinteger · int32 · nullableOptional

accountCloakedstring · date-time · nullableOptional

defaultPasswordExpiredstring · date-time · nullableOptional

userLicenseAcceptedstring · date-time · nullableOptional

userPasswordChangedstring · date-time · nullableOptional

userPasswordExpiredstring · date-timeOptional

utcArchivedstring · date-time · nullableOptional

utcUnarchivedstring · date-time · nullableOptional

get

/api/security/users/{user}

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/users/{user} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "accessGrantedToCmds": true,
  "multiFactorAuthentication": true,
  "defaultPassword": "text",
  "email": "text",
  "emailAlternate": "text",
  "emailVerified": "text",
  "firstName": "text",
  "fullName": "text",
  "honorific": "text",
  "imageUrl": "text",
  "initials": "text",
  "lastName": "text",
  "loginOrganizationCode": "text",
  "middleName": "text",
  "multiFactorAuthenticationCode": "text",
  "oAuthProviderUserId": "text",
  "oldUserPasswordHash": "text",
  "phoneMobile": "text",
  "soundexFirstName": "text",
  "soundexLastName": "text",
  "timeZone": "text",
  "userPasswordHash": "text",
  "primaryLoginMethod": 1,
  "secondaryLoginMethod": 1,
  "userPasswordChangeRequested": 1,
  "accountCloaked": "2026-03-13T10:20:38.160Z",
  "defaultPasswordExpired": "2026-03-13T10:20:38.160Z",
  "userLicenseAccepted": "2026-03-13T10:20:38.160Z",
  "userPasswordChanged": "2026-03-13T10:20:38.160Z",
  "userPasswordExpired": "2026-03-13T10:20:38.160Z",
  "utcArchived": "2026-03-13T10:20:38.160Z",
  "utcUnarchived": "2026-03-13T10:20:38.160Z"
}

Checks for the existence of one specific user

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

userstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/security/users/{user}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/users/{user} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdsstring · uuid[] · nullableOptional

userEmailExactstring · nullableOptional

userFullNameContainsstring · nullableOptional

Responses

200

OK

application/jsontext/json

userIdstring · uuidOptional

fullNamestring · nullableOptional

post

/api/security/users/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 601

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "userEmailExact": "text",
  "userFullNameContains": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "fullName": "text"
  }
]

Counts the users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdsstring · uuid[] · nullableOptional

userEmailExactstring · nullableOptional

userFullNameContainsstring · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/security/users/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 601

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "userEmailExact": "text",
  "userFullNameContains": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdsstring · uuid[] · nullableOptional

userEmailExactstring · nullableOptional

userFullNameContainsstring · nullableOptional

Responses

200

OK

No content

post

/api/security/users/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 601

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "userEmailExact": "text",
  "userFullNameContains": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of users that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdsstring · uuid[] · nullableOptional

userEmailExactstring · nullableOptional

userFullNameContainsstring · nullableOptional

Responses

200

OK

application/jsontext/json

userIdstring · uuidOptional

fullNamestring · nullableOptional

post

/api/security/users/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 601

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "userEmailExact": "text",
  "userFullNameContains": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "fullName": "text"
  }
]

Retrieves one specific user session

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sessionstring · uuidRequired

Responses

200

OK

application/jsontext/json

organizationIdstring · uuidOptional

sessionIdstring · uuidOptional

userIdstring · uuidOptional

sessionIsAuthenticatedbooleanOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-timeOptional

sessionStoppedstring · date-time · nullableOptional

get

/api/security/users-sessions/{session}

HTTPcURLJavaScriptPython

GET /v2/e01/api/security/users-sessions/{session} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sessionstring · uuidRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

organizationIdstring · uuidOptional

sessionIdstring · uuidOptional

userIdstring · uuidOptional

sessionIsAuthenticatedbooleanOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-timeOptional

sessionStoppedstring · date-time · nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/jsontext/json

put

/api/security/users-sessions/{session}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/security/users-sessions/{session} HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 547

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sessionstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

delete

/api/security/users-sessions/{session}

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/security/users-sessions/{session} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Checks for the existence of one specific user session

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sessionstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/security/users-sessions/{session}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/users-sessions/{session} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of user sessions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

sessionIsAuthenticatedboolean · nullableOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-time · nullableOptional

sessionStoppedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

organizationIdstring · uuidOptional

sessionIdstring · uuidOptional

userIdstring · uuidOptional

sessionIsAuthenticatedbooleanOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-timeOptional

sessionStoppedstring · date-time · nullableOptional

post

/api/security/users-sessions/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-sessions/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 935

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "sessionId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "sessionIsAuthenticated": true,
    "authenticationErrorMessage": "text",
    "authenticationErrorType": "text",
    "authenticationSource": "text",
    "sessionCode": "text",
    "userAgent": "text",
    "userBrowser": "text",
    "userBrowserVersion": "text",
    "userEmail": "text",
    "userHostAddress": "text",
    "userLanguage": "text",
    "sessionMinutes": 1,
    "sessionStarted": "2026-03-13T10:20:38.160Z",
    "sessionStopped": "2026-03-13T10:20:38.160Z"
  }
]

Counts the user sessions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

sessionIsAuthenticatedboolean · nullableOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-time · nullableOptional

sessionStoppedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/security/users-sessions/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-sessions/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 935

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of user sessions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

sessionIsAuthenticatedboolean · nullableOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-time · nullableOptional

sessionStoppedstring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/security/users-sessions/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-sessions/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 935

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of user sessions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

userIdstring · uuid · nullableOptional

sessionIsAuthenticatedboolean · nullableOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-time · nullableOptional

sessionStoppedstring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

sessionIdstring · uuidOptional

post

/api/security/users-sessions/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-sessions/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 935

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-13T10:20:38.160Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "sessionId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

organizationIdstring · uuidOptional

sessionIdstring · uuidOptional

userIdstring · uuidOptional

sessionIsAuthenticatedbooleanOptional

authenticationErrorMessagestring · nullableOptional

authenticationErrorTypestring · nullableOptional

authenticationSourcestring · nullableOptional

sessionCodestring · nullableOptional

userAgentstring · nullableOptional

userBrowserstring · nullableOptional

userBrowserVersionstring · nullableOptional

userEmailstring · nullableOptional

userHostAddressstring · nullableOptional

userLanguagestring · nullableOptional

sessionMinutesinteger · int32 · nullableOptional

sessionStartedstring · date-timeOptional

sessionStoppedstring · date-time · nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/api/security/users-sessions

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/users-sessions HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 547

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIsAuthenticated": true,
  "authenticationErrorMessage": "text",
  "authenticationErrorType": "text",
  "authenticationSource": "text",
  "sessionCode": "text",
  "userAgent": "text",
  "userBrowser": "text",
  "userBrowserVersion": "text",
  "userEmail": "text",
  "userHostAddress": "text",
  "userLanguage": "text",
  "sessionMinutes": 1,
  "sessionStarted": "2026-03-13T10:20:38.160Z",
  "sessionStopped": "2026-03-13T10:20:38.160Z"
}