API Reference

Get Created Users

Use this API to retrieve all users created by EZiD

Call

curl --request POST \ --url https://api.ezid.io/email-link/getusers \ --header 'Content-Type: application/json' \ --data { client_id: "your_client_id", client_secret: "your_client_secret" }
const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));'); let url = 'https://api.ezid.io/email-link/getusers'; let options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: { client_id:"your_client_id", client_secret:"your_client_secret" } }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));
AttributesDefinition
client_id* Your companies unique ID, provided by EZiD
client_secret* You companies unique secret, provided by EZiD

Responses:

{ users: [ { email: "Jim70@gmail.com", verified_email: "Yes" }, { email: "Bob@gmail.com", verified_email: "Yes" } ] }
{ success: false, reason: "Client is not registered" }
AttributesDefinition
emailThis is the ID token of the user. It is a JWT token that contains their email amongst other details. This should be stored in the front-end of your application, and validated when the user tries to access protected resources
verified_emailA parameter describing whether or not this user's email is verified. Either "Yes" or "No"

📘

Please Note: The users are returned in an array.