Analytics-Plus Help

User Management API

 

This section lists the User Management APIs for managing users in the Analytics Plus Administrator account.

Manage User APIs are used to Add / Remove / Activate / Deactivate Users to your Analytics Plus Account. This APIs can be invoked only by the Administrator of the Analytics Plus
account to add / activate / deactivate users to his account.

 

Note: These API's cannot be used to create user accounts in Analytics Plus. This is just meant to associate an existing Analytics Plus user to a Analytics Plus account held by an Administrator.

 

Getting Started

 

To get started with the below documentation, make sure that you already gone through thePrerequisites and API Specifications documentations.

 

Get Users

 

The Get users API is used to get the users in Analytics Plus Account. The account Administrator and the Database Owner alone can use this API to get the users list in the Analytics Plus account.

 

URL

 

https://<server_hostname>:8443/api/<Email>

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONGETUSERSThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

In case of any error other than the above said, mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. Analytics Plus will get back to you with the best possible solution.

 

Add Users

 

Use this API to add users to your Analytics Plus Account (provided you are the Administrator). The users will be added in "Active State" by default and the active user count in your account will be increased accordingly. Incase your account already has exceeded the allowed user count limit, then the newly added users will be set as "Deactive". An invitation mail will be triggered to the newly added users.

 

Note: This API is used to just add users into your (Administrator's) Analytics Plus Account. This API does not create user accounts in Analytics Plus.

 

URL

 

https://<server_hostname>:8443/api/<Email>

 

URL PARAMETERS

 

ParameterPossible ValuesDescription
ZOHO_ACTIONADDUSERThis parameter specifies the action to be performed by the API request.
Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_EMAILSUser email ID’sThis parameter holds the email addresses of the users to be added in your (Administrator’s) Analytics Plus Account.
The email addresses should be comma separated.
Ex:ZOHO_EMAILS=user1@yourdomain.com,user2@yourdomain.com

 

Remove User

 

The API to delete the users from the Administrator's Analytics Plus Account. In case an active user is removed/deleted, then the count of the users associated with the account will decrease. The usage details are below.

 

URL

 

https://<server_hostname>:8443/api/<Email>

 

URL PARAMETERS

 

ParameterPossible ValuesDescription
ZOHO_ACTIONREMOVEUSERThis parameter specifies the action to be performed by the API request.
Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_EMAILSUser email ID’sThis parameter holds the email addresses of the users to be deleted from the Analytics Plus account.
The email addresses should be comma separated.
Ex:- ZOHO_EMAILS=user1@yourdomain.com,user2@yourdomain.com .
 

 

ACTIVATE USER

 

You can activate an user using the Activate User API. Once you activate a user, he/she will be a part of the total active user count . This API will fail to activate the user, if the user count limit available for the account is reached.

 

URL

 

https://<server_hostname>:8443/api/<Email>

 

URL PARAMETERS

 

ParameterPossible ValuesDescription
ZOHO_ACTIONACTIVATEUSERThis parameter specifies the action to be performed by the API request.
Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_EMAILSUser email ID’sThis parameter holds the email addresses of the users to be activated in Administrator’s Analytics Plus Account. 
The email addresses should be comma separated.
Ex:- ZOHO_EMAILS=user1@yourdomain.com,user2@yourdomain.com

 

Deactivate User

 

This API is used to de-activate the specified users from the Administrator's Analytics Plus Account. The activated users will be de-activated using the Deactivate Users API.Once the user is de-activated, the user count will be decreased if the user(s) was in Active State. The usage details are below.

 

URL

 

https://<server_hostname>:8443/api/<Email>

 

URL PARAMETERS

 

ParameterPossible ValuesDescription
ZOHO_ACTIONDEACTIVATEUSERThis parameter specifies the action to be performed by the API request.
Note: Value of ZOHO_ACTION parameter should be in the same case(UPPER CASE) as given in this document.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_EMAILSUser email ID’sThis parameter holds the email addresses of the users to be deactivated from the Analytics Plus account. 
The email addresses should be comma separated.
Ex:- ZOHO_EMAILS=user1@yourdomain.com,user2@yourdomain.com

 

GET PLAN INFO

 

The Planinfo API is used to get the user plan details in the Analytics Plus Account. The account Administrator and the Database Owner alone can use this API to get the user plan info in the Analytics Plus account.

 

URL

 

https://<server_hostname>:8443/api/<Email>/<Databasename>

 

URL PARAMETERS

 

Parameter NamePossible ValuesDescription
ZOHO_ACTIONGETUSERPLANDETAILSThis parameter specifies the action to be performed by the API request.
ZOHO_OUTPUT_FORMATXML/JSONThis parameter specifies the output format for the response.
ZOHO_ERROR_FORMATXML/JSONSpecifies the output format for the response in case an error occurs when trying to process the request.
authtokenuser authtokenAuth Token is an unique token that authenticates the user to access the Analytics Plus account.
ZOHO_API_VERSION1.0The API version of Analytics Plus based on which the application(/service) has been written. This parameter allows the Analytics Plus to handle applications based on the older versions.The current API version is 1.0.

 

ERROR HANDLING IN USER MANAGEMENT

 

This section explains about the possible error responses that could be returned by Analytics Plus on failure of the Manage User API calls discussed above. The sample error response is below.

 

ERROR CODES:

 

ZOHO_ACTIONError CodeReasonSolution
ADDUSER 
REMOVEUSER 
ACTIVATEUSER 
DEACTIVATEUSER
8509The Email Ids provided in ZOHO_EMAILS parameter is not proper / not in the EMAIL ID formatCheck the email addresses passed in the parameter and provide the proper email address.
ACTIVATEUSER6021Activating Users not allowed since the users count exceeds the allowed limit for your Analytics Plus PlanYou can upgrade your Analytics Plus Account or you can get additional users as add-ons. You can manage your plan by clicking the “License Management” section in the settings page of Analytics Plus.

 

In case you encounter any other errors, please mail the API request URL parameters and error response details to analyticsplus-support@manageengine.com. We will get back to you shortly with the best possible solution.

Share this post : FacebookTwitter