Axinom Mosaic Libraries
Axinom Portal
Preparing search index...
@axinom/mosaic-user-auth
internal
IUserServiceClient
Interface IUserServiceClient
interface
IUserServiceClient
{
addTokenChangedHandler
(
callback
:
TokenChangedCallback
)
:
void
;
authenticateEndUserApplication
(
authenticateEndUserApplicationRequest
:
AuthenticateEndUserApplicationInput
,
)
:
Promise
<
AuthenticateEndUserApplicationResponse
>
;
checkResetPasswordOTP
(
checkPasswordResetOtpRequest
:
CheckEndUserPasswordResetOtpInput
,
)
:
Promise
<
CheckPasswordResetOtpResponse
>
;
checkUserSignUpOTP
(
checkUserSignUpOtpRequest
:
CheckEndUserSignUpOtpInput
,
)
:
Promise
<
CheckUserSignUpOtpResponse
>
;
completeResetPassword
(
completePasswordResetRequest
:
CompleteEndUserPasswordResetInput
,
)
:
Promise
<
CompletePasswordResetResponse
>
;
completeUserSignUp
(
completeUserSignUpRequest
:
CompleteEndUserSignUpInput
,
)
:
Promise
<
CompleteUserSignUpResponse
>
;
createUserProfile
(
endUserAccessToken
:
string
,
displayName
:
string
,
profilePictureUrl
?:
string
,
)
:
Promise
<
UserProfileCreateResponse
>
;
decryptNativeCookie
(
encryptedCookie
:
string
,
key
:
string
,
)
:
Promise
<
DecryptNativeCookieResponse
>
;
deleteUserProfile
(
endUserAccessToken
:
string
,
userProfileId
:
string
,
)
:
Promise
<
UserProfileDeleteResponse
>
;
getAuthUrl
(
idpConnectionId
:
string
,
redirectUrl
:
string
)
:
URL
;
getIdpConfigurations
()
:
Promise
<
IdpConfiguration
[]
>
;
getNativeAuthUrl
(
idpConnectionId
:
string
,
redirectUri
:
string
,
encryptionKey
:
string
,
)
:
URL
;
getToken
()
:
Promise
<
TokenResponse
>
;
getUserProfile
(
endUserAccessToken
:
string
,
profileId
:
string
,
)
:
Promise
<
UserProfileResponse
>
;
getUserProfiles
(
endUserAccessToken
:
string
)
:
Promise
<
UserProfilesResponse
>
;
initiateResetPassword
(
email
:
string
,
customData
?:
Record
<
string
,
unknown
>
,
)
:
Promise
<
InitiatePasswordResetResponse
>
;
initiateUserSignUp
(
userSignUpRequest
:
Omit
<
InitiateEndUserSignUpInput
,
"oAuthClientId"
>
,
)
:
Promise
<
UserSignUpResponse
>
;
isDirectSignInConfigured
()
:
Promise
<
boolean
>
;
logoutUser
()
:
Promise
<
boolean
>
;
removeTokenChangedHandler
(
callback
:
TokenChangedCallback
)
:
void
;
setActiveProfile
(
endUserAccessToken
:
string
,
profileId
:
string
,
)
:
Promise
<
UserProfileActivateResponse
>
;
signInWithCredentials
(
signInRequest
:
SignInRequest
,
)
:
Promise
<
SignInResponse
>
;
updateUserProfile
(
endUserAccessToken
:
string
,
userProfileToUpdate
:
UserProfileUpdateInput
,
)
:
Promise
<
UserProfileUpdateResponse
>
;
}
Index
Methods
add
Token
Changed
Handler
authenticate
End
User
Application
check
Reset
Password
OTP
check
User
Sign
Up
OTP
complete
Reset
Password
complete
User
Sign
Up
create
User
Profile
decrypt
Native
Cookie
delete
User
Profile
get
Auth
Url
get
Idp
Configurations
get
Native
Auth
Url
get
Token
get
User
Profile
get
User
Profiles
initiate
Reset
Password
initiate
User
Sign
Up
is
Direct
Sign
In
Configured
logout
User
remove
Token
Changed
Handler
set
Active
Profile
sign
In
With
Credentials
update
User
Profile
Methods
add
Token
Changed
Handler
addTokenChangedHandler
(
callback
:
TokenChangedCallback
)
:
void
Parameters
callback
:
TokenChangedCallback
Returns
void
authenticate
End
User
Application
authenticateEndUserApplication
(
authenticateEndUserApplicationRequest
:
AuthenticateEndUserApplicationInput
,
)
:
Promise
<
AuthenticateEndUserApplicationResponse
>
Parameters
authenticateEndUserApplicationRequest
:
AuthenticateEndUserApplicationInput
Returns
Promise
<
AuthenticateEndUserApplicationResponse
>
check
Reset
Password
OTP
checkResetPasswordOTP
(
checkPasswordResetOtpRequest
:
CheckEndUserPasswordResetOtpInput
,
)
:
Promise
<
CheckPasswordResetOtpResponse
>
Parameters
checkPasswordResetOtpRequest
:
CheckEndUserPasswordResetOtpInput
Returns
Promise
<
CheckPasswordResetOtpResponse
>
check
User
Sign
Up
OTP
checkUserSignUpOTP
(
checkUserSignUpOtpRequest
:
CheckEndUserSignUpOtpInput
,
)
:
Promise
<
CheckUserSignUpOtpResponse
>
Parameters
checkUserSignUpOtpRequest
:
CheckEndUserSignUpOtpInput
Returns
Promise
<
CheckUserSignUpOtpResponse
>
complete
Reset
Password
completeResetPassword
(
completePasswordResetRequest
:
CompleteEndUserPasswordResetInput
,
)
:
Promise
<
CompletePasswordResetResponse
>
Parameters
completePasswordResetRequest
:
CompleteEndUserPasswordResetInput
Returns
Promise
<
CompletePasswordResetResponse
>
complete
User
Sign
Up
completeUserSignUp
(
completeUserSignUpRequest
:
CompleteEndUserSignUpInput
,
)
:
Promise
<
CompleteUserSignUpResponse
>
Parameters
completeUserSignUpRequest
:
CompleteEndUserSignUpInput
Returns
Promise
<
CompleteUserSignUpResponse
>
create
User
Profile
createUserProfile
(
endUserAccessToken
:
string
,
displayName
:
string
,
profilePictureUrl
?:
string
,
)
:
Promise
<
UserProfileCreateResponse
>
Parameters
endUserAccessToken
:
string
displayName
:
string
Optional
profilePictureUrl
:
string
Returns
Promise
<
UserProfileCreateResponse
>
decrypt
Native
Cookie
decryptNativeCookie
(
encryptedCookie
:
string
,
key
:
string
,
)
:
Promise
<
DecryptNativeCookieResponse
>
Parameters
encryptedCookie
:
string
key
:
string
Returns
Promise
<
DecryptNativeCookieResponse
>
delete
User
Profile
deleteUserProfile
(
endUserAccessToken
:
string
,
userProfileId
:
string
,
)
:
Promise
<
UserProfileDeleteResponse
>
Parameters
endUserAccessToken
:
string
userProfileId
:
string
Returns
Promise
<
UserProfileDeleteResponse
>
get
Auth
Url
getAuthUrl
(
idpConnectionId
:
string
,
redirectUrl
:
string
)
:
URL
Parameters
idpConnectionId
:
string
redirectUrl
:
string
Returns
URL
get
Idp
Configurations
getIdpConfigurations
()
:
Promise
<
IdpConfiguration
[]
>
Returns
Promise
<
IdpConfiguration
[]
>
get
Native
Auth
Url
getNativeAuthUrl
(
idpConnectionId
:
string
,
redirectUri
:
string
,
encryptionKey
:
string
,
)
:
URL
Parameters
idpConnectionId
:
string
redirectUri
:
string
encryptionKey
:
string
Returns
URL
get
Token
getToken
()
:
Promise
<
TokenResponse
>
Returns
Promise
<
TokenResponse
>
get
User
Profile
getUserProfile
(
endUserAccessToken
:
string
,
profileId
:
string
,
)
:
Promise
<
UserProfileResponse
>
Parameters
endUserAccessToken
:
string
profileId
:
string
Returns
Promise
<
UserProfileResponse
>
get
User
Profiles
getUserProfiles
(
endUserAccessToken
:
string
)
:
Promise
<
UserProfilesResponse
>
Parameters
endUserAccessToken
:
string
Returns
Promise
<
UserProfilesResponse
>
initiate
Reset
Password
initiateResetPassword
(
email
:
string
,
customData
?:
Record
<
string
,
unknown
>
,
)
:
Promise
<
InitiatePasswordResetResponse
>
Parameters
email
:
string
Optional
customData
:
Record
<
string
,
unknown
>
Returns
Promise
<
InitiatePasswordResetResponse
>
initiate
User
Sign
Up
initiateUserSignUp
(
userSignUpRequest
:
Omit
<
InitiateEndUserSignUpInput
,
"oAuthClientId"
>
,
)
:
Promise
<
UserSignUpResponse
>
Parameters
userSignUpRequest
:
Omit
<
InitiateEndUserSignUpInput
,
"oAuthClientId"
>
Returns
Promise
<
UserSignUpResponse
>
is
Direct
Sign
In
Configured
isDirectSignInConfigured
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
logout
User
logoutUser
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
remove
Token
Changed
Handler
removeTokenChangedHandler
(
callback
:
TokenChangedCallback
)
:
void
Parameters
callback
:
TokenChangedCallback
Returns
void
set
Active
Profile
setActiveProfile
(
endUserAccessToken
:
string
,
profileId
:
string
,
)
:
Promise
<
UserProfileActivateResponse
>
Parameters
endUserAccessToken
:
string
profileId
:
string
Returns
Promise
<
UserProfileActivateResponse
>
sign
In
With
Credentials
signInWithCredentials
(
signInRequest
:
SignInRequest
)
:
Promise
<
SignInResponse
>
Parameters
signInRequest
:
SignInRequest
Returns
Promise
<
SignInResponse
>
update
User
Profile
updateUserProfile
(
endUserAccessToken
:
string
,
userProfileToUpdate
:
UserProfileUpdateInput
,
)
:
Promise
<
UserProfileUpdateResponse
>
Parameters
endUserAccessToken
:
string
userProfileToUpdate
:
UserProfileUpdateInput
Returns
Promise
<
UserProfileUpdateResponse
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
Token
Changed
Handler
authenticate
End
User
Application
check
Reset
Password
OTP
check
User
Sign
Up
OTP
complete
Reset
Password
complete
User
Sign
Up
create
User
Profile
decrypt
Native
Cookie
delete
User
Profile
get
Auth
Url
get
Idp
Configurations
get
Native
Auth
Url
get
Token
get
User
Profile
get
User
Profiles
initiate
Reset
Password
initiate
User
Sign
Up
is
Direct
Sign
In
Configured
logout
User
remove
Token
Changed
Handler
set
Active
Profile
sign
In
With
Credentials
update
User
Profile
Axinom Portal
Axinom Mosaic Libraries
Loading...