Accounts API

post

Query parameters

organizationCodestringOptional

emailstringOptional

impersonatorOrganizationCodestringOptional

impersonatorUserEmailstringOptional

Responses

200

OK

application/jsontext/json

AuthenticationSourcestring · nullableOptional

Createdstring · nullableOptional

CurrentBrowserstring · nullableOptional

CurrentBrowserVersionstring · nullableOptional

CurrentOrganizationstring · nullableOptional

IDstring · uuidOptional

ImpersonatorOrganizationstring · nullableOptional

ImpersonatorUserstring · nullableOptional

IsAdministratorbooleanOptional

IsAuthenticatedbooleanRead-onlyOptional

IsDeveloperbooleanOptional

IsOperatorbooleanOptional

IsLearnerbooleanOptional

Languagestring · nullableOptional

Modifiedstring · nullableOptional

OrganizationCodestring · nullableOptional

OrganizationIdentifierstring · uuid · nullableOptional

Sessionstring · nullableOptional

TimeZoneIdstring · nullableOptional

UserEmailstring · nullableOptional

UserIdentifierstring · uuid · nullableOptional

UserRolesstring[] · nullableOptional

ValidationKeystring · nullableOptional

Environmentstring · nullableOptional

400

Bad Request

application/jsontext/json

post/api/accounts/cookies/login

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/login HTTP/1.1
Accept: */*

{
  "AuthenticationSource": "text",
  "Created": "text",
  "CurrentBrowser": "text",
  "CurrentBrowserVersion": "text",
  "CurrentOrganization": "text",
  "ID": "123e4567-e89b-12d3-a456-426614174000",
  "ImpersonatorOrganization": "text",
  "ImpersonatorUser": "text",
  "IsAdministrator": true,
  "IsAuthenticated": true,
  "IsDeveloper": true,
  "IsOperator": true,
  "IsLearner": true,
  "Language": "text",
  "Modified": "text",
  "OrganizationCode": "text",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "Session": "text",
  "TimeZoneId": "text",
  "UserEmail": "text",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserRoles": [
    "text"
  ],
  "ValidationKey": "text",
  "Environment": "text"
}

post

Responses

200

OK

No content

post/api/accounts/cookies/logout

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/logout HTTP/1.1
Accept: */*

200

OK

No content

Creates a new authentication cookie with the specified name and lifetime using the raw request body as the cookie value.

post

In contrast to security/cookies/generate endpoint, this endpoint makes no assumptions about the request body. This means you can POST whatever cookie name and cookie value you want (encoded/escaped or not) and this method tries to create a new cookie for you. This is useful for testing the behaviour of the API when it receives unexpected (or corrupted) cookie tokens. Please note this endpoint is available in localhost environments only!

Query parameters

namestringOptional

The name of the cookie to create. If not provided, uses the default cookie name from API configuration settings.

lifetimeinteger · int32Optional

The lifetime of the cookie in seconds. If not provided, uses the default lifetime from API configuration settings.

Responses

200

OK

application/jsontext/json

Valuestring · nullableOptional

400

Bad Request

application/jsontext/json

post/api/accounts/cookies/create

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/create HTTP/1.1
Accept: */*

{
  "Value": "text"
}

Decodes and deserializes a cookie token from the request body.

post

Responses

200

OK

No content

post/api/accounts/cookies/decode

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/decode HTTP/1.1
Accept: */*

200

OK

No content

Generates a new authentication cookie using the provided token from the request body.

post

Responses

200

OK

application/jsontext/json

Tokenstring · nullableOptional

400

Bad Request

application/jsontext/json

post/api/accounts/cookies/generate

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/generate HTTP/1.1
Accept: */*

{
  "Token": "text"
}

Introspects the current authentication cookie and returns detailed information about the authentication and authorization status.

get

Authorizations

Cookie

InSite.WebTokenstringRequired

Responses

200

OK

No content

get/api/accounts/cookies/introspect

HTTPcURLJavaScriptPython

GET /v2/e01/api/accounts/cookies/introspect HTTP/1.1
Accept: */*

200

OK

No content

Validates a cookie token from the request body without setting it as an authentication cookie.

post

Responses

200

OK

application/jsontext/json

AuthenticationSourcestring · nullableOptional

Createdstring · nullableOptional

CurrentBrowserstring · nullableOptional

CurrentBrowserVersionstring · nullableOptional

CurrentOrganizationstring · nullableOptional

IDstring · uuidOptional

ImpersonatorOrganizationstring · nullableOptional

ImpersonatorUserstring · nullableOptional

IsAdministratorbooleanOptional

IsAuthenticatedbooleanRead-onlyOptional

IsDeveloperbooleanOptional

IsOperatorbooleanOptional

IsLearnerbooleanOptional

Languagestring · nullableOptional

Modifiedstring · nullableOptional

OrganizationCodestring · nullableOptional

OrganizationIdentifierstring · uuid · nullableOptional

Sessionstring · nullableOptional

TimeZoneIdstring · nullableOptional

UserEmailstring · nullableOptional

UserIdentifierstring · uuid · nullableOptional

UserRolesstring[] · nullableOptional

ValidationKeystring · nullableOptional

Environmentstring · nullableOptional

400

Bad Request

application/jsontext/json

post/api/accounts/cookies/validate

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/validate HTTP/1.1
Accept: */*

{
  "AuthenticationSource": "text",
  "Created": "text",
  "CurrentBrowser": "text",
  "CurrentBrowserVersion": "text",
  "CurrentOrganization": "text",
  "ID": "123e4567-e89b-12d3-a456-426614174000",
  "ImpersonatorOrganization": "text",
  "ImpersonatorUser": "text",
  "IsAdministrator": true,
  "IsAuthenticated": true,
  "IsDeveloper": true,
  "IsOperator": true,
  "IsLearner": true,
  "Language": "text",
  "Modified": "text",
  "OrganizationCode": "text",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "Session": "text",
  "TimeZoneId": "text",
  "UserEmail": "text",
  "UserIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "UserRoles": [
    "text"
  ],
  "ValidationKey": "text",
  "Environment": "text"
}

post

Authorizations

BearerCookie

BearerstringRequired

Path parameters

languagestringRequired

Responses

200

OK

No content

post/api/accounts/cookies/change-language/{language}

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/change-language/{language} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

No content

post

Authorizations

BearerCookie

BearerstringRequired

Path parameters

themestringRequired

Responses

200

OK

No content

post/api/accounts/cookies/change-theme/{theme}

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/change-theme/{theme} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

No content

post

Authorizations

BearerCookie

BearerstringRequired

Responses

200

OK

No content

post/api/accounts/cookies/refresh-session

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/cookies/refresh-session HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

No content

post

Responses

200

OK

application/jsontext/json

Hashstring · nullableOptional

post/api/accounts/passwords/hash

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/passwords/hash HTTP/1.1
Accept: */*

200

OK

{
  "Hash": "text"
}

Generates a new client secret for the authenticated user, replacing any existing secret.

post

Authorizations

BearerCookie

BearerstringRequired

Query parameters

expiryinteger · int32Optional

The number of days until the secret expires. If omitted, the default is assumed (90 days).

Responses

200

OK

application/jsontext/json

PersonIdstring · uuidOptional

SecretIdstring · uuidOptional

SecretNamestring · nullableOptional

SecretTypestring · nullableOptional

SecretValuestring · nullableOptional

SecretLifetimeLimitinteger · int32 · nullableOptional

SecretExpirystring · date-timeOptional

400

Bad Request

application/jsontext/json

post/api/accounts/secrets/generate

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/secrets/generate HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "PersonId": "123e4567-e89b-12d3-a456-426614174000",
  "SecretId": "123e4567-e89b-12d3-a456-426614174000",
  "SecretName": "text",
  "SecretType": "text",
  "SecretValue": "text",
  "SecretLifetimeLimit": 1,
  "SecretExpiry": "2026-08-10T15:51:18.054Z"
}

get

Authorizations

Secret

SecretstringRequired

Responses

200

OK

No content

get/api/accounts/secrets/introspect

HTTPcURLJavaScriptPython

GET /v2/e01/api/accounts/secrets/introspect HTTP/1.1
Secret: YOUR_API_KEY
Accept: */*

200

OK

No content

post

Body

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

DebugbooleanOptional

PagingbooleanOptional

Secretstring · nullableOptional

Lifetimeinteger · int32 · nullableOptional

Organizationstring · uuid · nullableOptional

Agentstring · uuid · nullableOptional

Subjectstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

AccessTokenstring · nullableOptional

TokenTypestring · nullableOptional

ExpiresIninteger · int32Optional

Lifetimestring · nullableOptional

Pagingstring · nullableOptional

401

Unauthorized

application/jsontext/json

post/api/accounts/tokens/generate

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/tokens/generate HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 207

{
  "Debug": true,
  "Paging": true,
  "Secret": "text",
  "Lifetime": 1,
  "Organization": "123e4567-e89b-12d3-a456-426614174000",
  "Agent": "123e4567-e89b-12d3-a456-426614174000",
  "Subject": "123e4567-e89b-12d3-a456-426614174000"
}

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

{
  "AccessToken": "text",
  "TokenType": "text",
  "ExpiresIn": 1,
  "Lifetime": "text",
  "Paging": "text"
}

post

Body

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

DebugbooleanOptional

PagingbooleanOptional

Secretstring · nullableOptional

Lifetimeinteger · int32 · nullableOptional

Organizationstring · uuid · nullableOptional

Agentstring · uuid · nullableOptional

Subjectstring · uuid · nullableOptional

Responses

200

OK

application/jsontext/json

AccessTokenstring · nullableOptional

TokenTypestring · nullableOptional

ExpiresIninteger · int32Optional

Lifetimestring · nullableOptional

Pagingstring · nullableOptional

401

Unauthorized

application/jsontext/json

post/api/security/tokens/generate

HTTPcURLJavaScriptPython

POST /v2/e01/api/security/tokens/generate HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 207

{
  "Debug": true,
  "Paging": true,
  "Secret": "text",
  "Lifetime": 1,
  "Organization": "123e4567-e89b-12d3-a456-426614174000",
  "Agent": "123e4567-e89b-12d3-a456-426614174000",
  "Subject": "123e4567-e89b-12d3-a456-426614174000"
}

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

{
  "AccessToken": "text",
  "TokenType": "text",
  "ExpiresIn": 1,
  "Lifetime": "text",
  "Paging": "text"
}

get

Authorizations

Bearer

BearerstringRequired

Responses

200

OK

application/jsontext/json

Jwtany · nullableOptional

Principalany · nullableOptional

get/api/accounts/tokens/introspect

HTTPcURLJavaScriptPython

GET /v2/e01/api/accounts/tokens/introspect HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "Jwt": null,
  "Principal": null
}

post

Body

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

Tokenstring · nullableOptional

Responses

200

OK

application/jsontext/json

Subjectstring · nullableOptional

SignatureVerificationstring · nullableOptional

ExpiryVerificationstring · nullableOptional

AudienceVerificationstring · nullableOptional

IssuerVerificationstring · nullableOptional

post/api/accounts/tokens/validate

HTTPcURLJavaScriptPython

POST /v2/e01/api/accounts/tokens/validate HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 16

{
  "Token": "text"
}

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

200

OK

{
  "Subject": "text",
  "SignatureVerification": "text",
  "ExpiryVerification": "text",
  "AudienceVerification": "text",
  "IssuerVerification": "text"
}