Note

Do not use the fake-authentication in production. Instead, please consult the guide on user management.

All URLs are relative to https://fakeauth.tanker.io. The API is in JSON (query parameters and response body)

Get identity

Returns the private identity associated with the provided email. It is guaranteed that this function will always return the same private identity given an email. If public_identities is called before private_identity for a given email, the private identity also contains a provisional identity.

Method Path
GET /apps/:app_id/private_identity
Path parameters Description
app_id The ID of your app in urlsafe base64 format
Query parameters Description
email url-encoded email for which to get the corresponding identity
Response body field Description
private_permanent_identity The private identity of a user. Needed to start a Tanker session
private_provisional_identity? The provisional identity of the user (if there is one) (optional)

Get disposable identity

Generates a disposable identity.

Method Path
GET /apps/:app_id/disposable_private_identity
Path parameters Description
app_id The ID of your app in urlsafe base64 format
Response body field Description
private_permanent_identity A disposable Tanker identity

Get public identities

Returns an array of public identities from an array of emails.

Method Path
GET /apps/:app_id/public_identities
Path parameters Description
app_id The ID of your app in urlsafe base64 format
Query parameters Description
emails comma-separated url-encoded email list
emails=<url-encoded-email>[,<url-encoded-email>]*

It returns an array of users:

Response body field Description
email Email of a user
public_identity Their public identity

Set an identity as registered

Notifies the fake authentication server that an identity has been registered.

Method Path
PUT /apps/:app_id/private_identity
Path parameters Description
app_id The ID of your app in urlsafe base64 format
Query parameters Description
email email corresponding to the identity to notify as registered