TrustMe Premium API Documentation
From TrustMeWiki
[edit] Premium API Documentation
Organization Management API
organization.create Creates a new organization hierarchy
organization.add Adds a sub organization to the organization hierarchy
organization.list Lists the portion of the organization's hierarchy which is owned by the user
organization.branch Lists an organization's branches
organization.get Lists an organization's properties
organization.edit Edit an organization's properties
Organization Administrators
orgadmin.add Adds an administrator to the organization hierarchy
orgadmin.remove Removes an administrator from the organization hierarchy
orgadmin.list Lists the administrators in the organization hierarchy
Organization domains
domain.add Adds a domain to the organization node
domain.remove Removes an organization domain from the organization node
domain.listAll Lists all trusted domains across the system
domain.isTrusted Checks whether the domain is trusted whether it handles secure trustme email on behave of the user
domain.list Lists domains for the organization
domain.url Returns the domain's URL
domain.privateKey Returns the domain's private key
domain.publicKey Returns the domain's public key
domain.isFriendToUser helper method to check if domain and user have trusted relationship.
domain.isFriendToDomain helper method to check if domains have trusted relationship.
Domain groups
domaingroup.add Adds an existing group to the domain
domaingroup.remove Removes an existing group from the domain
domaingroup.list Lists the domain's group
Organization invitation's acceptance rules Rules are used for the automatic invitation handling for the organization hierarchy domains
acceptRules.add Adds invitation acceptance rules
acceptRules.remove Removes specific invitation acceptance rule
acceptRules.removeAll Removes all invitation acceptance rule associated with the organization
acceptRules.list Lists invitation acceptance rules for the organization
acceptRules.listForDomain Lists aggregated invitation acceptance rules for the domain
Organization invitation rules Rules are used for the automatic invitation text generation for the organization hierarchy domains
inviteRules.add Adds invitation rules
inviteRules.remove Removes specific invitation rule
inviteRules.removeAll Removes all invitation rule associated with the organization
inviteRules.list Lists invitation rules
Domain invitation handling
receivedInvitations.list Lists an organization domain's received invitations
receivedInvitation.accept Accepts an organization domain's received invitation
receivedInvitation.decline Declines an organization domain's received invitation
invitation.registerNewUser Registers a prepared invitation for a new non-TrustMe user
invitation.register Registers a prepared invitation for an existing TrustMe user
invitation.registerDomain Registers a prepared invitation for the TrustMe domain
invitation.changeStatus Changes the status of a prepared invitation
invitation.properties Returns the properties of an invitation
invitation.key Returns a secure random key that is assigned to the invitation for the email and email attachment(s) content encryption. The user must be the recipient of the invitation or the administator of the domain that sent the invitation.
invitation.archive Changes the status of an invitation to archive
