Add User
Use this API to add users to your Zoho Analytics 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) Zoho Analytics Account. This API does not create user accounts in Zoho.
REQUEST URI
https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>
Post
oauthscope: ZohoAnalytics.usermanagement.create
COMMON PARAMETERS
| Parameter | Possible Values | Description |
|---|---|---|
| ZOHO_ACTION | ADDUSER | This 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_FORMAT | XML/JSON | This parameter specifies the output format for the response. |
| ZOHO_ERROR_FORMAT | XML/JSON | Specifies the output format for the response in case an error occurs when trying to process the request. |
| ZOHO_API_VERSION | 1.0 | The API version of Zoho Analytics based on which the application(/service) has been written. This parameter allows the Zoho Analytics to handle applications based on the older versions.The current API version is 1.0 |
AUTHORIZATION
To make authenticated API request, append the access token in Authorization request header.
| Header Name | Value | Description |
|---|---|---|
| Authorization | Zoho-oauthtoken<space><access_token> | The Access token provides a secure and temporary access to Zoho Analytics API's. Each access token will be valid only for an hour, and can be used only for the set of operations that is described in the scope. |
ACTION SPECIFIC PARAMETERS
| Parameter Name | Possible Values | Description |
|---|---|---|
| ZOHO_EMAILS | User email ID’s | This parameter holds the email addresses of the users to be added in your (Administrator’s) Zoho Analytics Account. The email addresses should be comma separated. Ex:ZOHO_EMAILS=user1@yourdomain.com,user2@yourdomain.com |
| ZOHO_DOMAINNAME (Only For White Label Customers) | Domain name | It’s used to add user to the whitelabel domain. |
POSSIBLE ERROR CODES
Sample Request:
Copiedcurl
-d "ZOHO_ACTION=ADDUSER&ZOHO_OUTPUT_FORMAT=XML&ZOHO_ERROR_FORMAT=XML&ZOHO_API_VERSION=1.0&ZOHO_EMAILS=email1,email2"
-H "Authorization:Zoho-oauthtoken <access_token>"
https://analyticsapi.zoho.com/api/EmailAddressCopiedusing ZReports;
namespace Test
{
CLIENT_ID = "************";
CLIENT_SECRET = "************";
REFRESH_TOKEN = "************";
EMAIL = "Email Address";
class Program
{
public IReportClient getClient()
{
IReportClient RepClient = new ReportClient(CLIENT_ID, CLIENT_SECRET, REFRESH_TOKEN);
return RepClient;
}
public void addUser(IReportClient RepClient)
{
string userURI = RepClient.GetURI(EMAIL);
string emailIds = "user1@zoho.com";
RepClient.AddUser(userURI, emailIds, null);
}
static void Main(string[] args)
{
Program obj = new Program();
IReportClient rc = obj.getClient();
obj.addUser(rc);
}
}
}
Copiedpackage main
import (
"fmt"
"zoho/pkg/reportclient"
)
var (
email = "Email Address"
clientid = "************"
clientsecret = "************"
refreshtoken = "************"
)
func addUser() {
url := reportclient.GetUserUri(email)
emailids := "user1@zoho.com"
err := reportclient.AddUser(url, emailids)
if err != nil {
fmt.Println(err.ErrorMessage)
fmt.Println(err.ErrorCode)
fmt.Println(err.Action)
fmt.Println(err.HttpStatusCode)
} else {
fmt.Println("Success")
}
}
func main() {
reportclient.SetOAuthToken(clientid, clientsecret, refreshtoken)
addUser()
}
Copiedimport com.adventnet.zoho.client.report.*;
public class Sample {
String email = "Email Address";
String clientId = "************";
String clientSecret = "************";
String refreshToken = "************";
String emails = "abc@zoho.com";
Map config = new HashMap();
private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);
public void adduser() throws Exception {
String uri = rc.getURI(email);
rc.addUser(uri, emails, config);
}
public static void main(String[] args) throws Exception {
Sample obj = new Sample();
obj.adduser();
}
}
Copied<?php
require 'ReportClient.php';
$EMAIL_ID = "email";
$CLIENT_ID = "************";
$CLIENT_SECRET = "************";
$REFRESH_TOKEN = "************";
$report_client_request = new ReportClient($CLIENT_ID, $CLIENT_SECRET, $REFRESH_TOKEN);
$uri = $report_client_request->getUserURI($EMAIL_ID);
$emails = "user1@yourdomain.com,user2@yourdomain.com";
$report_client_request->addUser($uri, $emails);
?>
Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys
class Sample:
LOGINEMAILID = "email"
CLIENTID = "************"
CLIENTSECRET = "************"
REFRESHTOKEN = "************"
rc = None
def AddUser(self, rc):
uri = rc.getUserURI(self.LOGINEMAILID)
emailIds = "user1@zoho.com"
rc.addUser(uri, emailIds)
obj = Sample()
obj.AddUser(obj.rc)
Copiedvar nodelib = require('./ZAnalyticsClient');
var clientId = '************';
var clientSecret = '************';
var refreshtoken = '************';
var emailId = 'EmailAddress';
nodelib.initialize(clientId, clientSecret, refreshtoken).then(() => {
var params = {};
var uripath = nodelib.getUri(emailId);
var emailIds = '';
nodelib.addUsers(emailIds, uripath, params).then((response) => {
console.log(response);
}).catch((error) => {
console.log('Error : ' + error.message);
});
}).catch((error) => {
console.log('Authentication Error : ' + error);
});
Copiedemail = zoho.encryption.urlEncode("");
paramsMap = Map();
oauthParams = Map();
headers = Map();
// AUTHENTICATION PARAMS
oauthParams.put("client_id", "********");
oauthParams.put("client_secret", "********");
oauthParams.put("refresh_token", "********");
oauthParams.put("grant_type", "refresh_token");
tokenInfo = invokeurl[url: "https://accounts.zoho.com/oauth/v2/token" type: POST parameters: oauthParams];
if (tokenInfo.containKey("access_token")) {
accessToken = tokenInfo.get("access_token");
headers.put("Authorization", "Zoho-oauthtoken ".concat(accessToken));
} else {
info tokenInfo;
return;
}
// COMMON PARAMS
paramsMap.put("ZOHO_ACTION", "ADDUSER");
paramsMap.put("ZOHO_OUTPUT_FORMAT", "JSON");
paramsMap.put("ZOHO_ERROR_FORMAT", "JSON");
paramsMap.put("ZOHO_API_VERSION", "1.0");
// ACTION SPECIFIC PARAMS
paramsMap.put("ZOHO_EMAILS", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;