Cancel Or Expire An API Key

Title

Cancel or expire an API key

URL Path

vault_rest/authenticate

Method

DELETE

CORS support

Yes

Http return

200, 400, 401, 403, 500

Table of Contents

Last Updated

08 Oct 2019

Use Cases (used by)

Used by the user interface when the user logs out.

HTTP header parameters

Name

Value

Required

Description

Example

Authorization

The API key you wish to expire/cancel or delete

REQUIRED

This header should have the following format:
Bearer [API key obtained from the authenticate API]
Example: Bearer Cp01BwnXAIOLZXxn7yogjKqIZnZpQD

DELETE /vault_rest/authenticate HTTP/1.1
Host: localhost:8010
Authorization: Bearer OrRnBd9J0AzTiUe4Xrevj6IUoHbdMs

Request Error

400

Bad Request

Invalid HTTP request

401

Invalid parameter

One or more parameters are invalid

403

Forbidden

API Key is incorrect

500

Internal Server Error

Server is temporarily unavailable

Example of a successful request:

"token" : "apikey"
}