Skip to main content

login

POST /login.logout#

Description#

Logout (including SSO, if used))

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200object

POST /login.supported_modes#

Description#

Return supported login modes.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
callback_url_prefix
optional
URL prefix used to generate the callback URL for each supported SSO providerstring
state
optional
ASCII base64 encoded application statestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
authenticated
optional
Is user authenticatedboolean
basic
optional
basic
server_errors
optional
Server initialization errorsserver_errors
sso
optional
SSO authentication providers< string, string > map
sso_providers
optional
The list of SSO authentication providers< object > array

basic

NameDescriptionSchema
enabled
optional
Basic aothentication (fixed users mode) mode enabledboolean
guest
optional
guest

guest

NameDescriptionSchema
enabled
optional
Basic aothentication guest mode enabledboolean
name
optional
Guest namestring
password
optional
Guest passwordstring
username
optional
Guest usernamestring

server_errors

NameDescriptionSchema
es_connection_error
optional
Indicate an error communicating to Elasticsearchboolean
missed_es_upgrade
optional
Indicate that Elasticsearch database was not upgraded from version 5boolean