com.liferay.headless.admin.user.resource.v1_0

Interface UserAccountResource

@Generated(value="")
 @ProviderType
public interface UserAccountResource

To access this resource, run: curl -u your@email.com:yourpassword -D - http://localhost:8080/o/headless-admin-user/v1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UserAccountResource.Builder
static interface	UserAccountResource.Factory
static class	UserAccountResource.FactoryHolder

Method Summary

Modifier and Type	Method and Description
static UserAccountResource.Builder	builder()
void	deleteUserAccount(java.lang.Long userAccountId)
javax.ws.rs.core.Response	deleteUserAccountBatch(java.lang.String callbackURL, java.lang.Object object)
UserAccount	getMyUserAccount()
Page<UserAccount>	getOrganizationUserAccountsPage(java.lang.String organizationId, java.lang.String search, Filter filter, Pagination pagination, Sort[] sorts)
Page<UserAccount>	getSiteUserAccountsPage(java.lang.Long siteId, java.lang.String search, Filter filter, Pagination pagination, Sort[] sorts)
UserAccount	getUserAccount(java.lang.Long userAccountId)
Page<UserAccount>	getUserAccountsPage(java.lang.String search, Filter filter, Pagination pagination, Sort[] sorts)
UserAccount	patchUserAccount(java.lang.Long userAccountId, UserAccount userAccount)
UserAccount	postUserAccount(UserAccount userAccount)
javax.ws.rs.core.Response	postUserAccountBatch(java.lang.String callbackURL, java.lang.Object object)
UserAccount	putUserAccount(java.lang.Long userAccountId, UserAccount userAccount)
javax.ws.rs.core.Response	putUserAccountBatch(java.lang.String callbackURL, java.lang.Object object)
default void	setContextAcceptLanguage(AcceptLanguage contextAcceptLanguage)
void	setContextCompany(Company contextCompany)
default void	setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest)
default void	setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse)
default void	setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo)
void	setContextUser(User contextUser)

Method Detail

builder

static UserAccountResource.Builder builder()

getMyUserAccount

UserAccount getMyUserAccount()
                      throws java.lang.Exception

Throws:

java.lang.Exception

getOrganizationUserAccountsPage

Page<UserAccount> getOrganizationUserAccountsPage(java.lang.String organizationId,
                                                  java.lang.String search,
                                                  Filter filter,
                                                  Pagination pagination,
                                                  Sort[] sorts)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getSiteUserAccountsPage

Page<UserAccount> getSiteUserAccountsPage(java.lang.Long siteId,
                                          java.lang.String search,
                                          Filter filter,
                                          Pagination pagination,
                                          Sort[] sorts)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getUserAccountsPage

Page<UserAccount> getUserAccountsPage(java.lang.String search,
                                      Filter filter,
                                      Pagination pagination,
                                      Sort[] sorts)
                               throws java.lang.Exception

Throws:

java.lang.Exception

postUserAccount

UserAccount postUserAccount(UserAccount userAccount)
                     throws java.lang.Exception

Throws:

java.lang.Exception

postUserAccountBatch

javax.ws.rs.core.Response postUserAccountBatch(java.lang.String callbackURL,
                                               java.lang.Object object)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

deleteUserAccount

void deleteUserAccount(java.lang.Long userAccountId)
                throws java.lang.Exception

Throws:

java.lang.Exception

deleteUserAccountBatch

javax.ws.rs.core.Response deleteUserAccountBatch(java.lang.String callbackURL,
                                                 java.lang.Object object)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getUserAccount

UserAccount getUserAccount(java.lang.Long userAccountId)
                    throws java.lang.Exception

Throws:

java.lang.Exception

patchUserAccount

UserAccount patchUserAccount(java.lang.Long userAccountId,
                             UserAccount userAccount)
                      throws java.lang.Exception

Throws:

java.lang.Exception

putUserAccount

UserAccount putUserAccount(java.lang.Long userAccountId,
                           UserAccount userAccount)
                    throws java.lang.Exception

Throws:

java.lang.Exception

putUserAccountBatch

javax.ws.rs.core.Response putUserAccountBatch(java.lang.String callbackURL,
                                              java.lang.Object object)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

setContextAcceptLanguage

default void setContextAcceptLanguage(AcceptLanguage contextAcceptLanguage)

setContextCompany

void setContextCompany(Company contextCompany)

setContextHttpServletRequest

default void setContextHttpServletRequest(javax.servlet.http.HttpServletRequest contextHttpServletRequest)

setContextHttpServletResponse

default void setContextHttpServletResponse(javax.servlet.http.HttpServletResponse contextHttpServletResponse)

setContextUriInfo

default void setContextUriInfo(javax.ws.rs.core.UriInfo contextUriInfo)

setContextUser

void setContextUser(User contextUser)