Change User Role

This API updates role of specified users with the new role given.

Note: This API doesn't add new users into your (Administrator’s) Zoho Analytics Account. It only changes the role of existing users.

REQUEST URI

https://<ZohoAnalytics_Server_URI>/api/<OwnerEmail>

Post

oauthscope: ZohoAnalytics.usermanagement.update

COMMON PARAMETERS

Parameter	Possible Values	Description
ZOHO_ACTION	CHANGEUSERROLE	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	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	Email addresses of the users whose role has to be changed. `Ex:`ZOHO_EMAILS=user1@yourdomain.com,user2@yourdomain.com
ROLE	ORGADMIN/USER	New role for the users.

POSSIBLE ERROR CODES

6021 , 8504 , 8506 , 8509 , 8516 , 8533

Sample Request:

Curl Csharp Go Java PHP Python Node JS Deluge

Copiedcurl 
-d "ZOHO_ACTION=CHANGEUSERROLE&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0&ZOHO_EMAILS=email1,email2&ROLE=ORGADMIN" 
-H "Authorization:Zoho-oauthtoken <access_token>" 
https://analyticsapi.zoho.com/api/EmailAddress

Copiedusing 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 changeUserRole(IReportClient RepClient)
        {
            string userURI = RepClient.GetURI(EMAIL);
            string emailIds = "user1@zoho.com,user2@zoho.com";
            string role = "ORGADMIN";
            RepClient.ChangeUserRole(userURI, emailIds, role, null);
        }

        static void Main(string[] args)
        {
            Program obj = new Program();
            IReportClient rc = obj.getClient();
            obj.changeUserRole(rc);
        }
    }
}

Copiedpackage main

import (
	"fmt"
	"zoho/pkg/reportclient"
)

var (
	email        = "Email Address"
	dbname       = "Workspace Name"
	clientid     = "************"
	clientsecret = "************"
	refreshtoken = "************"
)

func changeuserrole() {
	url := reportclient.GetUserUri(email)
	emailids := "testuser1@zohotest.com,testuser2@zohotest.com"
	role := ""
	err := reportclient.ChangeUserRole(url, emailids, role)
	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)
	changeuserrole()
}

Copiedimport com.adventnet.zoho.client.report.*;

public class Sample {
    String email = "Email Address";
    String clientId = "************";
    String clientSecret = "************";
    String refreshToken = "************";
    Map config = new HashMap();
    private ReportClient rc = new ReportClient(clientId, clientSecret, refreshToken);

    public void changeUserRole() throws Exception {
        String uri = rc.getURI(email);
        String emails = "abc@zoho.com";
        String role = "";
        rc.changeUserRole(uri, emails, role, null);
    }

    public static void main(String[] args) throws Exception {
        Sample obj = new Sample();
        obj.changeUserRole();
    }
}

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";
$role = "";
$report_client_request->changeUserRole($uri, $emails, $role);
?>

Copiedfrom __future__ import with_statement
from ReportClient import ReportClient
import sys

class Sample:
    LOGINEMAILID = "email"
    CLIENTID = "************"
    CLIENTSECRET = "************"
    REFRESHTOKEN = "************"
    rc = None

    def changeUserRole(self, rc):
        uri = rc.getUserURI(self.LOGINEMAILID)
        emailIds = "user1@zoho.com"
        role = ""
        rc.changeUserRole(uri, emailIds, role)

    obj = Sample()
    obj.changeUserRole(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 = '';
    var role = '';
    nodelib.changeUserRole(emailIds, role, 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", "CHANGEUSERROLE");
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", "");
paramsMAp.put("ROLE", "");
response = invokeurl[url: "https://analyticsapi.zoho.com/api/" + email type: POST parameters: paramsMap headers: headers];
info response;

Sample Response:

Copied{"response": {"uri": "/api/EmailAddress",
        "action": "CHANGEUSERROLE",
        "result": {"message": "User(s) role has been changed successfully."}}}