Select the tab
ESET Inspect On-Prem – Table of Contents

PUT Authentication

Relative path: /api/v1/authenticate

Authenticate

Request body

Display Schema instead of an Example or vice-versa

Type

Required

Example

Schema

application/json

Yes

 
{
  "username": "string",
  "password": "string",
  "domain": true
}
 
{
  "$ref": "AuthenticateRequestSchema",
  "description": "Credentials to use for authentication. Set domain to 'true' if this is a domain user",
  "username": {
    "type": "string"
  },
  "password": {
    "type": "string",
    "format": "password"
  },
  "domain": {
    "type": "boolean"
  }
}

Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

OK

OK


Response schema

{
  "$ref": "Authenticate",
  "description": "OK",
  "headers": {
    "X-Security-Token": {
      "$ref": "X-Security-Token",
      "description": "Authentication token",
      "schema": {
        "$ref": "AuthenticateTokenResponse",
        "type": "string",
        "example": "eyJhbGciOi[..]ziJSUGusY5kAI"
      }
    }
  }
}


Headers

{
  "X-Security-Token": {
    "$ref": "X-Security-Token",
    "description": "Authentication token",
    "schema": {
      "$ref": "AuthenticateTokenResponse",
      "type": "string",
      "example": "eyJhbGciOi[..]ziJSUGusY5kAI"
    }
  }
}

401

Credentials or access token missing or invalid


Response example

{
  "error": "string"
}

Credentials or access token missing or invalid


Response schema

{
  "$ref": "UnauthorizedError",
  "error": {
    "type": "string"
  }
}