Security: Users

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

commentstring · uuidRequired

Responses

200

OK

application/json

get

/security/users-comments/{comment}

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-comments/{comment} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "CommentCreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "CommentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "CommentText": "text",
  "CommentCreated": "2025-12-05T21:57:36.322Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

commentstringRequired

Body

application/jsontext/jsonapplication/*+json

CommentCreatedBystring · uuidOptional

CommentIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

CommentTextstring | nullableOptional

CommentCreatedstring · date-timeOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/security/users-comments/{comment}

HTTPcURLJavaScriptPython

PUT /v2/E01/security/users-comments/{comment} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "CommentCreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "CommentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "CommentText": "text",
  "CommentCreated": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

commentstring · uuidRequired

Responses

200

OK

No content

404

Not Found

delete

/security/users-comments/{comment}

HTTPcURLJavaScriptPython

DELETE /v2/E01/security/users-comments/{comment} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

commentstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users-comments/{comment}

HTTPcURLJavaScriptPython

HEAD /v2/E01/security/users-comments/{comment} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

CommentCreatedBystring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

CommentTextstringOptional

CommentCreatedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-comments/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-comments/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

CommentCreatedBystring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

CommentTextstringOptional

CommentCreatedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-comments

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-comments HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "CommentCreatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "CommentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "CommentText": "text",
    "CommentCreated": "2025-12-05T21:57:36.322Z"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Body

application/jsontext/jsonapplication/*+json

CommentCreatedBystring · uuidOptional

CommentIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

CommentTextstring | nullableOptional

CommentCreatedstring · date-timeOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/security/users-comments

HTTPcURLJavaScriptPython

POST /v2/E01/security/users-comments HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "CommentCreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "CommentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "CommentText": "text",
  "CommentCreated": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

{
  "CommentCreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "CommentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "CommentText": "text",
  "CommentCreated": "2025-12-05T21:57:36.322Z"
}

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

CommentCreatedBystring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

CommentTextstringOptional

CommentCreatedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-comments/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-comments/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

fromUserstring · uuidRequired

toUserstring · uuidRequired

fromstringRequired

tostringRequired

Responses

200

OK

application/json

get

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

HTTPcURLJavaScriptPython

GET /v2/E01/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": "2025-12-05T21:57:36.322Z"
}

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

fromUserstring · uuidRequired

toUserstring · uuidRequired

fromstringRequired

tostringRequired

Responses

200

OK

application/json

Responseboolean

head

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

HTTPcURLJavaScriptPython

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

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

IsManagerbooleanOptional

IsSupervisorbooleanOptional

IsValidatorbooleanOptional

Connectedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-connections/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-connections/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

IsManagerbooleanOptional

IsSupervisorbooleanOptional

IsValidatorbooleanOptional

Connectedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-connections

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-connections 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": "2025-12-05T21:57:36.322Z"
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

IsManagerbooleanOptional

IsSupervisorbooleanOptional

IsValidatorbooleanOptional

Connectedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-connections/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-connections/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "FromUserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ToUserIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

userstring · uuidRequired

Responses

200

OK

application/json

get

/security/users/{user}

HTTPcURLJavaScriptPython

GET /v2/E01/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": "2025-12-05T21:57:36.322Z",
  "DefaultPasswordExpired": "2025-12-05T21:57:36.322Z",
  "UserLicenseAccepted": "2025-12-05T21:57:36.322Z",
  "UserPasswordChanged": "2025-12-05T21:57:36.322Z",
  "UserPasswordExpired": "2025-12-05T21:57:36.322Z",
  "UtcArchived": "2025-12-05T21:57:36.322Z",
  "UtcUnarchived": "2025-12-05T21:57:36.322Z"
}

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

userstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users/{user}

HTTPcURLJavaScriptPython

HEAD /v2/E01/security/users/{user} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

AccessGrantedToCmdsbooleanOptional

MultiFactorAuthenticationbooleanOptional

DefaultPasswordstringOptional

EmailstringOptional

EmailAlternatestringOptional

EmailVerifiedstringOptional

FirstNamestringOptional

FullNamestringOptional

HonorificstringOptional

ImageUrlstringOptional

InitialsstringOptional

LastNamestringOptional

LoginOrganizationCodestringOptional

MiddleNamestringOptional

MultiFactorAuthenticationCodestringOptional

OAuthProviderUserIdstringOptional

OldUserPasswordHashstringOptional

PhoneMobilestringOptional

SoundexFirstNamestringOptional

SoundexLastNamestringOptional

TimeZonestringOptional

UserPasswordHashstringOptional

PrimaryLoginMethodinteger · int32Optional

SecondaryLoginMethodinteger · int32Optional

UserPasswordChangeRequestedinteger · int32Optional

AccountCloakedstring · date-timeOptional

DefaultPasswordExpiredstring · date-timeOptional

UserLicenseAcceptedstring · date-timeOptional

UserPasswordChangedstring · date-timeOptional

UserPasswordExpiredstring · date-timeOptional

UtcArchivedstring · date-timeOptional

UtcUnarchivedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

AccessGrantedToCmdsbooleanOptional

MultiFactorAuthenticationbooleanOptional

DefaultPasswordstringOptional

EmailstringOptional

EmailAlternatestringOptional

EmailVerifiedstringOptional

FirstNamestringOptional

FullNamestringOptional

HonorificstringOptional

ImageUrlstringOptional

InitialsstringOptional

LastNamestringOptional

LoginOrganizationCodestringOptional

MiddleNamestringOptional

MultiFactorAuthenticationCodestringOptional

OAuthProviderUserIdstringOptional

OldUserPasswordHashstringOptional

PhoneMobilestringOptional

SoundexFirstNamestringOptional

SoundexLastNamestringOptional

TimeZonestringOptional

UserPasswordHashstringOptional

PrimaryLoginMethodinteger · int32Optional

SecondaryLoginMethodinteger · int32Optional

UserPasswordChangeRequestedinteger · int32Optional

AccountCloakedstring · date-timeOptional

DefaultPasswordExpiredstring · date-timeOptional

UserLicenseAcceptedstring · date-timeOptional

UserPasswordChangedstring · date-timeOptional

UserPasswordExpiredstring · date-timeOptional

UtcArchivedstring · date-timeOptional

UtcUnarchivedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users

HTTPcURLJavaScriptPython

GET /v2/E01/security/users 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": "2025-12-05T21:57:36.322Z",
    "DefaultPasswordExpired": "2025-12-05T21:57:36.322Z",
    "UserLicenseAccepted": "2025-12-05T21:57:36.322Z",
    "UserPasswordChanged": "2025-12-05T21:57:36.322Z",
    "UserPasswordExpired": "2025-12-05T21:57:36.322Z",
    "UtcArchived": "2025-12-05T21:57:36.322Z",
    "UtcUnarchived": "2025-12-05T21:57:36.322Z"
  }
]

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

AccessGrantedToCmdsbooleanOptional

MultiFactorAuthenticationbooleanOptional

DefaultPasswordstringOptional

EmailstringOptional

EmailAlternatestringOptional

EmailVerifiedstringOptional

FirstNamestringOptional

FullNamestringOptional

HonorificstringOptional

ImageUrlstringOptional

InitialsstringOptional

LastNamestringOptional

LoginOrganizationCodestringOptional

MiddleNamestringOptional

MultiFactorAuthenticationCodestringOptional

OAuthProviderUserIdstringOptional

OldUserPasswordHashstringOptional

PhoneMobilestringOptional

SoundexFirstNamestringOptional

SoundexLastNamestringOptional

TimeZonestringOptional

UserPasswordHashstringOptional

PrimaryLoginMethodinteger · int32Optional

SecondaryLoginMethodinteger · int32Optional

UserPasswordChangeRequestedinteger · int32Optional

AccountCloakedstring · date-timeOptional

DefaultPasswordExpiredstring · date-timeOptional

UserLicenseAcceptedstring · date-timeOptional

UserPasswordChangedstring · date-timeOptional

UserPasswordExpiredstring · date-timeOptional

UtcArchivedstring · date-timeOptional

UtcUnarchivedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

settingstring · uuidRequired

Responses

200

OK

application/json

get

/security/users-fields/{setting}

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "ValueJson": "text",
  "ValueType": "text"
}

put

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

settingstringRequired

Body

application/jsontext/jsonapplication/*+json

OrganizationIdentifierstring · uuidOptional

SettingIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

Namestring | nullableOptional

ValueJsonstring | nullableOptional

ValueTypestring | nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/security/users-fields/{setting}

HTTPcURLJavaScriptPython

PUT /v2/E01/security/users-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "ValueJson": "text",
  "ValueType": "text"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

settingstring · uuidRequired

Responses

200

OK

No content

404

Not Found

delete

/security/users-fields/{setting}

HTTPcURLJavaScriptPython

DELETE /v2/E01/security/users-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

settingstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users-fields/{setting}

HTTPcURLJavaScriptPython

HEAD /v2/E01/security/users-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

NamestringOptional

ValueJsonstringOptional

ValueTypestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-fields/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-fields/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

NamestringOptional

ValueJsonstringOptional

ValueTypestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-fields

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "ValueJson": "text",
    "ValueType": "text"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Body

application/jsontext/jsonapplication/*+json

OrganizationIdentifierstring · uuidOptional

SettingIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

Namestring | nullableOptional

ValueJsonstring | nullableOptional

ValueTypestring | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/security/users-fields

HTTPcURLJavaScriptPython

POST /v2/E01/security/users-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "ValueJson": "text",
  "ValueType": "text"
}

application/jsontext/jsonapplication/*+json

{
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "ValueJson": "text",
  "ValueType": "text"
}

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

NamestringOptional

ValueJsonstringOptional

ValueTypestringOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-fields/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-fields/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

mockstring · uuidRequired

Responses

200

OK

application/json

get

/security/users-mocks/{mock}

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-mocks/{mock} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "MockIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "AccountCode": "text",
  "AddressPostalCode": "text",
  "AddressStreet": "text",
  "Email": "text",
  "FirstName": "text",
  "LastName": "text",
  "Phone": "text",
  "MockNumber": 1,
  "Birthdate": "2025-12-05T21:57:36.322Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

mockstringRequired

Body

application/jsontext/jsonapplication/*+json

MockIdentifierstring · uuidOptional

AccountCodestring | nullableOptional

AddressPostalCodestring | nullableOptional

AddressStreetstring | nullableOptional

Emailstring | nullableOptional

FirstNamestring | nullableOptional

LastNamestring | nullableOptional

Phonestring | nullableOptional

MockNumberinteger · int32Optional

Birthdatestring · date-timeOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/security/users-mocks/{mock}

HTTPcURLJavaScriptPython

PUT /v2/E01/security/users-mocks/{mock} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "MockIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "AccountCode": "text",
  "AddressPostalCode": "text",
  "AddressStreet": "text",
  "Email": "text",
  "FirstName": "text",
  "LastName": "text",
  "Phone": "text",
  "MockNumber": 1,
  "Birthdate": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

mockstring · uuidRequired

Responses

200

OK

No content

404

Not Found

delete

/security/users-mocks/{mock}

HTTPcURLJavaScriptPython

DELETE /v2/E01/security/users-mocks/{mock} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

mockstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users-mocks/{mock}

HTTPcURLJavaScriptPython

HEAD /v2/E01/security/users-mocks/{mock} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

AccountCodestringOptional

AddressPostalCodestringOptional

AddressStreetstringOptional

EmailstringOptional

FirstNamestringOptional

LastNamestringOptional

PhonestringOptional

MockNumberinteger · int32Optional

Birthdatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-mocks/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-mocks/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

AccountCodestringOptional

AddressPostalCodestringOptional

AddressStreetstringOptional

EmailstringOptional

FirstNamestringOptional

LastNamestringOptional

PhonestringOptional

MockNumberinteger · int32Optional

Birthdatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-mocks

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-mocks HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "MockIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "AccountCode": "text",
    "AddressPostalCode": "text",
    "AddressStreet": "text",
    "Email": "text",
    "FirstName": "text",
    "LastName": "text",
    "Phone": "text",
    "MockNumber": 1,
    "Birthdate": "2025-12-05T21:57:36.322Z"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Body

application/jsontext/jsonapplication/*+json

MockIdentifierstring · uuidOptional

AccountCodestring | nullableOptional

AddressPostalCodestring | nullableOptional

AddressStreetstring | nullableOptional

Emailstring | nullableOptional

FirstNamestring | nullableOptional

LastNamestring | nullableOptional

Phonestring | nullableOptional

MockNumberinteger · int32Optional

Birthdatestring · date-timeOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/security/users-mocks

HTTPcURLJavaScriptPython

POST /v2/E01/security/users-mocks HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "MockIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "AccountCode": "text",
  "AddressPostalCode": "text",
  "AddressStreet": "text",
  "Email": "text",
  "FirstName": "text",
  "LastName": "text",
  "Phone": "text",
  "MockNumber": 1,
  "Birthdate": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

{
  "MockIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "AccountCode": "text",
  "AddressPostalCode": "text",
  "AddressStreet": "text",
  "Email": "text",
  "FirstName": "text",
  "LastName": "text",
  "Phone": "text",
  "MockNumber": 1,
  "Birthdate": "2025-12-05T21:57:36.322Z"
}

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

AccountCodestringOptional

AddressPostalCodestringOptional

AddressStreetstringOptional

EmailstringOptional

FirstNamestringOptional

LastNamestringOptional

PhonestringOptional

MockNumberinteger · int32Optional

Birthdatestring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-mocks/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-mocks/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

cachestring · uuidRequired

Responses

200

OK

application/json

get

/security/users-sessions-caches/{cache}

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions-caches/{cache} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "CacheIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SessionStarted": "2025-12-05T21:57:36.322Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

cachestringRequired

Body

application/jsontext/jsonapplication/*+json

CacheIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionStartedstring · date-timeOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/security/users-sessions-caches/{cache}

HTTPcURLJavaScriptPython

PUT /v2/E01/security/users-sessions-caches/{cache} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "CacheIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SessionStarted": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

cachestring · uuidRequired

Responses

200

OK

No content

404

Not Found

delete

/security/users-sessions-caches/{cache}

HTTPcURLJavaScriptPython

DELETE /v2/E01/security/users-sessions-caches/{cache} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

cachestring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users-sessions-caches/{cache}

HTTPcURLJavaScriptPython

HEAD /v2/E01/security/users-sessions-caches/{cache} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionStartedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-sessions-caches/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions-caches/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionStartedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-sessions-caches

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions-caches HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "CacheIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "SessionStarted": "2025-12-05T21:57:36.322Z"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Body

application/jsontext/jsonapplication/*+json

CacheIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionStartedstring · date-timeOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/security/users-sessions-caches

HTTPcURLJavaScriptPython

POST /v2/E01/security/users-sessions-caches HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "CacheIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SessionStarted": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

{
  "CacheIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SessionStarted": "2025-12-05T21:57:36.322Z"
}

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionStartedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-sessions-caches/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions-caches/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

sessionstring · uuidRequired

Responses

200

OK

application/json

get

/security/users-sessions/{session}

HTTPcURLJavaScriptPython

GET /v2/E01/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": "2025-12-05T21:57:36.322Z",
  "SessionStopped": "2025-12-05T21:57:36.322Z"
}

put

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

sessionstringRequired

Body

application/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

put

/security/users-sessions/{session}

HTTPcURLJavaScriptPython

PUT /v2/E01/security/users-sessions/{session} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/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": "2025-12-05T21:57:36.322Z",
  "SessionStopped": "2025-12-05T21:57:36.322Z"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

sessionstring · uuidRequired

Responses

200

OK

No content

404

Not Found

delete

/security/users-sessions/{session}

HTTPcURLJavaScriptPython

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

No content

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

sessionstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users-sessions/{session}

HTTPcURLJavaScriptPython

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

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionIsAuthenticatedbooleanOptional

AuthenticationErrorMessagestringOptional

AuthenticationErrorTypestringOptional

AuthenticationSourcestringOptional

SessionCodestringOptional

UserAgentstringOptional

UserBrowserstringOptional

UserBrowserVersionstringOptional

UserEmailstringOptional

UserHostAddressstringOptional

UserLanguagestringOptional

SessionMinutesinteger · int32Optional

SessionStartedstring · date-timeOptional

SessionStoppedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-sessions/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionIsAuthenticatedbooleanOptional

AuthenticationErrorMessagestringOptional

AuthenticationErrorTypestringOptional

AuthenticationSourcestringOptional

SessionCodestringOptional

UserAgentstringOptional

UserBrowserstringOptional

UserBrowserVersionstringOptional

UserEmailstringOptional

UserHostAddressstringOptional

UserLanguagestringOptional

SessionMinutesinteger · int32Optional

SessionStartedstring · date-timeOptional

SessionStoppedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-sessions

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions 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": "2025-12-05T21:57:36.322Z",
    "SessionStopped": "2025-12-05T21:57:36.322Z"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Body

application/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

/security/users-sessions

HTTPcURLJavaScriptPython

POST /v2/E01/security/users-sessions HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/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": "2025-12-05T21:57:36.322Z",
  "SessionStopped": "2025-12-05T21:57:36.322Z"
}

application/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": "2025-12-05T21:57:36.322Z",
  "SessionStopped": "2025-12-05T21:57:36.322Z"
}

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

OrganizationIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

SessionIsAuthenticatedbooleanOptional

AuthenticationErrorMessagestringOptional

AuthenticationErrorTypestringOptional

AuthenticationSourcestringOptional

SessionCodestringOptional

UserAgentstringOptional

UserBrowserstringOptional

UserBrowserVersionstringOptional

UserEmailstringOptional

UserHostAddressstringOptional

UserLanguagestringOptional

SessionMinutesinteger · int32Optional

SessionStartedstring · date-timeOptional

SessionStoppedstring · date-timeOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-sessions/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-sessions/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

userAuthenticationFactorstring · uuidRequired

tokenstringRequired

Responses

200

OK

application/json

get

/security/users-tokens/{token}

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-tokens/{token} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "ShortLivedCookieToken": "123e4567-e89b-12d3-a456-426614174000",
  "UserAuthenticationFactorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OtpRecoveryPhrases": "text",
  "OtpMode": 1,
  "OtpTokenRefreshed": "2025-12-05T21:57:36.322Z",
  "ShortCookieTokenStartTime": "2025-12-05T21:57:36.322Z",
  "OtpTokenSecret": "Ynl0ZXM="
}

put

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

tokenstringRequired

Body

application/jsontext/jsonapplication/*+json

ShortLivedCookieTokenstring · uuid | nullableOptional

UserAuthenticationFactorIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

OtpRecoveryPhrasesstring | nullableOptional

OtpModeinteger · int32Optional

OtpTokenRefreshedstring · date-timeOptional

ShortCookieTokenStartTimestring · date-time | nullableOptional

OtpTokenSecretstring · byte | nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

/security/users-tokens/{token}

HTTPcURLJavaScriptPython

PUT /v2/E01/security/users-tokens/{token} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "ShortLivedCookieToken": "123e4567-e89b-12d3-a456-426614174000",
  "UserAuthenticationFactorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OtpRecoveryPhrases": "text",
  "OtpMode": 1,
  "OtpTokenRefreshed": "2025-12-05T21:57:36.322Z",
  "ShortCookieTokenStartTime": "2025-12-05T21:57:36.322Z",
  "OtpTokenSecret": "Ynl0ZXM="
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

userAuthenticationFactorstring · uuidRequired

tokenstringRequired

Responses

200

OK

No content

404

Not Found

delete

/security/users-tokens/{token}

HTTPcURLJavaScriptPython

DELETE /v2/E01/security/users-tokens/{token} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Path parameters

userAuthenticationFactorstring · uuidRequired

tokenstringRequired

Responses

200

OK

application/json

Responseboolean

head

/security/users-tokens/{token}

HTTPcURLJavaScriptPython

HEAD /v2/E01/security/users-tokens/{token} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

ShortLivedCookieTokenstring · uuidOptional

UserIdentifierstring · uuidOptional

OtpRecoveryPhrasesstringOptional

OtpModeinteger · int32Optional

OtpTokenRefreshedstring · date-timeOptional

ShortCookieTokenStartTimestring · date-timeOptional

OtpTokenSecretstring · byteOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

/security/users-tokens/count

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-tokens/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

ShortLivedCookieTokenstring · uuidOptional

UserIdentifierstring · uuidOptional

OtpRecoveryPhrasesstringOptional

OtpModeinteger · int32Optional

OtpTokenRefreshedstring · date-timeOptional

ShortCookieTokenStartTimestring · date-timeOptional

OtpTokenSecretstring · byteOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-tokens

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-tokens HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "ShortLivedCookieToken": "123e4567-e89b-12d3-a456-426614174000",
    "UserAuthenticationFactorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OtpRecoveryPhrases": "text",
    "OtpMode": 1,
    "OtpTokenRefreshed": "2025-12-05T21:57:36.322Z",
    "ShortCookieTokenStartTime": "2025-12-05T21:57:36.322Z",
    "OtpTokenSecret": "Ynl0ZXM="
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Body

application/jsontext/jsonapplication/*+json

ShortLivedCookieTokenstring · uuid | nullableOptional

UserAuthenticationFactorIdentifierstring · uuidOptional

UserIdentifierstring · uuidOptional

OtpRecoveryPhrasesstring | nullableOptional

OtpModeinteger · int32Optional

OtpTokenRefreshedstring · date-timeOptional

ShortCookieTokenStartTimestring · date-time | nullableOptional

OtpTokenSecretstring · byte | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/security/users-tokens

HTTPcURLJavaScriptPython

POST /v2/E01/security/users-tokens HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 366

{
  "ShortLivedCookieToken": "123e4567-e89b-12d3-a456-426614174000",
  "UserAuthenticationFactorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OtpRecoveryPhrases": "text",
  "OtpMode": 1,
  "OtpTokenRefreshed": "2025-12-05T21:57:36.322Z",
  "ShortCookieTokenStartTime": "2025-12-05T21:57:36.322Z",
  "OtpTokenSecret": "Ynl0ZXM="
}

application/jsontext/jsonapplication/*+json

{
  "ShortLivedCookieToken": "123e4567-e89b-12d3-a456-426614174000",
  "UserAuthenticationFactorIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OtpRecoveryPhrases": "text",
  "OtpMode": 1,
  "OtpTokenRefreshed": "2025-12-05T21:57:36.322Z",
  "ShortCookieTokenStartTime": "2025-12-05T21:57:36.322Z",
  "OtpTokenSecret": "Ynl0ZXM="
}

get

Authorizations

BearerCookie

BearerstringRequired

blah blah blah

Query parameters

ShortLivedCookieTokenstring · uuidOptional

UserIdentifierstring · uuidOptional

OtpRecoveryPhrasesstringOptional

OtpModeinteger · int32Optional

OtpTokenRefreshedstring · date-timeOptional

ShortCookieTokenStartTimestring · date-timeOptional

OtpTokenSecretstring · byteOptional

Identifierstring · uuidOptional

Origin.Whenstring · date-timeOptional

Origin.Organizationstring · uuidOptional

Origin.Userstring · uuidOptional

Origin.Proxystring · uuidOptional

Origin.DescriptionstringOptional

Origin.ReasonstringOptional

Origin.SourcestringOptional

Filter.Pageinteger · int32Optional

Filter.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

/security/users-tokens/search

HTTPcURLJavaScriptPython

GET /v2/E01/security/users-tokens/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

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