Key Pairs

Table of Content:

• Create key pair
• Check key pair
• Delete key pair
• Get key pairs
• Verify key pair

Create a key pair

This API endpoint creates a new API key pair and returns the key, secret, and verification code ID.

Endpoint: https://intelligence.threatwinds.com/api/auth/v2/keypair

Parameters

Parameter	Location	Type	Required	Description	Example
Authorization	header	string	Yes	This Authorization header can be obtained from an active session of the account. Please ensure that the session is active before attempting to retrieve the authorization header for the request.
name	body	string	Yes	A descriptive name for the key pair to help you identify it later.	“My Application Key”
days	body	integer	Yes	The number of days until the key pair expires.	365

To create a key pair, use a POST request, for example:

curl -X 'POST' \
  'https://intelligence.threatwinds.com/api/auth/v2/keypair' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer fq6JoEFTsxiXAl1cVdPDnK4emIQCwaUBfq9JoEFTsxhXAl1cVxPDnK4emIQCwaUB' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example",
  "days": 365
}'

Returns

A successful response will return a JSON object containing the API key, API secret, key ID, and verification code ID:

{
  "apiKey": "fq6JoEFTsxiXAl1cVxPDnK4emIQCwaUB",
  "apiSecret": "fq6JoEFTsxiXAl1cVxPDnK4emIQCwaUBfq6JoEFTsxiXAl1cVxPDnK4emIQCwaUB",
  "keyID": "5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e",
  "keyName": "Example",
  "expireAt": 1674492894,
  "verified": false,
  "verificationCodeID": "5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e"
}

Important: Store the API secret securely. It will not be displayed again.

Check a key pair

This API endpoint checks a key pair and returns its privileges.

Endpoint: https://intelligence.threatwinds.com/api/auth/v2/keypair

Parameters

Parameter	Location	Type	Required	Description
api-key	header	string	Yes	Your API key.
api-secret	header	string	Yes	Your API secret.

To check a key pair, use a GET request, for example:

curl -X 'GET' \
  'https://intelligence.threatwinds.com/api/auth/v2/keypair' \
  -H 'accept: application/json' \
  -H 'api-key: fq6JoEFTsxiXAl1cVxPDnK4emIQCwaUB' \
  -H 'api-secret: fq6JoEFTsxiXAl1cVxPDnK4emIQCwaUBfq6JoEFTsxiXAl1cVxPDnK4emIQCwaUB'

Returns

A successful response will return a JSON object containing information about the key pair and its associated privileges:

{
  "apiKey": "fq6JoEFTsxiXAl1cVxPDnK4emIQCwaUB",
  "keyID": "5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e",
  "keyName": "Example",
  "expireAt": 1674492894,
  "verified": true,
  "userID": "5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e",
  "userName": "John Doe",
  "userAlias": "johny",
  "roles": ["user", "admin"],
  "groups": ["public"]
}

Delete a key pair

This API endpoint deletes a key pair.

Endpoint: https://intelligence.threatwinds.com/api/auth/v2/keypair/{id}

Parameters

Parameter	Location	Type	Required	Description	Example
Authorization	header	string	Yes	This authorization header can be obtained from an active session of the account.
id	path	string	Yes	The ID of the key pair to delete.	5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e

To delete a key pair, use a DELETE request, for example:

curl -X 'DELETE' \
  'https://intelligence.threatwinds.com/api/auth/v2/keypair/5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer fq6JoEFTsxiXAl1cVdPDnK4emIQCwaUBfq9JoEFTsxhXAl1cVxPDnK4emIQCwaUB'

Returns

A successful response will return a JSON object with a success message:

{
  "message": "acknowledged"
}

Get key pairs

This API endpoint gets all key pairs for the current user.

Endpoint: https://intelligence.threatwinds.com/api/auth/v2/keypairs

Parameters

Parameter	Location	Type	Required	Description
Authorization	header	string	Yes	This authorization header can be obtained from an active session of the account.

To get all key pairs, use a GET request, for example:

curl -X 'GET' \
  'https://intelligence.threatwinds.com/api/auth/v2/keypairs' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer fq6JoEFTsxiXAl1cVdPDnK4emIQCwaUBfq9JoEFTsxhXAl1cVxPDnK4emIQCwaUB'

Returns

A successful response will return a JSON object containing an array of key pairs:

{
  "keys": [
    {
      "apiKey": "fq6JoEFTsxiXAl1cVxPDnK4emIQCwaUB",
      "keyID": "5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e",
      "keyName": "Example",
      "expireAt": 1674492894,
      "verified": true
    },
    {
      "apiKey": "aB7cD8eFgH9iJ0kL1mN2oP3qR4sT5uV6",
      "keyID": "6a2b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p",
      "keyName": "Another Key",
      "expireAt": 1689492894,
      "verified": false
    }
  ]
}

Verify key pair

This API endpoint verifies a key pair using a verification code.

Endpoint: https://intelligence.threatwinds.com/api/auth/v2/keypair/verification

Parameters

Parameter	Location	Type	Required	Description	Example
Authorization	header	string	Yes	This authorization header can be obtained from an active session of the account.
verificationCodeID	body	string	Yes	The verification code ID received when creating the key pair.	“5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e”
code	body	string	Yes	The verification code sent to your email.	“654321”

To verify a key pair, use a PUT request, for example:

curl -X 'PUT' \
  'https://intelligence.threatwinds.com/api/auth/v2/keypair/verification' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer fq6JoEFTsxiXAl1cVdPDnK4emIQCwaUBfq9JoEFTsxhXAl1cVxPDnK4emIQCwaUB' \
  -H 'Content-Type: application/json' \
  -d '{
  "verificationCodeID": "5f35d2c4-5633-4b16-bbf0-5ca22ef8ea2e",
  "code": "654321"
}'

Returns

A successful response will return a JSON object with a success message:

{
  "message": "acknowledged"
}

Error Response Headers

For responses with status codes other than 200 and 202, the following headers are included:

Header	Description
x-error	Contains a description of the error that occurred
x-error-id	Contains a unique identifier for the error for support

Error Codes

Status Code	Description	Possible Cause
400	Bad Request	Invalid request parameters or malformed JSON
401	Unauthorized	Missing or invalid authentication credentials
403	Forbidden	Authenticated user lacks permission for this operation
404	Not Found	The requested resource does not exist
500	Internal Server Error	Server-side error; please contact support if persistent