Users
AuthorizationBearer <token>API Key access
User details
application/json- response
id*stringUser ID
name*stringUser name
email*stringUser email
emailVerified*booleanWhether the user email address has been verified
pylonEmailHash?stringHMAC of the user email for Pylon support-widget identity verification
privacyPoliciesAccepted?booleanWhether the user has accepted the current privacy policies. Populated on the /users/me endpoint.
publicKeys*array<>User public keys
createdAt*stringCreation timestamp
date-timecurl -X GET 'http://localhost:3000/users/me'{ "emailVerified": true, "createdAt": "2000-01-23T04:56:07.000+00:00", "publicKeys": [ { "name": "name", "key": "key" }, { "name": "name", "key": "key" } ], "pylonEmailHash": "pylonEmailHash", "name": "name", "id": "id", "email": "email", "privacyPoliciesAccepted": true}Called by the dashboard once per completed sign-in. The email access gate evaluates the user and reports the login to analytics; a refused user receives 403 with code EMAIL_ACCESS_DENIED.
AuthorizationBearer <token>API Key access
Login recorded
curl -X POST 'http://localhost:3000/users/me/logins'AuthorizationBearer <token>API Key access
Privacy policies accepted
curl -X POST 'http://localhost:3000/users/privacy-policies/accept'Social sign-in providers (Google, GitHub, ...) enabled for this environment, each flagged with whether the authenticated user has an identity linked through it.
AuthorizationBearer <token>API Key access
Account providers
application/json- response
[index: integer]?curl -X GET 'http://localhost:3000/users/account-providers'[ { "provider": "provider", "displayName": "displayName", "linked": true }]Link account (withdrawn)
DeprecatedWithdrawn. This operation is no longer supported and always responds 410.
AuthorizationBearer <token>API Key access
application/json- body
provider*stringThe authentication provider of the secondary account
userId*stringThe user ID of the secondary account
Account linking is no longer supported
curl -X POST 'http://localhost:3000/users/linked-accounts' \ -H 'Content-Type: application/json' \ -d '{ "provider": "provider", "userId": "userId"}'AuthorizationBearer <token>API Key access
Pending SSO account links
application/json- response
[index: integer]?curl -X GET 'http://localhost:3000/users/me/pending-sso-links'[ { "organizationId": "organizationId", "createdAt": "createdAt", "idpName": "idpName", "id": "id", "providerEmail": "providerEmail", "expiresAt": "expiresAt" }]AuthorizationBearer <token>API Key access
id*stringSSO identity linked
curl -X POST 'http://localhost:3000/users/me/pending-sso-links/string/confirm'AuthorizationBearer <token>API Key access
id*stringPending SSO link dismissed
curl -X DELETE 'http://localhost:3000/users/me/pending-sso-links/string'