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

get

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "fromUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "toUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-01-22T14:49:08.891Z"
}

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

Responseboolean

head

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

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/users-connections/{from}/{to} HTTP/1.1
Host: 
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

isLeaderboolean | nullableOptional

isManagerboolean | nullableOptional

isSupervisorboolean | nullableOptional

isValidatorboolean | nullableOptional

connectedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/security/users-connections/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-01-22T14:49:08.891Z"
}

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

200

OK

[
  {
    "fromUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "toUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isLeader": true,
    "isManager": true,
    "isSupervisor": true,
    "isValidator": true,
    "connected": "2026-01-22T14:49:08.891Z"
  }
]

Counts the user connections that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid | nullableOptional

isLeaderboolean | nullableOptional

isManagerboolean | nullableOptional

isSupervisorboolean | nullableOptional

isValidatorboolean | nullableOptional

connectedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/security/users-connections/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-01-22T14:49:08.891Z"
}

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

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
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 551

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-01-22T14:49:08.891Z"
}

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

isLeaderboolean | nullableOptional

isManagerboolean | nullableOptional

isSupervisorboolean | nullableOptional

isValidatorboolean | nullableOptional

connectedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/security/users-connections/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "isLeader": true,
  "isManager": true,
  "isSupervisor": true,
  "isValidator": true,
  "connected": "2026-01-22T14:49:08.891Z"
}

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

200

OK

[
  {
    "fromUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "toUserIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific user

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

userstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/security/users/{user}

HTTPcURLJavaScriptPython

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

200

OK

{
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "defaultPasswordExpired": "2026-01-22T14:49:08.891Z",
  "userLicenseAccepted": "2026-01-22T14:49:08.891Z",
  "userPasswordChanged": "2026-01-22T14:49:08.891Z",
  "userPasswordExpired": "2026-01-22T14:49:08.891Z",
  "utcArchived": "2026-01-22T14:49:08.891Z",
  "utcUnarchived": "2026-01-22T14:49:08.891Z"
}

Checks for the existence of one specific user

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

userstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/security/users/{user}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/users/{user} HTTP/1.1
Host: 
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

userEmailExactstring | nullableOptional

userFullNameContainsstring | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/security/users/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "userEmailExact": "text",
  "userFullNameContains": "text"
}

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

200

OK

[
  {
    "userIdentifier": "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

userEmailExactstring | nullableOptional

userFullNameContainsstring | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/security/users/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "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

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
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 494

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "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

userEmailExactstring | nullableOptional

userFullNameContainsstring | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/security/users/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "userEmailExact": "text",
  "userFullNameContains": "text"
}

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

200

OK

[
  {
    "userIdentifier": "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

get

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sessionstring · uuidRequired

Body

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

organizationIdentifierstring · uuidOptional

sessionIdentifierstring · uuidOptional

userIdentifierstring · 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
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 571

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

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
Host: 
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

Responseboolean

head

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

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/security/users-sessions/{session} HTTP/1.1
Host: 
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

organizationIdentifierstring · uuid | nullableOptional

userIdentifierstring · 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

post

/api/security/users-sessions/collect

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

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

200

OK

[
  {
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "sessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "userIdentifier": "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-01-22T14:49:08.891Z",
    "sessionStopped": "2026-01-22T14:49:08.891Z"
  }
]

Counts the user sessions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

userIdentifierstring · 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

post

/api/security/users-sessions/count

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

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

organizationIdentifierstring · uuid | nullableOptional

userIdentifierstring · 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
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 951

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

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

organizationIdentifierstring · uuid | nullableOptional

userIdentifierstring · 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

post

/api/security/users-sessions/search

HTTPcURLJavaScriptPython

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

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:49:08.891Z",
    "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"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

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

200

OK

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

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

organizationIdentifierstring · uuidOptional

sessionIdentifierstring · uuidOptional

userIdentifierstring · 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
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 571

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}

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

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "sessionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "userIdentifier": "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-01-22T14:49:08.891Z",
  "sessionStopped": "2026-01-22T14:49:08.891Z"
}