Authentication API

API endpoints that enable you to create and employ such things as authorization codes, access tokens, and verification codes. You can also use this API to register users with or log users on to a website or application, (using either traditional registration/logon or social registration/logon). Note that these are not the authorization endpoints used with Hosted Login. For those endpoints, see the OAuth and OIDC API Reference.

In addition to reference information for each endpoint, this section of the documentation also includes the following two articles:







Access Tokens and Code

EndpointMethods

Get an Authorization Code

/access/getAuthorizationCode
Return an authorization code for the specified user. The authorization code can then be exchanged for an access token.
  • POST

Get an Access Token

/access/getAccessToken
Return an access token for the specified user.
  • POST

Exchange an Authorization Code or a Refresh Token for an Access Token

/oauth/token
Return an access token for the specified user.
  • POST

Complete Social Registration

/oauth/register_native
Create an account that uses a social login identity (e.g., a Facebook or Twitter account) for authentication.
  • POST

Complete Traditional Registration

/oauth/register_native_traditional
Create an account that uses an email address and password for authentication.
  • POST

Complete Social Login

/oauth/auth_native
Complete a social login (that is, logging on by using an account from a social login provider such as Facebook or Twitter).
  • POST

Complete Traditional Login

/oauth/auth_native_traditional
Complete a traditional login (i.e., a login that relies on an email address and password).
  • POST




User Profiles

EndpointMethods

Update a User Profile

/oauth/update_profile_native
Update the specified user profile.
  • POST

Get a Verification Code

/access/getVerificationCode
Return a verification code for the specified user. Verification codes are used with the useVerificationCode endpoint to verify an email address.
  • POST

Use a Verification Code

/access/useVerificationCode
Use a verification code (obtained by using the getVerificationCode endpoint) to verify an email address.
  • POST

Verify an Email Address

/oauth/verify_email_native
Send a "please verify your email address" link to a user.
  • POST

Request a Reset Password Link

/oauth/forgot_password_native
Send a reset password link to the specified user.
  • POST

Link a Social Identity to a User Profile

/oauth/link_account_native
Link a new social identity to an existing user account,
  • POST

Unlink a Social Provider for a User Profile

/oauth/unlink_account_native
Remove a social identity from an existing user account
  • POST