Security API

Query parameters

organizationCodestringOptional

emailstringOptional

impersonatorOrganizationCodestringOptional

impersonatorUserEmailstringOptional

Responses

200

No content

post

/api/security/cookies/login

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

200

No content

post

Responses

200

No content

post

/api/security/cookies/logout

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

200

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

No content

post

/api/security/cookies/create

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

200

No content

Decodes and deserializes a cookie token from the request body.

post

Responses

200

No content

post

/api/security/cookies/decode

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

200

No content

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

post

Responses

200

No content

post

/api/security/cookies/generate

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

200

No content

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

get

Authorizations

InSite.WebTokenstringRequired

Responses

200

No content

get

/api/security/cookies/introspect

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

200

No content

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

post

Responses

200

No content

post

/api/security/cookies/validate

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

200

No content

post

Authorizations

BearerstringRequired

Path parameters

languagestringRequired

Responses

200

No content

post

/api/security/cookies/change-language/{language}

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

200

No content

post

Authorizations

BearerstringRequired

Path parameters

themestringRequired

Responses

200

No content

post

/api/security/cookies/change-theme/{theme}

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

200

No content

post

Authorizations

BearerstringRequired

Responses

200

No content

post

/api/security/cookies/refresh-session

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

200

No content

post

Responses

200

No content

post

/api/security/passwords/hash

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

200

No content

get

Authorizations

SecretstringRequired

Responses

200

No content

get

/api/security/secrets/introspect

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

200

No content

post

Body

debugbooleanOptional

secretstring · nullableOptional

lifetimeinteger · int32 · nullableOptional

organizationstring · uuid · nullableOptional

agentstring · uuid · nullableOptional

subjectstring · uuid · nullableOptional

Responses

200

No content

post

/api/security/tokens/generate

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

{
  "debug": true,
  "secret": "text",
  "lifetime": 1,
  "organization": "123e4567-e89b-12d3-a456-426614174000",
  "agent": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "123e4567-e89b-12d3-a456-426614174000"
}

200

No content

get

Authorizations

BearerstringRequired

Responses

200

No content

get

/api/security/tokens/introspect

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

200

No content

post

Responses

200

No content

post

/api/security/tokens/validate

POST /v2/e01/api/security/tokens/validate HTTP/1.1
Accept: */*

200

No content

PreviousProgress API: Periods NextSecurity API: Organizations

Last updated 20 hours ago

Was this helpful?

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

hashtagDecodes and deserializes a cookie token from the request body.

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

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

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

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

Decodes and deserializes a cookie token from the request body.

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

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

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