Methods

The Headless Auth SDK is composed of the following methods:

getMemberAPITokenFromCommunityMemberId

getMemberAPITokenFromEmail

getMemberAPITokenFromSSOId

getMemberAPITokenFromRefreshToken

revokeRefreshToken

revokeMemberAPIToken

getMemberAPITokenFromCommunityMemberId

This function obtains a member access_token and refresh_token based on the community member's ID.

Request

const response = await client.getMemberAPITokenFromCommunityMemberId(MemberID);

Accepted parameters

memberID - The Community Member ID. Required

Response


getMemberAPITokenFromEmail

This function obtains a member access_token and refresh_token based on the community member's Email.

Request

Accepted parameters

email - The Community Member Email. Required

Response


getMemberAPITokenFromSSOId

This function obtains a member access_token and refresh_token based on the member's SSO (Single Sign-On) ID.

Request

Accepted parameters

SSOID - The member ID that matches the one in your SSO. Required

Response


getMemberAPITokenFromRefreshToken

This function obtains a new member access_token by providing the member's refresh_token. A new token can be generated once the current one is expired.

Request

Accepted parameters

refreshToken - the refresh token received from getMemberAPITokenFromSSOId. Required

Response


revokeRefreshToken

Revokes a member's refresh_token, making it unusable for generating new access_token.

Request

Accepted parameters

refreshToken - the refresh token to be revoked. Required

Response

on a successful request

on a failed request


revokeMemberAPIToken

Revokes a member's access_token, making it unusable for future authenticated requests.

Request

Accepted parameters

accessToken - the member access token to be revoked. Required

Response

on a successful request

on a failed request

Last updated