public interface AuthenticationApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<UserSessionInfo> |
changeApp(SignIn signIn)
Change the app currently associate with the signed in caller's session.
|
retrofit2.Call<GeneratedPassword> |
generatePassword(String externalId,
Boolean createAccount)
Deprecated.
|
retrofit2.Call<AppList> |
getAppMemberships()
Get the list of apps that are accessible to the signed in user via a shared Synapse user ID
Return a summary of all apps that are accessible to the authenticated caller via a shared Synapse user ID.
|
retrofit2.Call<UserSessionInfo> |
reauthenticate(SignIn signIn)
Using the reauthentication token supplied with a new session, request a new session from the server.
|
retrofit2.Call<Message> |
requestEmailSignIn(EmailSignInRequest emailSignInRequest)
Does not require authentication.
|
retrofit2.Call<Message> |
requestPhoneSignIn(PhoneSignInRequest phoneSignInRequest)
Does not require authentication.
|
retrofit2.Call<Message> |
requestResetPassword(SignIn signIn)
Does not require authentication.
|
retrofit2.Call<Message> |
resendEmailVerification(Identifier identifier)
Resend an email to the provided email address asking the address holder to verify their address.
|
retrofit2.Call<Message> |
resendPhoneVerification(Identifier identifier)
Resend an SMS message to the provided phone number asking the recipient to verify their phone number.
|
retrofit2.Call<Message> |
resetPassword(PasswordReset passwordReset)
This API will not normally be called directly by a client.
|
retrofit2.Call<UserSessionInfo> |
signIn(SignIn signIn)
Send user credentials to authenticate with the Bridge server.
|
retrofit2.Call<UserSessionInfo> |
signInV4(SignIn signIn)
Send user credentials to authenticate with the Bridge server.
|
retrofit2.Call<UserSessionInfo> |
signInViaEmail(EmailSignIn emailSignIn)
Does not require authentication.
|
retrofit2.Call<UserSessionInfo> |
signInViaPhone(PhoneSignIn phoneSignIn)
Does not require authentication.
|
retrofit2.Call<UserSessionInfo> |
signInWithOauthToken(OAuthAuthorizationToken oauthAuthorizationToken)
Does not require authentication.
|
retrofit2.Call<Message> |
signOut()
Delete the user's session on the server.
|
retrofit2.Call<Message> |
signUp(SignUp signUp)
If an app uses email addresses to identify account holders, the user will normally be sent an email with a link to verify his or her email address before the account will be activated.
|
retrofit2.Call<Message> |
verifyEmail(Verification verification)
An email will be sent to the user with a link that when opened, will confirm the validity of this email address.
|
retrofit2.Call<Message> |
verifyPhone(Verification verification)
Using the sptoken extracted from a link in an SMS message, or entered by the user as seen in an SMS message, call this method to confirm the validity of the phone number.
|
@Headers(value="Content-Type:application/json") @POST(value="v3/auth/app") retrofit2.Call<UserSessionInfo> changeApp(@Body SignIn signIn)
signIn
- Sign in information (appId only) (required)@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v3/externalids/{externalId}/password") retrofit2.Call<GeneratedPassword> generatePassword(@Path(value="externalId") String externalId, @Query(value="createAccount") Boolean createAccount)
externalId
- User's external ID (required)createAccount
- If account has not been created for this external ID, create it (optional, default to true)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/memberships") retrofit2.Call<AppList> getAppMemberships()
@Headers(value="Content-Type:application/json") @POST(value="v3/auth/reauth") retrofit2.Call<UserSessionInfo> reauthenticate(@Body SignIn signIn)
signIn
- Information to authenticate with the server (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/email") retrofit2.Call<Message> requestEmailSignIn(@Body EmailSignInRequest emailSignInRequest)
emailSignInRequest
- Information to trigger an email for sign in. (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/phone") retrofit2.Call<Message> requestPhoneSignIn(@Body PhoneSignInRequest phoneSignInRequest)
phoneSignInRequest
- Information to trigger an SMS message for sign in. (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/requestResetPassword") retrofit2.Call<Message> requestResetPassword(@Body SignIn signIn)
signIn
- Email or phone information information (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/resendEmailVerification") retrofit2.Call<Message> resendEmailVerification(@Body Identifier identifier)
identifier
- Email address of participant (phone number is ignored). (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/resendPhoneVerification") retrofit2.Call<Message> resendPhoneVerification(@Body Identifier identifier)
identifier
- Phone number of participant (email address is ignored). (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/resetPassword") retrofit2.Call<Message> resetPassword(@Body PasswordReset passwordReset)
passwordReset
- Password reset token (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/signIn") retrofit2.Call<UserSessionInfo> signIn(@Body SignIn signIn)
signIn
- Sign in information (required)@Headers(value="Content-Type:application/json") @POST(value="v4/auth/signIn") retrofit2.Call<UserSessionInfo> signInV4(@Body SignIn signIn)
signIn
- Sign in information (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/email/signIn") retrofit2.Call<UserSessionInfo> signInViaEmail(@Body EmailSignIn emailSignIn)
emailSignIn
- Information to authenticate with the server (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/phone/signIn") retrofit2.Call<UserSessionInfo> signInViaPhone(@Body PhoneSignIn phoneSignIn)
phoneSignIn
- Information to authenticate with the server (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/oauth/signIn") retrofit2.Call<UserSessionInfo> signInWithOauthToken(@Body OAuthAuthorizationToken oauthAuthorizationToken)
oauthAuthorizationToken
- The authorization token sent from an OAuth server, used to sign in. (required)@Headers(value="Content-Type:application/json") @POST(value="v4/auth/signOut") retrofit2.Call<Message> signOut()
@Headers(value="Content-Type:application/json") @POST(value="v3/auth/signUp") retrofit2.Call<Message> signUp(@Body SignUp signUp)
signUp
- Sign up information (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/verifyEmail") retrofit2.Call<Message> verifyEmail(@Body Verification verification)
verification
- verification token (required)@Headers(value="Content-Type:application/json") @POST(value="v3/auth/verifyPhone") retrofit2.Call<Message> verifyPhone(@Body Verification verification)
verification
- verification token (required)Copyright © 2023 Sage Bionetworks. All rights reserved.