Package com.inductiveautomation.ignition.common.user.rpc

Interface UsersRpc

public interface UsersRpc

Field Summary

Fields

Modifier and Type	Field	Description
static final ProtoRpcSerializer	SERIALIZER

Method Summary

Modifier and Type	Method	Description
UIResponse	addRole(String userProfile, Locale locale, String roleName)
UIResponse	addUser(String userSource, Locale locale, User user)
UIResponse	alterUser(String userProfile, Locale locale, User user)
UserSourceDesc	describeUserSource(String userProfile)
Set<ContactType>	getContactTypes()
User	getCurrentUser()
List<IdentityProviderMeta>	getIdentityProviders()
List<String>	getRoles(String userProfile)
List<String>	getSystemRoles()
User	getUser(String userProfile, String username)
Set<ConfigurationProperty<?>>	getUserProperties()
List<User>	getUsers(String userProfile)
List<UserSourceMeta>	getUserSources()
UIResponse	removeRoles(String userProfile, Locale locale, List<String> roles)
UIResponse	removeUser(String userProfile, Locale locale, String username)
UIResponse	removeUsers(String userProfile, Locale locale, List<User> users)
UIResponse	renameRole(String userProfile, Locale locale, String oldName, String newName)

Field Details

SERIALIZER

static final ProtoRpcSerializer SERIALIZER

Method Details

getUsers

List<User> getUsers(String userProfile)
             throws Exception

Throws:

Exception

getContactTypes

Set<ContactType> getContactTypes()

getRoles

List<String> getRoles(String userProfile)
               throws Exception

Throws:

Exception

getUserProperties

Set<ConfigurationProperty<?>> getUserProperties()

getUserSources

List<UserSourceMeta> getUserSources()

Returns:

An unmodifiable list of UserSourceMeta, sorted by name.

getIdentityProviders

List<IdentityProviderMeta> getIdentityProviders()

Returns:

An unmodifiable list of IdentityProviderMeta, sorted by name.

describeUserSource

UserSourceDesc describeUserSource(String userProfile)
                           throws Exception

Throws:

Exception

addRole

UIResponse addRole(String userProfile,
 Locale locale,
 String roleName)
            throws Exception

Throws:

Exception

removeRoles

UIResponse removeRoles(String userProfile,
 Locale locale,
 List<String> roles)
                throws Exception

Throws:

Exception

renameRole

UIResponse renameRole(String userProfile,
 Locale locale,
 String oldName,
 String newName)
               throws Exception

Throws:

Exception

addUser

UIResponse addUser(String userSource,
 Locale locale,
 User user)
            throws Exception

Throws:

Exception

getCurrentUser

User getCurrentUser()

getUser

User getUser(String userProfile,
 String username)
      throws Exception

Throws:

Exception

alterUser

UIResponse alterUser(String userProfile,
 Locale locale,
 User user)
              throws Exception

Throws:

Exception

removeUser

UIResponse removeUser(String userProfile,
 Locale locale,
 String username)
               throws Exception

Throws:

Exception

removeUsers

UIResponse removeUsers(String userProfile,
 Locale locale,
 List<User> users)
                throws Exception

Throws:

Exception

getSystemRoles

List<String> getSystemRoles()
                     throws Exception

Throws:

Exception