Authenticate Client

Authenticate Client
Authenticate a client with the vTIS (vDefend Threat Intelligence service) authentication service

Authenticate a client using client_id and client_secret obtained from registration. Returns an access token that can be used for subsequent API calls.

The access token includes scope information indicating which APIs the client can access.

Request
URI
POST
https://{api_host}/1.0/auth/authenticate
COPY
Request Body

Authentication request body. Contains client credentials (client_id and client_secret).

AuthenticationRequest of type(s) application/json
Required   
{
    "client_id": "string",
    "client_secret": "string"
}
string
client_id
Required  

Client identifier obtained from registration.

string
client_secret
Required  

Client secret obtained from registration.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AuthenticationResponse of type(s) application/json 
{
    "access_token": "string",
    "token_type": "string",
    "expires_in": 0,
    "scope": "string"
}
string
access_token
Required  

JWT access token for API authentication. This token should be included in the Authorization header for subsequent API calls.

string
token_type
Required  

Type of token (typically "Bearer").

integer As int32 As int32
expires_in
Required  

Token expiration time in seconds.

string
scope
Optional

Comma-separated list of scopes granted to the client, indicating which APIs the client can access.


default

Error Response

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "error_message": "string"
}
integer As int32 As int32
error_code
Required  

HTTP Status or Application error code.

Error Code Ranges:

  • 100000: Unknown/Internal errors
  • 100001-100025: General validation errors
  • 100101-100150: Re-registration errors (same clientId)
  • 100151-100200: Re-registration errors (new clientId)
  • 100201-100202: License-related errors
string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"client_id":"string","client_secret":"string"}' https://{api_host}/1.0/auth/authenticate
On This Page
Authentication Operations
POST
Authenticate Client