net.bluemind.externaluser.api

Interface IExternalUser

All Known Subinterfaces:

IInCoreExternalUser

All Known Implementing Classes:

ExternalUserService

@Path(value="/externaluser/{domainUid}")
public interface IExternalUser

ExternalUser API. The main use case for this kind of DirEntry entity is to add an external email to a group.

Method Summary

Modifier and Type	Method and Description
ItemValue<ExternalUser>	byExtId(java.lang.String extId) Fetch a ExternalUser by its external id.
void	create(java.lang.String uid, ExternalUser externalUser) Creates a new ExternalUser.
void	createWithExtId(java.lang.String uid, java.lang.String extId, ExternalUser externalUser) Creates a new ExternalUser with the given uid.
void	delete(java.lang.String uid) Delete an external user.
ItemValue<ExternalUser>	getComplete(java.lang.String uid) Fetch a ExternalUser by its uid.
java.util.List<ItemValue<Group>>	memberOf(java.lang.String uid) Returns the list of Group net.bluemind.core.container.api.ItemValue the external user is member of.
java.util.List<java.lang.String>	memberOfGroups(java.lang.String uid) Retrieves a list of all Group uids the external user is member of.
void	update(java.lang.String uid, ExternalUser externalUser) Modify an existing external user.

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       ExternalUser externalUser)
                                throws ServerFault

Creates a new ExternalUser.

Parameters:

uid - ExternalUser's unique id

externalUser - ExternalUser

Throws:

ServerFault - standard error object

createWithExtId

@PUT
 @Path(value="{uid}/{extid}/createwithextid")
void createWithExtId(@PathParam(value="uid")
                                                                        java.lang.String uid,
                                                                        @PathParam(value="extid")
                                                                        java.lang.String extId,
                                                                        ExternalUser externalUser)
                                                                 throws ServerFault

Creates a new ExternalUser with the given uid. Associates an external id to the ExternalUser.

Parameters:

uid - the ExternalUser's unique id

extId - an external id. Usually used to link the ExternalUser to an external system

externalUser - ExternalUser

Throws:

ServerFault - standard error object

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        ExternalUser externalUser)
                                 throws ServerFault

Modify an existing external user.

Parameters:

uid - ExternalUser's unique id

externalUser - updated ExternalUser

Throws:

ServerFault - standard error object

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Delete an external user.

Parameters:

uid - ExternalUser's unique id

Throws:

ServerFault

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<ExternalUser> getComplete(@PathParam(value="uid")
                                                                        java.lang.String uid)
                                                                 throws ServerFault

Fetch a ExternalUser by its uid.

Parameters:

uid - ExternalUser's unique id

Returns:

ExternalUser net.bluemind.core.container.api.ItemValue, or null if the ExternalUser does not exist

Throws:

ServerFault - standard error object

byExtId

@GET
 @Path(value="byExtId/{extid}")
ItemValue<ExternalUser> byExtId(@PathParam(value="extid")
                                                                     java.lang.String extId)
                                                              throws ServerFault

Fetch a ExternalUser by its external id.

Parameters:

extId - the external user's external id. Usually used to link the ExternalUser to an external system

Returns:

ExternalUser net.bluemind.core.container.api.ItemValue, or null if the ExternalUser does not exist

Throws:

ServerFault - standard error object (unchecked exception)

memberOf

@GET
 @Path(value="{uid}/groups")
java.util.List<ItemValue<Group>> memberOf(@PathParam(value="uid")
                                                                            java.lang.String uid)
                                                                     throws ServerFault

Returns the list of Group net.bluemind.core.container.api.ItemValue the external user is member of.

Parameters:

uid - the ExternalUser's unique id

Returns:

list of Group net.bluemind.core.container.api.ItemValue

Throws:

ServerFault - standard error object

memberOfGroups

@GET
 @Path(value="{uid}/groupUids")
java.util.List<java.lang.String> memberOfGroups(@PathParam(value="uid")
                                                                                     java.lang.String uid)
                                                                              throws ServerFault

Retrieves a list of all Group uids the external user is member of.

Parameters:

uid - the ExternalUser's unique id

Returns:

list of Group uids

Throws:

ServerFault - standard error object