Skip to main content
POST
/
v1
/
auth
/
api-key
/
validate
CreateAPIKeyReq
curl --request POST \
  --url https://api.endorlabs.com/v1/auth/api-key/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "secret": "<string>",
  "issuing_user": {
    "meta": {
      "name": "<string>",
      "annotations": {},
      "description": "<string>",
      "index_data": {},
      "parent_kind": "<string>",
      "parent_uuid": "<string>",
      "tags": [
        "<string>"
      ]
    },
    "spec": {
      "email": "<string>",
      "event_tracking": {},
      "first_name": "<string>",
      "groups": [
        "<string>"
      ],
      "last_name": "<string>",
      "token_hash": "<string>"
    }
  }
}
'
{
  "key": "<string>",
  "secret": "<string>",
  "issuing_user": {
    "meta": {
      "name": "<string>",
      "annotations": {},
      "create_time": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "description": "<string>",
      "index_data": {
        "data": [
          "<string>"
        ],
        "search_score": 123,
        "tenant": "<string>",
        "will_be_deleted_at": "2023-11-07T05:31:56Z"
      },
      "kind": "<string>",
      "parent_kind": "<string>",
      "parent_uuid": "<string>",
      "references": {},
      "tags": [
        "<string>"
      ],
      "update_time": "2023-11-07T05:31:56Z",
      "updated_by": "<string>",
      "upsert_time": "2023-11-07T05:31:56Z",
      "version": "<string>"
    },
    "spec": {
      "email": "<string>",
      "event_tracking": {},
      "first_name": "<string>",
      "groups": [
        "<string>"
      ],
      "last_login_time": "2023-11-07T05:31:56Z",
      "last_name": "<string>",
      "token_hash": "<string>",
      "user_name": "<string>"
    },
    "uuid": "<string>"
  },
  "valid": true
}

Body

application/json

Validates an API key.

Validates an API key.

key
string
required

The unique identifier of the API key.

secret
string
required

The secret associated with the provided API Key.

issuing_user
object

User represents a user in the system.

Mostly includes configuration parameters that are user wise.

Response

A successful response.

Validates an API key.

key
string
required

The unique identifier of the API key.

secret
string
required

The secret associated with the provided API Key.

issuing_user
object

User represents a user in the system.

Mostly includes configuration parameters that are user wise.

valid
boolean

Valid returns if the API key and secret pair are valid.