public interface AccountsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<IdentifierHolder> |
createAccount(Account account)
Create an administrative account
|
retrofit2.Call<Message> |
deleteAccount(String userId)
Delete an administrative account
|
retrofit2.Call<Account> |
getAccount(String userId)
Get an administrative account
|
retrofit2.Call<Account> |
getAccountForSelf()
Get the caller’s account (for admin accounts only).
|
retrofit2.Call<RequestInfo> |
getAccountRequestInfo(String userId)
Get information about the last request made by this organization member
|
retrofit2.Call<Message> |
requestAccountResetPassword(String userId)
Send a password reset email or SMS message to the organization member.
|
retrofit2.Call<Message> |
resendAccountEmailVerification(String userId)
Resent an email verification email to the the organization member.
|
retrofit2.Call<Message> |
resendAccountPhoneVerification(String userId)
Resent an SMS verification message to the the organization member.
|
retrofit2.Call<Message> |
signOutAccount(String userId,
Boolean deleteReauthToken)
Sign the account out and delete their server session
|
retrofit2.Call<Message> |
updateAccount(String userId,
Account account)
Update an administrative account
|
retrofit2.Call<Message> |
updateAccountForSelf(Account account)
Update the caller’s account (for admin accounts only).
|
retrofit2.Call<UserSessionInfo> |
updateIdentifiersForSelf(IdentifierUpdate updateIdentifier)
Allows the caller to add additional identifier fields to their own account (email, phone).
|
@Headers(value="Content-Type:application/json") @POST(value="v1/accounts") retrofit2.Call<IdentifierHolder> createAccount(@Body Account account)
account
- Account record to create (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/accounts/{userId}") retrofit2.Call<Message> deleteAccount(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v1/accounts/{userId}") retrofit2.Call<Account> getAccount(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v1/accounts/self") retrofit2.Call<Account> getAccountForSelf()
@Headers(value="Content-Type:application/json") @GET(value="v1/accounts/{userId}/requestInfo") retrofit2.Call<RequestInfo> getAccountRequestInfo(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/{userId}/requestResetPassword") retrofit2.Call<Message> requestAccountResetPassword(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/{userId}/resendEmailVerification") retrofit2.Call<Message> resendAccountEmailVerification(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/{userId}/resendPhoneVerification") retrofit2.Call<Message> resendAccountPhoneVerification(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/{userId}/signOut") retrofit2.Call<Message> signOutAccount(@Path(value="userId") String userId, @Query(value="deleteReauthToken") Boolean deleteReauthToken)
userId
- User ID (required)deleteReauthToken
- Should sign out also delete any extant reauthentication tokens? (optional, default to true)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/{userId}") retrofit2.Call<Message> updateAccount(@Path(value="userId") String userId, @Body Account account)
userId
- User ID (required)account
- Account record to update (required)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/self") retrofit2.Call<Message> updateAccountForSelf(@Body Account account)
account
- Account record to update (required)@Headers(value="Content-Type:application/json") @POST(value="v1/accounts/self/identifiers") retrofit2.Call<UserSessionInfo> updateIdentifiersForSelf(@Body IdentifierUpdate updateIdentifier)
updateIdentifier
- Information to authenticate and update an account identifier (required)Copyright © 2023 Sage Bionetworks. All rights reserved.