1Login

Overview

This API allows users to generate a session token which can be used as a sessionid in all subsequent REST API calls. Alternatively, users can directly use Basic Authentication or third-party token-based authentication.

Method: POST

Request URL: {kyvos-url}/rest/v2/login

Headers

Header Name	Type	Description	Possible Values

Header Name	Type	Description	Possible Values
Content-Type (Required)	String	Specifies media type of request body.	`application/x-www-form-urlencoded`

Request Body

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
username	String	Name of the user to be authenticated.	–
password	String	Password of the user to be authenticated.	–
tokenTimeout	Integer	Number of minutes of inactivity after which the login session expires. Default: `30` minutes.	–
mode	String	Optional parameter used for password-less authentication when Kyvos is configured in embedded mode. When using password-less authentication, the token parameter must also be provided. Kyvos validates the username and token by making a reverse REST call to the configured authentication URL.	`NORMAL`, `INTEGRATION`, `ADMIN_PORTAL`, `KM`
source	String	Specifies the application from which the login request originates.	`ADMIN_PORTAL`, `KM`
token	String	Used to generate a session ID using an access token or ID token. For password-less authentication, a unique identifier (GUID) can also be provided.	–
loginToken	String	Login token received from the source application for authenticating the login request.	–
customData	String	Optional JSON string used for password-less SSO when Kyvos embedding is enabled. Additional information provided here is forwarded to the configured authentication verification endpoint. Dynamic URL parameters in the verification URL can also be populated using the top-level keys from this JSON.	Valid JSON string
locale	String	Specifies the locale for the generated session ID. If provided, all subsequent API responses using the generated session ID will use the specified locale. Otherwise, the default Kyvos language is used.	–
appType	String	Indicates the application type when generating a session ID using third-party authentication. Required if both application types are configured.	`PUBLIC`, `CONFIDENTIAL`
provideUserDetails	Boolean	Specifies whether detailed user information should be included in the login response. Default: `false`.	`true`, `false`
createdUser	Boolean	Specifies whether a new user should be created if the authenticated user does not already exist. Applicable for SSO or login requests from `KM` and `ADMIN_PORTAL`. Default: `false`.	`true`, `false`

Responses

200 Success

{
  "success": "CB07066B-7D6E-873E-E442-BB20B01C8BF1"
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
412	Precondition failed. Parameter missing.
500	Internal Server Error