public interface ForOrgAdminsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
addMember(String orgId,
String userId)
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
|
retrofit2.Call<IdentifierHolder> |
createAccount(Account account)
Create an administrative account
|
retrofit2.Call<VersionHolder> |
createStudy(Study study)
Create a new study
|
retrofit2.Call<Message> |
deleteAccount(String userId)
Delete an administrative account
|
retrofit2.Call<Account> |
getAccount(String userId)
Get an administrative account
|
retrofit2.Call<RequestInfo> |
getAccountRequestInfo(String userId)
Get information about the last request made by this organization member
|
retrofit2.Call<OrganizationList> |
getSponsors(String studyId,
Integer offsetBy,
Integer pageSize)
Get the sponsors of this study.
|
retrofit2.Call<StudyList> |
getStudies(Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get a list of the studies in this app
|
retrofit2.Call<Study> |
getStudy(String studyId)
Get a study
Get a study for this app.
|
retrofit2.Call<Message> |
removeMember(String orgId,
String userId)
Remove a member from this organization (the user will no longer belong to any organization).
|
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<UserSessionInfo> |
updateIdentifiersForSelf(IdentifierUpdate updateIdentifier)
Allows the caller to add additional identifier fields to their own account (email, phone).
|
retrofit2.Call<Organization> |
updateOrganization(String orgId,
Organization organization)
Update an organization
Update an existing organization.
|
@Headers(value="Content-Type:application/json") @POST(value="v1/organizations/{orgId}/members/{userId}") retrofit2.Call<Message> addMember(@Path(value="orgId") String orgId, @Path(value="userId") String userId)
orgId
- Organization ID (required)userId
- User ID (required)@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") @POST(value="v5/studies") retrofit2.Call<VersionHolder> createStudy(@Body Study study)
study
- New study (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/{userId}/requestInfo") retrofit2.Call<RequestInfo> getAccountRequestInfo(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/sponsors") retrofit2.Call<OrganizationList> getSponsors(@Path(value="studyId") String studyId, @Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize)
studyId
- Study identifier (required)offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json") @GET(value="v5/studies") retrofit2.Call<StudyList> getStudies(@Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize, @Query(value="includeDeleted") Boolean includeDeleted)
offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}") retrofit2.Call<Study> getStudy(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/organizations/{orgId}/members/{userId}") retrofit2.Call<Message> removeMember(@Path(value="orgId") String orgId, @Path(value="userId") String userId)
orgId
- Organization ID (required)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/identifiers") retrofit2.Call<UserSessionInfo> updateIdentifiersForSelf(@Body IdentifierUpdate updateIdentifier)
updateIdentifier
- Information to authenticate and update an account identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v1/organizations/{orgId}") retrofit2.Call<Organization> updateOrganization(@Path(value="orgId") String orgId, @Body Organization organization)
orgId
- Organization ID (required)organization
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.