Sign in

v1

latestOpenAPI 3.0.0Proprietary - Commercial Use Only2026-08-06172139621.6 KB
Status

Get status of the Black Kite produced access token.

Get the validity of the access token issued.

get/api/v2/status

Response

Success

IsValidboolean required

Whether the access token accompanied by this request is valid (true) or not valid (false).

ClientIdstring nullable

The client id part of the client credential pair used to create the access token.

CanStartScanboolean nullable

Whether the access token can be used to start a scan or not.

CurrentIpstring nullable

The remote IP address triggering this request.

ExpirationDateOfClientCredentialstring date-time nullable

The date time that the client credential will expire. Beware that this is the expiration date of the client credential, NOT the access token.

ExpirationDateOfTokenstring nullable

The date time that the access token will expire. Beware that this is the expiration date of the access token, NOT the client credential that is used to issue the access token.

IpWhiteListstring[] nullable

The list of white listed source IP addresses, if any.

Role'SuperAdmin' | 'EcosystemAdmin' | 'CompanyAdmin' | 'SuperUser' | 'EcosystemUser' | 'CompanyUser' nullable

The role of the client credential that is used to issue the access token.

Example response

{
  "IsValid": true,
  "ClientId": "269d98e4922fb3895e9ae2108cbb5064",
  "CurrentIp": "192.168.1.2",
  "ExpirationDateOfClientCredential": "2021-08-09T08:30:30.682Z",
  "ExpirationDateOfToken": "3/5/2022 09:22:23",
  "IpWhiteList": [
    "192.168.4.5"
  ],
  "Role": "SuperAdmin"
}