Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Analytics User Management APIs API

Manage User APIs allow you to add, remove, activate, or deactivate users in your Zoho Analytics organization programmatically.

Zoho Analytics User Management APIs API is one of 11 APIs that Zoho Analytics publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Management APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 13 operations across 9 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://analyticsapi.zoho.com.

13 operations 9 paths 13 schemas 2 DELETE4 GET2 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://analyticsapi.zoho.com/restapi/v2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Analytics User Management APIs API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (iam-oauth2-schema) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 2 DELETE, 4 GET, 2 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

User Management APIs 13

Manage User APIs allow you to add, remove, activate, or deactivate users in your Zoho Analytics organization programmatically.

GET
/restapi/v2/users
Get Users
getUsers 1 param → 200default
POST
/restapi/v2/users
Add Users
addUsers 1 param body → 204default
DELETE
/restapi/v2/users
Remove Users
removeUsers 1 param body → 204default
PUT
/restapi/v2/users/active
Activate Users
activateUsers 1 param body → 204default
PUT
/restapi/v2/users/inactive
Deactivate Users
deActivateUsers 1 param body → 204default
PUT
/restapi/v2/users/role
Change User Role
changeUserRole 1 param body → 204default
GET
/restapi/v2/subscription
Get Subscription Details
getSubscriptionDetails 1 param → 200default
GET
/restapi/v2/resources
Get Resource Details
getResourceDetails 1 param → 200default
GET
/restapi/v2/workspaces/{workspace-id}/users
Get Workspace Users
getWorkspaceUsers 1 param → 200default
POST
/restapi/v2/workspaces/{workspace-id}/users
Add Workspace Users
addWorkspaceUsers 1 param body → 204default
DELETE
/restapi/v2/workspaces/{workspace-id}/users
Delete Workspace Users
deleteWorkspaceUsers 1 param body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/users/status
Change Workspace Users Status
changeWorkspaceUsersStatus 1 param body → 204default
PUT
/restapi/v2/workspaces/{workspace-id}/users/role
Change Workspace Users Role
changeWorkspaceUsersRole 1 param body → 204default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AddWorkspaceUsersConfig (3 properties), GetWorkspaceUsersResponse (3 properties), GetUsersResponse (3 properties), ChangeWorkspaceUsersStatusConfig (3 properties). Each schema is shown below with its type and property counts.

RemoveUsersConfig
object
2 properties 1 required
DeactivateUsersConfig
object
2 properties 1 required
GetWorkspaceUsersResponse
object
3 properties 3 required
AddUsersConfig
object
3 properties 1 required
AddWorkspaceUsersConfig
object
3 properties 1 required
GetResourceDetailsResponse
object
3 properties
ActivateUsersConfig
object
2 properties 1 required
GetSubscriptionDetailsResponse
object
3 properties
DeleteWorkspaceUsersConfig
object
2 properties 1 required
ChangeWorkspaceUsersStatusConfig
object
3 properties 2 required
GetUsersResponse
object
3 properties
ChangeUserRoleConfig
object
3 properties 2 required
ChangeWorkspaceUsersRoleConfig
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-analytics-user-management-apis-api-openapi.yml Raw ↑

Other APIs Zoho Analytics publishes across the network.

Zoho Analytics Bulk Export - Asynchronous API
Zoho Analytics Bulk Export - Synchronous API
Zoho Analytics Bulk Import - Asynchronous API
Zoho Analytics Bulk Import - Batch API
Zoho Analytics Bulk Import - Synchronous API
Zoho Analytics Data APIs API
Zoho Analytics Embed APIs API
Zoho Analytics Metadata APIs API
Zoho Analytics Modeling APIs API
Zoho Analytics Sharing & Collaboration APIs API