Interface AccountClient

All Known Implementing Classes:

AccountClientImpl

public interface AccountClient

The API interface exposed by the YellowDog Account Service

Method Summary

Modifier and Type	Method	Description
AddApplicationResponse	addApplication(AddApplicationRequest request)
void	addApplicationToGroup(String groupId, String applicationId)
Group	addGroup(AddGroupRequest request)
void	addRoleToGroup(String groupId, String roleId, RoleScope scope)
void	addUserToGroup(String groupId, String userId)
void	deleteApplication(String applicationId)
void	deleteGroup(String groupId)
Application	getApplication(String applicationId)
SearchClient<GroupSummary>	getApplicationGroups(String applicationId)
SearchClient<Application>	getApplications(ApplicationSearch search)
Group	getGroup(String groupId)
SearchClient<Application>	getGroupApplications(String groupId)
SearchClient<Role>	getGroupRoles(String groupId)
SearchClient<GroupSummary>	getGroups(GroupSearch search)
SearchClient<User>	getGroupUsers(String groupId)
Role	getRole(String roleId)
SearchClient<GroupSummary>	getRoleGroups(String roleId)
SearchClient<Role>	getRoles(RoleSearch search)
User	getUser(String userId)
SearchClient<GroupSummary>	getUserGroups(String userId)
SearchClient<User>	getUsers(UserSearch search)
List<PermissionDetail>	listPermissions()
ApiKey	regenerateApplicationApiKey(String applicationId)
void	removeApplicationFromGroup(String groupId, String applicationId)
void	removeRoleFromGroup(String groupId, String roleId)
void	removeUserFromGroup(String groupId, String userId)
Application	updateApplication(String applicationId, UpdateApplicationRequest request)
Group	updateGroup(String groupId, UpdateGroupRequest request)

Method Details

getUser

User getUser(String userId)

getUsers

SearchClient<User> getUsers(UserSearch search)

getUserGroups

SearchClient<GroupSummary> getUserGroups(String userId)

getApplication

Application getApplication(String applicationId)

updateApplication

Application updateApplication(String applicationId,
 UpdateApplicationRequest request)

addApplication

AddApplicationResponse addApplication(AddApplicationRequest request)

regenerateApplicationApiKey

ApiKey regenerateApplicationApiKey(String applicationId)

getApplications

SearchClient<Application> getApplications(ApplicationSearch search)

getApplicationGroups

SearchClient<GroupSummary> getApplicationGroups(String applicationId)

deleteApplication

void deleteApplication(String applicationId)

listPermissions

List<PermissionDetail> listPermissions()

getRole

Role getRole(String roleId)

getRoles

SearchClient<Role> getRoles(RoleSearch search)

getRoleGroups

SearchClient<GroupSummary> getRoleGroups(String roleId)

getGroup

Group getGroup(String groupId)

addGroup

Group addGroup(AddGroupRequest request)

updateGroup

Group updateGroup(String groupId,
 UpdateGroupRequest request)

getGroupUsers

SearchClient<User> getGroupUsers(String groupId)

getGroupApplications

SearchClient<Application> getGroupApplications(String groupId)

getGroupRoles

SearchClient<Role> getGroupRoles(String groupId)

getGroups

SearchClient<GroupSummary> getGroups(GroupSearch search)

addUserToGroup

void addUserToGroup(String groupId,
 String userId)

addApplicationToGroup

void addApplicationToGroup(String groupId,
 String applicationId)

addRoleToGroup

void addRoleToGroup(String groupId,
 String roleId,
 RoleScope scope)

removeUserFromGroup

void removeUserFromGroup(String groupId,
 String userId)

removeApplicationFromGroup

void removeApplicationFromGroup(String groupId,
 String applicationId)

removeRoleFromGroup

void removeRoleFromGroup(String groupId,
 String roleId)

deleteGroup

void deleteGroup(String groupId)