ENenterpilot
auth

Verify an API key

Changed on

Reports whether the presented credential authenticates against this gateway. Returns 401 when it does not. A gateway with no authentication configured has no credential to confirm and answers 200 with valid=false and method=none. Disabled unless AUTH_VERIFY_ENABLED is set.

get/v1/auth/verify

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/auth/verify
  • Auth
    HTTP bearer

Response

OK

key_idstring

KeyID identifies the managed auth key that authenticated the request. Absent for every other method.

methodstring

Method is "api_key" for a managed key stored in the database, "master_key" for the bootstrap key, an extension-specific value for identities supplied by an authentication extension, or "none" when the request carried no credential this gateway recognizes, which is also when Valid is false.

user_pathstring

UserPath is the subtree the credential is bound to. Absent when the credential is global, which every master-key caller is.

validboolean

Changes