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 User Management APIs API

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

Zoho User Management APIs API is one of 205 APIs that Zoho 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, an API reference, a getting-started guide, and code examples.

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

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
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho User Management APIs API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

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 ChangeUserRoleConfig (3 properties), AddWorkspaceUsersConfig (3 properties), ChangeWorkspaceUsersRoleConfig (3 properties), AddUsersConfig (3 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ