Sign Up

Users

GET/users/me
AuthorizationBearer <token>

API Key access

In: header

Response Body

application/json

curl -X GET "https://example.com/users/me"
{  "id": "string",  "name": "string",  "email": "string",  "emailVerified": true,  "pylonEmailHash": "string",  "publicKeys": [    {      "key": "string",      "name": "string"    }  ],  "createdAt": "2019-08-24T14:15:22Z"}
GET/users/account-providers
AuthorizationBearer <token>

API Key access

In: header

Response Body

application/json

curl -X GET "https://example.com/users/account-providers"
[  {    "name": "string",    "displayName": "string"  }]
POST/users/linked-accounts
AuthorizationBearer <token>

API Key access

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/users/linked-accounts" \  -H "Content-Type: application/json" \  -d '{    "provider": "string",    "userId": "string"  }'
Empty
DELETE/users/linked-accounts/{provider}/{providerUserId}
AuthorizationBearer <token>

API Key access

In: header

Path Parameters

provider*string
providerUserId*string

Response Body

curl -X DELETE "https://example.com/users/linked-accounts/string/string"
Empty
POST/users/mfa/sms/enroll
AuthorizationBearer <token>

API Key access

In: header

Response Body

application/json

curl -X POST "https://example.com/users/mfa/sms/enroll"
"string"
GET/users/me/pending-sso-links
AuthorizationBearer <token>

API Key access

In: header

Response Body

application/json

curl -X GET "https://example.com/users/me/pending-sso-links"
[  {    "id": "string",    "idpName": "string",    "organizationId": "string",    "providerEmail": "string",    "createdAt": "string",    "expiresAt": "string"  }]
POST/users/me/pending-sso-links/{id}/confirm
AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Response Body

curl -X POST "https://example.com/users/me/pending-sso-links/string/confirm"
Empty
DELETE/users/me/pending-sso-links/{id}
AuthorizationBearer <token>

API Key access

In: header

Path Parameters

id*string

Response Body

curl -X DELETE "https://example.com/users/me/pending-sso-links/string"
Empty