TOTP

API for creating and deleting Time-based One-Time Password or TOTP.

TOTP are used to generate unique, temporary passwords as an added layer of protection when accessing sensitive keys or credentials from Nitride.

There are 2 API operations available for TOTP:

1. PUT - Create a new TOTP

2. DELETE - Delete an existing TOTP

Create a new TOTP

PUT /v1/auth/ratls/totp

If the auth engine is enabled at a different path use /v1/auth/<your-path>/totp

Headers

Name	Value	Required
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description	Required
created	integer (int64)	Creation timestamp, generated by the Nitride plugin
expiration	integer (int64)	Expiration timestamp of the TOTP
policy	string	Name of the policy to allow updates for
uuid	string	Identifier for the totp and the token itself, generated by the Nitride plugin.

Request samples

Javascript

const response = await fetch('/v1/auth/ratls/totp', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "created": 0,
      "expiration": 0,
      "policy": "text",
      "uuid": "text"
    }),
});
const data = await response.json();

cURL

curl -L \
  -X PUT \
  -H 'Content-Type: application/json' \
  '/v1/auth/ratls/totp' \
  -d '{"created":0,"expiration":0,"policy":"text","uuid":"text"}'

Python

import requests

response = requests.put(
    "/v1/auth/ratls/totp",
    headers={"Content-Type":"application/json"},
    json={"created":0,"expiration":0,"policy":"text","uuid":"text"}
)
data = response.json()

HTTP

PUT /v1/auth/ratls/totp HTTP/1.1
Host: 
Content-Type: application/json
Content-Length: 58
Accept: */*

{
  "created": 0,
  "expiration": 0,
  "policy": "text",
  "uuid": "text"
}

Response samples

200

{
  "data": {
    "created": 0,
    "expiration": 0,
    "policy": "text",
    "uuid": "text"
  }
}

400

{

  "statusCode": 400,

  "message": "Invalid request"

}

---

Deleting an existing TOTP

DELETE/v1/auth/ratls/totp/{totp-uuid}

If the auth engine is enabled at a different path use /v1/auth/<your-path>/totp/{totp-uuid}

Headers

Name	Value	Required
Authorization	Bearer <token>

Path parameters

Name	Type	Description	Required
totp-uuid	string	Identifier for the TOTP and the token itself, generated by the Nitride plugin.

Request samples

Javascript

const response = await fetch('/v1/auth/ratls/totp/{totp-uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

cURL

curl -L \
  -X DELETE \
  '/v1/auth/ratls/totp/{totp-uuid}'

Python

import requests

response = requests.delete(
    "/v1/auth/ratls/totp/{totp-uuid}",
    headers={},
)
data = response.json()

HTTP

DELETE /v1/auth/ratls/totp/{totp-uuid} HTTP/1.1
Host: 
Accept: */*

Response samples

200

OK

400

{

  "statusCode": 400,

  "message": "Invalid request parameters: 'uuid' is required and must be a string.",

  "errors": {

    "uuid": "Missing required field"

  }

}