Class NSUserAgent

NSUserAgent()

User administration.

Declaration

NSUserAgent

AddOwnerContact(Integer)

Declaration

Void AddOwnerContact(Integer contactId)

Parameters

Returns

CanChangePassword(Integer)

Checks if the current associate can change the password for an associate

Declaration

Bool CanChangePassword(Integer associateId)

NSUserAgent agent;
Integer associateId;
Bool res = agent.CanChangePassword(associateId);

Parameters

Returns

ChangeOwnPassword(String,String)

Changes password for a user.

Declaration

Bool ChangeOwnPassword(String oldPassword, String newPassword)

NSUserAgent agent;
String oldPassword;
String newPassword;
Bool res = agent.ChangeOwnPassword(oldPassword, newPassword);

Parameters

Returns

ChangePassword(Integer,String,String)

Changes password for a user.

Declaration

Bool ChangePassword(Integer associateId, String oldPassword, String newPassword)

NSUserAgent agent;
Integer associateId;
String oldPassword;
String newPassword;
Bool res = agent.ChangePassword(associateId, oldPassword, newPassword);

Parameters

Returns

ChangePasswordFromName(String,String,String)

Changes password for a user.

Declaration

Bool ChangePasswordFromName(String associateName, String oldPassword, String newPassword)

NSUserAgent agent;
String associateName;
String oldPassword;
String newPassword;
Bool res = agent.ChangePasswordFromName(associateName, oldPassword, newPassword);

Parameters

Returns

ChangeUserType(NSUser,Integer)

Gets a user from the user name.

Declaration

NSUser ChangeUserType(NSUser user, Integer userType)

NSUserAgent agent;
NSUser user;
Integer userType;
NSUser res = agent.ChangeUserType(user, userType);

Parameters

Returns

CheckAccessGatewayRegistration()

Checks if AccessGatewayRegistration is valid

Declaration

Bool CheckAccessGatewayRegistration()

NSUserAgent agent;
Bool res = agent.CheckAccessGatewayRegistration();

Returns

CreateDefaultRoleEntity()

Sets default values into a new NSRoleEntity.

Declaration

NSRoleEntity CreateDefaultRoleEntity()

NSUserAgent agent;
NSRoleEntity thing = agent.CreateDefaultRoleEntity();
thing = agent.SaveRoleEntity(thing);

Returns

CreateDefaultRoleEntityFromType(Integer)

Creates a new role entity of the specified role type. The role type cannot be changed after the entity is created.

Declaration

NSRoleEntity CreateDefaultRoleEntityFromType(Integer type)

NSUserAgent agent;
Integer type;
NSRoleEntity res = agent.CreateDefaultRoleEntityFromType(type);

Parameters

Returns

CreateDefaultServiceAuth()

Sets default values into a new NSServiceAuth.

Declaration

NSServiceAuth CreateDefaultServiceAuth()

NSUserAgent agent;
NSServiceAuth thing = agent.CreateDefaultServiceAuth();
thing = agent.SaveServiceAuth(thing);

Returns

CreateDefaultUntrustedCredentials()

Sets default values into a new NSUntrustedCredentials.

Declaration

NSUntrustedCredentials CreateDefaultUntrustedCredentials()

NSUserAgent agent;
NSUntrustedCredentials thing = agent.CreateDefaultUntrustedCredentials();
thing = agent.SaveUntrustedCredentials(thing);

Returns

CreateDefaultUser()

Sets default values into a new NSUser.

Declaration

NSUser CreateDefaultUser()

NSUserAgent agent;
NSUser thing = agent.CreateDefaultUser();
thing = agent.SaveUser(thing);

Returns

CreateDefaultUserFromUserType(Integer)

Creates default NSUser providing the user type. Only System and Anonymous users can be created without an existing person.

Declaration

NSUser CreateDefaultUserFromUserType(Integer userType)

NSUserAgent agent;
Integer userType;
NSUser res = agent.CreateDefaultUserFromUserType(userType);

Parameters

Returns

CreateDefaultUserFromUserTypeAndCredential(Integer,Integer,String,String,String)

Creates an NSPersonEntity with default values based on the contactId and credentials.

Declaration

NSUser CreateDefaultUserFromUserTypeAndCredential(Integer userType, Integer contactId, String credentialType, String credentialValue, String credentialDisplayValue)

Parameters

Returns

CreateDefaultUserFromUserTypeAndPersonId(Integer,Integer)

Creates default NSUser providing the associate type and person id. System and Anonymous users can be created without an existing person and permits person id to be 0.

Declaration

NSUser CreateDefaultUserFromUserTypeAndPersonId(Integer userType, Integer personId)

NSUserAgent agent;
Integer userType;
Integer personId;
NSUser res = agent.CreateDefaultUserFromUserTypeAndPersonId(userType, personId);

Parameters

Returns

CreateExternalUser(Integer,String,String,Integer,Bool)

Creates an associate of type external user.

Declaration

Integer CreateExternalUser(Integer personId, String userName, String password, Integer roleId, Bool isActive)

NSUserAgent agent;
Integer personId;
String userName;
String password;
Integer roleId;
Bool isActive;
Integer res = agent.CreateExternalUser(personId, userName, password, roleId, isActive);

Parameters

Returns

CreateUserGroup()

Creates UserGroup (Rank is assigned to the highest rank)

Declaration

NSUserGroup CreateUserGroup()

Returns

DecryptAndSaveExternalTokens(NSTokenManagementInfo)

First asks AccessGateway to decrypt the tokens, then saves the external tokens to the DB and returns a key that can be used to retrieve them

Declaration

String DecryptAndSaveExternalTokens(NSTokenManagementInfo tokenManagementInfo)

NSUserAgent agent;
NSTokenManagementInfo tokenManagementInfo;
String res = agent.DecryptAndSaveExternalTokens(tokenManagementInfo);

Parameters

Returns

DeleteCredential(Integer,String)

Removes credential of a specific type for a user

Declaration

Bool DeleteCredential(Integer userId, String credentialType)

NSUserAgent agent;
Integer userId;
String credentialType;
Bool res = agent.DeleteCredential(userId, credentialType);

Parameters

Returns

DeleteExternalUser(Integer)

Deletes an associate of type external user.

Declaration

Void DeleteExternalUser(Integer associateId)

Parameters

Returns

DeleteRole(Integer,Integer)

Deletes the specified role and move all users associated with the role to the replacingRoleId

Declaration

Void DeleteRole(Integer roleIdToDelete, Integer replacingRoleId)

Parameters

Returns

DeleteServiceAuth(Integer)

Deletes the NSServiceAuth

Declaration

DeleteServiceAuth(Integer serviceAuth)

NSUserAgent agent;
agent.DeleteServiceAuth(123);

Parameters

Returns

DeleteUser(Integer)

Deletes the NSUser

Declaration

DeleteUser(Integer user)

NSUserAgent agent;
agent.DeleteUser(123);

Parameters

Returns

DeleteUserFromName(String)

Deletes a user, with lookup based on the user name.

Declaration

Void DeleteUserFromName(String userName)

NSUserAgent agent;
String userName;
agent.DeleteUserFromName(userName);

Parameters

Returns

DeleteUserGroup(Integer,Integer)

Deletes a user group and move its members to another user group

Declaration

Void DeleteUserGroup(Integer userGroupToDelete, Integer userGroupToMoveTo)

Parameters

Returns

FindCredentialsGroups(String,String)

Gets user groups holding users filtered by the searchString.

Declaration

NSCredentialsGroup[] FindCredentialsGroups(String type, String searchString)

Parameters

Returns

FindCredentialUsers(String,String)

Find users matching the partial name.

Declaration

NSCredentialsGroupUsers FindCredentialUsers(String type, String searchString)

Parameters

Returns

FindRolesWithFunctionalRight(String)

Finds all roles with a given functional right. The roles matched must contain the specified functional right.

Declaration

NSMDOListItem[] FindRolesWithFunctionalRight(String functionalRightName)

NSUserAgent agent;
String functionalRightName;
NSMDOListItem[] res = agent.FindRolesWithFunctionalRight(functionalRightName);

Parameters

Returns

FindRolesWithFunctionalRights(String[])

Finds all roles with a given set of functional rights. The roles matched must contain one or more of the specified functional rights.

Declaration

Integer[] FindRolesWithFunctionalRights(String[] functionalRightNames)

NSUserAgent agent;
String[] functionalRightNames;
Integer[] res = agent.FindRolesWithFunctionalRights(functionalRightNames);

Parameters

Returns

FindRolesWithoutFunctionalRights(String[])

Finds all roles without a given set of functional rights. The roles matched must not contain any of the specified functional rights.

Declaration

Integer[] FindRolesWithoutFunctionalRights(String[] functionalRightNames)

NSUserAgent agent;
String[] functionalRightNames;
Integer[] res = agent.FindRolesWithoutFunctionalRights(functionalRightNames);

Parameters

Returns

GenerateNewPasswordForExternalUser(String)

Generates a new password for an external user.

Declaration

String GenerateNewPasswordForExternalUser(String associateName)

NSUserAgent agent;
String associateName;
String res = agent.GenerateNewPasswordForExternalUser(associateName);

Parameters

Returns

GetAccessGatewayInfo()

Returns accessgateway registration info

Declaration

NSAccessGatewayInfo GetAccessGatewayInfo()

Returns

GetAccessToken(String,Bool)

Gets an access token based on the current user's session.

Declaration

String GetAccessToken(String appToken, Bool includeCsSession)

NSUserAgent agent;
String appToken;
Bool includeCsSession;
String res = agent.GetAccessToken(appToken, includeCsSession);

Parameters

Returns

GetAllFunctionalRights(Integer)

Gets a list of all functional rights for the given type of role.

Declaration

NSSelectableMDOListItem[] GetAllFunctionalRights(Integer roleType)

NSUserAgent agent;
Integer roleType;
NSSelectableMDOListItem[] res = agent.GetAllFunctionalRights(roleType);

Parameters

Returns

GetAllRoles(Integer)

Gets a list of all roles for the given type of role.

Declaration

NSSelectableMDOListItem[] GetAllRoles(Integer roleType)

NSUserAgent agent;
Integer roleType;
NSSelectableMDOListItem[] res = agent.GetAllRoles(roleType);

Parameters

Returns

GetAllUserGroups(Bool)

Gets all user groups

Declaration

NSUserGroup[] GetAllUserGroups(Bool includeDeleted)

NSUserAgent agent;
Bool includeDeleted;
NSUserGroup[] res = agent.GetAllUserGroups(includeDeleted);

Parameters

Returns

GetCredentialsGroups(Integer)

Gets user groups holding users.

Declaration

NSCredentialsGroup[] GetCredentialsGroups(Integer type)

Parameters

Returns

GetCredentialTypes()

Gets available credential types that can be used for authentication

Declaration

NSCredentialType[] GetCredentialTypes()

NSUserAgent agent;
NSCredentialType[] res = agent.GetCredentialTypes();

Returns

GetCredentialTypesForUserType(Integer)

Gets available credential types that can be used for the specified user type.

Declaration

NSCredentialType[] GetCredentialTypesForUserType(Integer userType)

NSUserAgent agent;
Integer userType;
NSCredentialType[] res = agent.GetCredentialTypesForUserType(userType);

Parameters

Returns

GetCredentialUsers(String,String)

Gets credential users within a user group

Declaration

NSCredentialsGroupUsers GetCredentialUsers(String groupName, String type)

Parameters

Returns

GetCredentialUsersInGroup(String,String)

Gets credential users within a user group

Declaration

NSCredentialsGroupUsers GetCredentialUsersInGroup(String type, String groupName)

Parameters

Returns

GetDataRight(Integer,String,Integer)

Reads one specific data right at the given position.

Declaration

String GetDataRight(Integer roleId, String tableName, Integer relationToOwner)

NSUserAgent agent;
Integer roleId;
String tableName;
Integer relationToOwner;
String res = agent.GetDataRight(roleId, tableName, relationToOwner);

Parameters

Returns

GetDataRights(Integer,String)

Reads specific a set of data rights at the given row in the rights matrix.

Declaration

Map GetDataRights(Integer roleId, String tableName)

NSUserAgent agent;
Integer roleId;
String tableName;
Map res = agent.GetDataRights(roleId, tableName);

Parameters

Returns

GetDefaultAssociateUserName(NSUser)

Gets the default username for a person

Declaration

String GetDefaultAssociateUserName(NSUser user)

Parameters

Returns

GetExternalTokens(String)

Retrieves the tokens from the DB based on the given key

Declaration

NSTokenManagementInfo GetExternalTokens(String key)

NSUserAgent agent;
String key;
NSTokenManagementInfo res = agent.GetExternalTokens(key);

Parameters

Returns

GetFunctionalRights(Integer)

Gets all functional rights for the given role. Functional rights not set on the role are not included.

Declaration

NSSelectableMDOListItem[] GetFunctionalRights(Integer roleId)

NSUserAgent agent;
Integer roleId;
NSSelectableMDOListItem[] res = agent.GetFunctionalRights(roleId);

Parameters

Returns

GetRole(Integer)

Gets an NSRole object.

Declaration

NSRole GetRole(Integer roleId)

NSUserAgent agent;
NSRole thing = agent.GetRole(123);

Parameters

Returns

GetRoleEntity(Integer)

Gets an NSRoleEntity object.

Declaration

NSRoleEntity GetRoleEntity(Integer roleEntityId)

NSUserAgent agent;
NSRoleEntity thing = agent.GetRoleEntity(123);

Parameters

Returns

GetServiceAuth(Integer)

Gets an NSServiceAuth object.

Declaration

NSServiceAuth GetServiceAuth(Integer serviceAuthId)

NSUserAgent agent;
NSServiceAuth thing = agent.GetServiceAuth(123);

Parameters

Returns

GetUntrustedCredentials(String)

Gets a set of credentials of a specified type for authenticated user.

Declaration

NSUntrustedCredentials[] GetUntrustedCredentials(String type)

NSUserAgent agent;
String type;
NSUntrustedCredentials[] res = agent.GetUntrustedCredentials(type);

Parameters

Returns

GetUntrustedCredentialsForAssociate(Integer,String)

Gets a set of credentials of a specified type for a specified user. SecretValue is only populated for authenticated user, and system users.

Declaration

NSUntrustedCredentials[] GetUntrustedCredentialsForAssociate(Integer associateId, String type)

NSUserAgent agent;
Integer associateId;
String type;
NSUntrustedCredentials[] res = agent.GetUntrustedCredentialsForAssociate(associateId, type);

Parameters

Returns

GetUser(Integer)

Gets an NSUser object.

Declaration

NSUser GetUser(Integer userId)

NSUserAgent agent;
NSUser thing = agent.GetUser(123);

Parameters

Returns

GetUserFromEjUserId(Integer)

Gets user from ejUserId.

Declaration

NSUser[] GetUserFromEjUserId(Integer ejUserId)

Parameters

Returns

GetUserFromName(String)

Gets a user, with lookup based on user name.

Declaration

NSUser GetUserFromName(String userName)

NSUserAgent agent;
String userName;
NSUser res = agent.GetUserFromName(userName);

Parameters

Returns

GetUserFromPersonId(Integer)

Returns the user associated with the supplied person ID.

Declaration

NSUser[] GetUserFromPersonId(Integer personId)

Parameters

Returns

GetUserGroup(Integer)

Gets an NSUserGroup object.

Declaration

NSUserGroup GetUserGroup(Integer userGroupId)

NSUserAgent agent;
NSUserGroup thing = agent.GetUserGroup(123);

Parameters

Returns

GetUserGroupList(Integer[])

Gets an array of UserGroup objects.

Declaration

NSUserGroup[] GetUserGroupList(Integer[]  userGroupIds)

Integer[] ids;
NSUserAgent agent;
agent.GetUserGroupList(ids);

Parameters

Returns

GetUserInfo(Integer)

Gets an NSUserInfo object.

Declaration

NSUserInfo GetUserInfo(Integer userInfoId)

NSUserAgent agent;
NSUserInfo thing = agent.GetUserInfo(123);

Parameters

Returns

GetUserInfoList(Integer[])

Gets an array of NSUserInfo objects.

Declaration

NSUserInfo[] GetUserInfoList(Integer[] userInfoIds)

Integer[] ids;
NSUserAgent agent;
agent.GetUserInfoList(ids);

Parameters

Returns

GetValidUserName(Integer,Integer,Integer,String)

Declaration

String GetValidUserName(Integer associateId, Integer type, Integer personId, String userName)

Parameters

Returns

GetValidUserNameForNewUser(NSUser)

Generates a valid username for an unsaved user.

Declaration

String GetValidUserNameForNewUser(NSUser user)

Parameters

Returns

IsNickNameUnique(Integer,String)

Declaration

Bool IsNickNameUnique(Integer associateId, String nickName)

Parameters

Returns

IsPasswordValid(Integer,Integer,Integer,String)

Declaration

Bool IsPasswordValid(Integer associateId, Integer type, Integer personId, String password)

Parameters

Returns

IsPasswordValidWithReason(Integer,Integer,Integer,String)

Declaration

NSUserValidationResult IsPasswordValidWithReason(Integer associateId, Integer type, Integer personId, String password)

Parameters

Returns

IsUserNameValid(Integer,Integer,Integer,String,String)

Declaration

Bool IsUserNameValid(Integer associateId, Integer type, Integer personId, String userName)

Parameters

Returns

IsUserNameValidWithReason(Integer,Integer,Integer,String,String)

Declaration

NSUserValidationResult IsUserNameValidWithReason(Integer associateId, Integer type, Integer personId, String userName)

Parameters

Returns

MakeRetired(Integer,Bool)

Retiring a user means to remove all licenses, setting person.retired=1 and associate.deleted=1. Un-retiring a user means setting person.retired=0 and associate.deleted=0

Declaration

Void MakeRetired(Integer associateId, Bool retired)

NSUserAgent agent;
agent.callMethod(arg1, arg2);

Parameters

Returns

RegisterWithAccessGateway(String)

Registers with access gateway if not already done, otherwise will attempt to update.

Declaration

NSAccessGatewayInfo RegisterWithAccessGateway(String redirectUri)

Parameters

Returns

RemoveLicenses(Integer)

Removes all user licenses.

Declaration

Void RemoveLicenses(Integer associateId)

Parameters

Returns

RemoveOwnerContact(Integer)

Removes a contact from the ownercontactlink table

Declaration

Void RemoveOwnerContact(Integer contactId)

Parameters

Returns

RemoveUntrustedCredentials(String,String)

Removes a credentials entry for authenticated user.

Declaration

Void RemoveUntrustedCredentials(String type, String publicValue)

Parameters

Returns

RemoveUntrustedCredentialsForAssociate(Integer,String,String)

Removes a credentials entry for a specified user.

Declaration

Void RemoveUntrustedCredentialsForAssociate(Integer associateId, String type, String publicValue)

Parameters

Returns

ResolveUserFromInfo(Integer,String,String[],String[],Integer)

Gets a user from the provided information. If the user or associated person does not exist, it will be created on demand.

Declaration

NSResolvedUser ResolveUserFromInfo(Integer contactId, String personName, String[] phoneNumbers, String[] emails, Integer userType, NSCredential credential)

NSUserAgent agent;
Integer contactId;
String personName;
String[] phoneNumbers;
String[] emails;
Integer userType;
NSCredential credential;
NSResolvedUser res = agent.ResolveUserFromInfo(contactId, personName, phoneNumbers, emails, userType, credential);

Parameters

Returns

SaveCredential(Integer,NSCredential)

Saves (adds/replaces) current credential of the same type for the user.

Declaration

Bool SaveCredential(Integer userId, NSCredential credential)

NSUserAgent agent;
Integer userId;
NSCredential credential;
Bool res = agent.SaveCredential(userId, credential);

Parameters

Returns

SaveExternalTokens(NSTokenManagementInfo)

Saves the external tokens to the DB and returns a key that can be used to retrieve them

Declaration

String SaveExternalTokens(NSTokenManagementInfo tokenManagementInfo)

NSUserAgent agent;
NSTokenManagementInfo tokenManagementInfo;
String res = agent.SaveExternalTokens(tokenManagementInfo);

Parameters

Returns

SaveRoleEntity(NSRoleEntity)

Updates the existing NSRoleEntity or creates a new NSRoleEntity if the id parameter is 0

Declaration

NSRoleEntity SaveRoleEntity(NSRoleEntity roleEntity)

NSUser  agent;
NSRoleEntity thing = agent.CreateDefaultRoleEntity();
thing = agent.SaveRoleEntity(thing);

Parameters

Returns

SaveServiceAuth(NSServiceAuth)

Updates the existing NSServiceAuth or creates a new NSServiceAuth if the id parameter is 0

Declaration

NSServiceAuth SaveServiceAuth(NSServiceAuth serviceAuth)

NSUser  agent;
NSServiceAuth thing = agent.CreateDefaultServiceAuth();
thing = agent.SaveServiceAuth(thing);

Parameters

Returns

SaveUntrustedCredentials(String,NSUntrustedCredentials)

Saves credentials for authenticated user.

Declaration

Void SaveUntrustedCredentials(String type, NSUntrustedCredentials credentials)

Parameters

Returns

SaveUntrustedCredentialsForAssociate(Integer,String,NSUntrustedCredential)

Saves credentials for a specified user.

Declaration

Void SaveUntrustedCredentialsForAssociate(Integer associateId, String type, NSUntrustedCredentials credentials)

Parameters

Returns

SaveUser(NSUser)

Updates the existing NSUser or creates a new NSUser if the id parameter is 0

Declaration

NSUser SaveUser(NSUser user)

NSUser  agent;
NSUser thing = agent.CreateDefaultUser();
thing = agent.SaveUser(thing);

Parameters

Returns

SaveUserFromName(String,NSUser)

Saves a user, with lookup based on the user name.

Declaration

NSUser SaveUserFromName(String userName, NSUser user)

NSUserAgent agent;
String userName;
NSUser user;
NSUser res = agent.SaveUserFromName(userName, user);

Parameters

Returns

SaveUserGroup(NSUserGroup)

Saves a user group. Sets UserGroup.Deleted to mark a user group as deleted and invisible in the user interface.

Declaration

NSUserGroup SaveUserGroup(NSUserGroup userGroup)

NSUserAgent agent;
NSUserGroup userGroup;
NSUserGroup res = agent.SaveUserGroup(userGroup);

Parameters

Returns

SetDataRight(Integer,String,Integer,String)

Sets one specific data right at the given position.

Declaration

Void SetDataRight(Integer roleId, String tableName, Integer relationToOwner, String dataRightValue)

Parameters

Returns

SetExternalUserInfo(Integer,String,String,Bool,Integer,Integer)

Modifies an external user. Changes external users information according to the flags set in externalUserInfoModification.

Declaration

Void SetExternalUserInfo(Integer associateId, String userName, String password, Bool isActive, Integer roleId, Integer externalUserInfoModification)

Parameters

Returns

SetFunctionalRights(Integer,Integer[])

Sets all functional rights for the given role. Functional rights not specified here will be removed from the role.

Declaration

Void SetFunctionalRights(Integer roleId, Integer[] functionalRightIds)

Parameters

Returns

SetGeneratedPassword(Integer)

Declaration

String SetGeneratedPassword(Integer associateId)

Parameters

Returns

SetGeneratedPasswordFromName(String)

Declaration

String SetGeneratedPasswordFromName(String associateName)

Parameters

Returns

SetPassword(Integer,String)

Changes password for a user.

Declaration

Bool SetPassword(Integer associateId, String password)

NSUserAgent agent;
Integer associateId;
String password;
Bool res = agent.SetPassword(associateId, password);

Parameters

Returns

SetPasswordFromName(String,String)

Changes password for a user.

Declaration

Bool SetPasswordFromName(String associateName, String password)

NSUserAgent agent;
String associateName;
String password;
Bool res = agent.SetPasswordFromName(associateName, password);

Parameters

Returns

ValidateUser(NSUser)

Checks that entity is ready for saving, return error messages by field.

Declaration

Map ValidateUser(NSUser user)

NSUserAgent agent;
NSUser user;
Map res = agent.ValidateUser(user);

Parameters

Returns