POST
/
logins
/
create
Create a login
curl --request POST \
  --url https://api.kaizenautomation.com/logins/create \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "authenticationUrl": "<string>",
  "homeUrl": "<string>",
  "loginConfiguration": {
    "username": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "twoFactorAuthConfiguration": {
      "method": "Email",
      "alwaysRequired": true,
      "twoFactorAuthEmail": "<string>",
      "totpSecretKey": "<string>"
    },
    "additionalCredentials": [
      {
        "id": "<string>",
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "password": "<string>"
  },
  "proxy": {
    "username": "<string>",
    "password": "<string>",
    "server": "<string>"
  },
  "persistSession": true,
  "isManualAuthentication": false
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "authenticationUrl": "<string>",
  "homeUrl": "<string>",
  "loginConfiguration": {
    "username": "<string>",
    "email": "jsmith@example.com",
    "phone": "<string>",
    "twoFactorAuthConfiguration": {
      "method": "Email",
      "alwaysRequired": true,
      "twoFactorAuthEmail": "<string>"
    },
    "additionalCredentials": [
      {
        "id": "<string>",
        "key": "<string>",
        "value": "<string>"
      }
    ]
  },
  "proxy": {
    "username": "<string>",
    "server": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "persistSession": true,
  "isManualAuthentication": false
}

Body

application/json

Login creation parameters

name
string
required

Name of the login for identification

Minimum length: 1
authenticationUrl
string
required

URL of the authentication page

homeUrl
string
required

URL of the home page of the domain

loginConfiguration
object
required

Values for fields required to complete authentication, including sensitive credentials.

proxy
object

Proxy configuration for this login

persistSession
boolean

Whether to persist the session after authentication

isManualAuthentication
boolean
default:false

Whether this login requires manual authentication

Response

Login created successfully

id
string
required

Unique identifier for the login

organizationId
string
required

ID of the organization that owns this login.

name
string
required

Name of the login

authenticationUrl
string
required

URL of the authentication page

homeUrl
string
required

URL of the home page

loginConfiguration
object
required

Values for fields required to complete authentication. Sensitive credentials are excluded for security.

createdAt
string
required

Timestamp when the login was created

updatedAt
string
required

Timestamp when the login was last updated

persistSession
boolean
default:true
required

Whether to persist the session after authentication

isManualAuthentication
boolean
default:false
required

Whether this login requires manual authentication

proxy
object

Proxy configuration for this login. Sensitive credentials are excluded for security.