Disable account auth key

DELETE 
/account/auth-keys/:id

Disables an auth key of the authenticated account. Requests signed with a disabled key fail with Disabled authorisation key.

You cannot disable the last active key of an account that has no secret, because the account would be locked.

Requires authentication: sign the request (see Authentication) or send the legacy x-sideshift-secret header.

Request

Path Parameters

id stringrequired

The auth key id, from GET /v2/account/auth-keys.

Header Parameters

x-sideshift-key string

Your Ed25519 public key, hex encoded. Required when signing the request. See Authentication.

x-sideshift-timestamp string

Current Unix time in milliseconds, the same value used in the signed message. Must be within 60 seconds of server time. Required when signing the request.

x-sideshift-signature string

Ed25519 signature of timestamp + METHOD + path + body, hex encoded. Required when signing the request. See Authentication.

x-sideshift-secret string

Legacy account secret. Not needed when the request is signed with the x-sideshift-key, x-sideshift-timestamp and x-sideshift-signature headers. See Authentication.

Responses

204

Auth key disabled

400

Bad request - the key is the account's only credential

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired

Example

{
  "error": {
      "message": "Cannot disable the only auth key of an account without a secret",
      "code": "BAD_USER_INPUT"
  }
}

403

Forbidden - authentication required

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired

Example

{
  "error": {
      "message": "Authentication required: sign the request or send the x-sideshift-secret header",
      "code": "FORBIDDEN"
  }
}

404

Active auth key not found

application/json

Schema

Schema

error object
messagestringrequired
codestringrequired

Example

{
  "error": {
      "message": "Not found",
      "code": "NOT_FOUND"
  }
}