v1

latestOpenAPI 3.0.1Apache 2.02026-07-1759153352.8 KB
Authentication

Authenticate via a method supplied via a query string parameter

Allowed authentication methods include "password", "cert", and "ext-jwt"

post/authenticate

Query parameters

method'password' | 'cert' | 'ext-jwt' required

Request body

configTypesstring[]

Specific configuration types that should be returned

passwordstring
usernamestring

Example request

{
  "envInfo": {
    "hostname": "hostname",
    "os": "os",
    "osVersion": "osVersion",
    "domain": "domain",
    "arch": "arch",
    "osRelease": "osRelease"
  },
  "sdkInfo": {
    "appVersion": "appVersion",
    "appId": "appId",
    "type": "type",
    "branch": "branch",
    "version": "version",
    "revision": "revision"
  }
}

Response

The API session associated with the session used to issue the request

Example response

{
  "data": {
    "isCertExtendRequested": true,
    "_links": {
      "key": {
        "method": "method",
        "comment": "comment",
        "href": "https://openapi-generator.tech"
      }
    },
    "configTypes": [
      "configTypes",
      "configTypes"
    ],
    "authQueries": [
      {
        "clientId": "clientId",
        "isTotpEnrolled": true,
        "provider": "ziti",
        "httpUrl": "httpUrl",
        "minLength": 6,
        "format": "numeric",
        "typeId": "MFA",
        "id": "id",
        "scopes": [
          "scopes",
          "scopes"
        ],
        "httpMethod": "httpMethod",
        "maxLength": 0
      },
      {
        "clientId": "clientId",
        "isTotpEnrolled": true,
        "provider": "ziti",
        "httpUrl": "httpUrl",
        "minLength": 6,
        "format": "numeric",
        "typeId": "MFA",
        "id": "id",
        "scopes": [
          "scopes",
          "scopes"
        ],
        "httpMethod": "httpMethod",
        "maxLength": 0
      }
    ],
    "expirationSeconds": 1,
    "ipAddress": "ipAddress",
    "lastActivityAt": "2000-01-23T04:56:07.000+00:00",
    "isMfaRequired": true,
    "expiresAt": "2000-01-23T04:56:07.000+00:00",
    "tags": {},
    "token": "token",
    "createdAt": "2000-01-23T04:56:07.000+00:00",
    "isMfaComplete": true,
    "cachedLastActivityAt": "2000-01-23T04:56:07.000+00:00",
    "identity": {
      "_links": {
        "key": {
          "method": "method",
          "comment": "comment",
          "href": "https://openapi-generator.tech"
        }
      },
      "name": "name",
      "id": "id",
      "entity": "entity"
    },
    "identityId": "identityId",
    "improperClientCertChain": true,
    "isCertKeyRollRequested": true,
    "authenticatorId": "authenticatorId",
    "id": "id",
    "isCertExtendable": true,
    "updatedAt": "2000-01-23T04:56:07.000+00:00"
  },
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "pagination": {
      "offset": 6.027456183070403,
      "limit": 0.8008281904610115,
      "totalCount": 1.4658129805029452
    },
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ]
  }
}