---
agentTools:
  projectIndex: https://docs.autharmor.com/llms.txt
---

# Validate auth request for Magiclink Email

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Auth Armor - Auth Anywhere API",
    "version": "v4"
  },
  "servers": [
    {
      "url": "https://api.autharmor.com"
    }
  ],
  "paths": {
    "/v4/auth/magiclink_email/validate": {
      "post": {
        "tags": [
          "Auth - MagicLink Email"
        ],
        "summary": "  Validate auth request for Magiclink Email",
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/validate_magiclink_email_auth_request"
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/validate_magiclink_email_auth_request"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/validate_magiclink_email_auth_request"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/validate_magiclink_email_auth_request"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/validate_auth_response"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/validate_auth_response"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/validate_auth_response"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          }
        },
        "security": [
          {
            "oauth2": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "auth_details": {
        "type": "object",
        "properties": {
          "request_details": {
            "$ref": "#/components/schemas/request_details"
          },
          "response_details": {
            "$ref": "#/components/schemas/auth_response_details"
          }
        },
        "additionalProperties": false
      },
      "auth_method_use_type_response": {
        "enum": [
          "biometric",
          "pin",
          "autharmor_pin",
          "u2f_securitykey",
          "u2f_usb",
          "u2f_lightning",
          "u2f_bluetooth",
          "u2f_nfc",
          "fido2_bluetooth",
          "fido2_usb",
          "fido2_lightning",
          "fido2_nfc",
          "fido2",
          "fido2_mobiledevice",
          "fido2_crossplatform",
          "magiclink_email"
        ],
        "type": "string"
      },
      "auth_methods": {
        "enum": [
          "MobileDevice",
          "SecurityKey",
          "AuthArmorAuthenticator",
          "Magiclink_Email",
          "Maigclink_SMS",
          "WebAuthN"
        ],
        "type": "string"
      },
      "auth_profile_details": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "string",
            "format": "uuid"
          },
          "username": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "auth_response_details": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time"
          },
          "auth_method": {
            "$ref": "#/components/schemas/response_auth_method"
          },
          "secure_signed_message": {
            "$ref": "#/components/schemas/secure_signed_message"
          },
          "mobile_device_details": {
            "$ref": "#/components/schemas/mobile_device_details"
          },
          "auth_profile_details": {
            "$ref": "#/components/schemas/auth_profile_details"
          }
        },
        "additionalProperties": false
      },
      "hash_types": {
        "enum": [
          "Sha256"
        ],
        "type": "string"
      },
      "location_data": {
        "type": "object",
        "properties": {
          "latitude": {
            "type": "string",
            "nullable": true
          },
          "longitude": {
            "type": "string",
            "nullable": true
          },
          "ip_address": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "mobile_device_details": {
        "type": "object",
        "properties": {
          "platform": {
            "type": "string",
            "nullable": true
          },
          "model": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "request_details": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time"
          },
          "auth_profile_details": {
            "$ref": "#/components/schemas/auth_profile_details"
          },
          "origin_location_data": {
            "$ref": "#/components/schemas/location_data"
          },
          "auth_method": {
            "$ref": "#/components/schemas/auth_methods"
          }
        },
        "additionalProperties": false
      },
      "response_auth_method": {
        "type": "object",
        "properties": {
          "name": {
            "$ref": "#/components/schemas/auth_methods"
          },
          "usetype": {
            "$ref": "#/components/schemas/auth_method_use_type_response"
          }
        },
        "additionalProperties": false
      },
      "secure_signed_message": {
        "type": "object",
        "properties": {
          "signed_data": {
            "type": "string",
            "nullable": true
          },
          "signature_data": {
            "$ref": "#/components/schemas/signature_data"
          },
          "signed_data_type": {
            "$ref": "#/components/schemas/signed_message_type"
          },
          "signature_validation_details": {
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "signature_data": {
        "type": "object",
        "properties": {
          "hash_value": {
            "type": "string",
            "nullable": true
          },
          "signature_data": {
            "type": "string",
            "nullable": true
          },
          "auth_method_usetype": {
            "$ref": "#/components/schemas/auth_method_use_type_response"
          },
          "signing_method": {
            "$ref": "#/components/schemas/signing_method"
          },
          "auth_method": {
            "$ref": "#/components/schemas/auth_methods"
          },
          "hash_method": {
            "$ref": "#/components/schemas/hash_types"
          }
        },
        "additionalProperties": false
      },
      "signed_message_type": {
        "enum": [
          "AuthResponse"
        ],
        "type": "string"
      },
      "signing_method": {
        "enum": [
          "AuthArmor_ECDsa",
          "FIDO_U2F"
        ],
        "type": "string"
      },
      "validate_auth_response": {
        "type": "object",
        "properties": {
          "auth_request_status_id": {
            "type": "integer",
            "format": "int32"
          },
          "auth_request_status_name": {
            "type": "string",
            "nullable": true
          },
          "validate_auth_response_details": {
            "$ref": "#/components/schemas/validate_auth_response_details"
          }
        },
        "additionalProperties": false
      },
      "validate_auth_response_details": {
        "type": "object",
        "properties": {
          "auth_history_id": {
            "type": "string",
            "format": "uuid"
          },
          "result_code": {
            "type": "integer",
            "format": "int32"
          },
          "result_message": {
            "type": "string",
            "nullable": true
          },
          "authorized": {
            "type": "boolean"
          },
          "auth_details": {
            "$ref": "#/components/schemas/auth_details"
          },
          "context_data": {
            "type": "object",
            "additionalProperties": {
              "type": "string",
              "nullable": true
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "validate_magiclink_email_auth_request": {
        "type": "object",
        "properties": {
          "auth_validation_token": {
            "type": "string",
            "nullable": true
          },
          "auth_request_id": {
            "type": "string",
            "nullable": true
          },
          "ip_address": {
            "type": "string",
            "nullable": true
          },
          "user_agent": {
            "type": "string",
            "nullable": true
          },
          "nonce": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "description": "JWT Authorization header using the Bearer scheme. \\r\\n\\r\\n \n                      Enter 'Bearer' [space] and then your token in the text input below.\n                      \\r\\n\\r\\nExample: 'Bearer 12345abcdef'",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://login.autharmor.com/connect/token",
            "scopes": {
              "aarmor.api.request_auth": "Request Auth",
              "aarmor.api.generate_invite_code": "Generate Invite Code"
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "oauth2": [
        "aarmor.api.request_auth",
        "aarmor.api.generate_invite_code"
      ]
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 54,
      "2": 234,
      "3": 142,
      "4": 246,
      "5": 188,
      "6": 222,
      "7": 0,
      "8": 89,
      "9": 3,
      "10": 138,
      "11": 210
    }
  }
}
```