Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@arc-publishing/sdk-identity

WPMedia17.2kISC1.94.0TypeScript support: included

JS Identity SDK for working with Identity API

identity, arc, washingtonpost, sdk, typescript

readme

Identity

This SDK is responsible for interacting with the Arc Identity APIs. It will handle managing the JWT, sign-in, sign-out, registration and any other self-service account management functions.

Authentication

  • Properties
    • [[userIdentity]]
  • Methods
    • [[login]]
    • [[initFacebookLogin]]
    • [[facebookSignOn]]
    • [[initGoogleLogin]]
    • [[googleSignOn]]
    • [[requestMagicLink]] soon to be deprecated. Use requestOTALink instead.
    • [[requestOTALink]]
    • [[redeemMagicLink]] soon to be deprecated. Use redeemOTALink instead.
    • [[redeemOTALink]]
    • [[extendSession]]
    • [[logout]]

Profile

  • Properties
    • [[userProfile]]
  • Methods
    • [[signUp]]
    • [[getUserProfile]]
    • [[updateUserProfile]]
    • [[requestVerifyEmail]]
    • [[verifyEmail]]
    • [[requestDeleteAccount]]
    • [[approveDeleteAccount]]
    • [[declineDeleteAccount]]
    • [[uploadAvatar]] _deprecated
    • [[deleteAvatar]] _deprecated

Password Reset

  • Methods
    • [[updatePassword]]
    • [[requestResetPassword]]
    • [[resetPassword]]

Configuration

  • Methods
    • [[getConfig]]
  • Properties
    • [[configOptions]]