Authentication.md

Passage\Authentication

All URIs are relative to https://api.passage.id/v1, except if the operation defines another base path.

validateJWT()

validateJWT($jwtString): string | null

Validate JWT string

Valid JWT string returns user id.

Laravel Example

<?php
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use PassageIdentity\PassagePHP\Passage\Authentication;

// Authentication using Passage class instance
Route::get('authenticatedRoute', function (Request $request) {
    $passage = new Passage(env('APP_ID'), env('API_KEY'));
    $jwtString = $request->header('psg_auth_token');

    try {
        // Authenticate request using Passage
        $userID = $passage->validateJWT($jwtString);
        if ($userID) {
            // User is authenticated
            $userData = $passage->user->get($userID);
            return;
        }
    } catch (\Exception $e) {
        // Authentication failed
        return "Authentication failed!";
    }
});

Parameters

Name	Type	Description	Notes
jwtString	string	JWT Token

Return type

Name	Type	Description	Notes
userID	string/null	User Id

Errors

Error	Description
Could not verify token: Missing kid in token	The token provided did not contain a kid
Could not verify token: Could not retrieve user id	The token provided did not include a user id
Could not verify token:	General error. Will include a message detailing why the token was not verified

[Back to top] [Back to API list] [Back to README]