API Reference


User methods allow you display, create, remove and manipulate user accounts within Media Factory.
Users.confirmCredentials

Confirms a users username and password, and optionally returns user information.

If returnUserInfo is set to false, this method will return the user id when the settings were correct. This method always returns false when username or password is incorrect.

If login is set to true a session will be started and the system will return a sessiontoken property in the userData struct. read more »

Users.getLoggedInUser

This method/service call returns a array with the user information.

read more »
Users.getSessionToken

Returns a session token for a specified user ID.

This method returns the session token for the provided user id. If the third argument is true it will also return any user data available for the account in the form of an array.

read more »
Users.getUserBySessionToken

This method returns information about the user by providing the associated session token. The return value is in the form of a array.

read more »
Users.getUserInfo

Returns information about a specific user.

This method returns all available information about a requested user based on either a user ID or a username. The method requires a user ID or a username. If a username is supplied the vhost parameter is required.

read more »
Users.getUserInfoByDeviceID
This method will return the user information related to the owner of a particular mobile device. read more »
Users.getUserInfoByEmail

This method returns all available user information about a specific user based on the required email address. This method requires a valid email address and a vhost ID.

read more »
Users.getUserInfoByPhone
This method returns all available user information about a specific user based on the required phone number . This method requires a valid phone number and a vhost ID. read more »
Users.getUserInfoByUserName

Returns information about a specific user.

This method requires a username and a vhost ID.

read more »

Users.getUsers

Returns an array of users with standard information and metadata. Also returns userCount - the number of users found in the search.

read more »
Users.register

This method registers a new user.

Optionally the user can be activated immediately. If the email parameter contains a string, an email template named by that string will used to send out an activation or welcome email.

The return value is the newly created user id.

This method can only be called with a valid developer key.

Required fields for userData are user and read more »

Users.verifyUserEmail

Verifies if a username or email already exists in a specific vhost.

When they don't exist this method will return 1, if the user already exists it will return -1, if the email already exists it will return -2.

read more »