User management

Perform all your tasks related to user management.

The supported API operations are:

  • Get users
  • Get user details
  • Get all user groups
  • Get user group details
  • Add new user group
  • Update user group

Get users

Fetch the list of all the users along with their details in your Vault account.

OAUTH Scope

ZohoVault.user.READ

Arguments

  • isAsc *
  • pageNum *
  • rowPerPage *
  • userName
  • email
CopiedGET /api/rest/json/v1/user

Response Example

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "operation": {
        "result": {
            "message": "",
            "status": "Success"
        },
        "Details": [
            {
                "role": "SuperAdmin",
                "unique-id": "743262",
                "enabled": 1,
                "email": "john@zylker.com",
                "user_auto_id": "1000000000414",
                "username": "John"
            },
            {
                "role": "SuperAdmin",
                "unique-id": "802762",
                "enabled": 1,
                "email": "john@zylker.com",
                "user_auto_id": "1000000000448",
                "username": "john"
            },
            {
                "role": "SuperAdmin",
                "unique-id": "802768",
                "enabled": 1,
                "email": " john@zylker.com",
                "user_auto_id": "1000000000450",
                "username": "n"
            }
        ],
        "name": "GET_USER"
    }
}

Get user details

Fetch the details of a specific user in your Vault account.

OAUTH Scope

ZohoVault.user.READ

CopiedGET /api/rest/json/v1/user/{zuid}

Response Example

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{"operation":{"result":{"message":"","status":"Success"},"Details":[{"role":"SuperAdmin","unique-id":"11078996","enabled":1,"email":"john@zylker.com","user_auto_id":"188000000193003","username":"John"}],"name":"GET_USER"}}

Get all user groups

Fetch the list of all the user groups along with their details in your Vault account.

OAUTH Scope

ZohoVault.user.READ

CopiedGET /api/rest/json/v1/usergroup

Response Example

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
  "operation": {
    "result": {
      "message": "",
      "status": "Success"
    },
    "Details": [
      {
        "role": "SuperAdmin",
        "unique-id": "743262",
        "enabled": 1,
        "email": "john@zylker.com",
        "user_auto_id": "1000000000414",
        "username": "John"
      },
      {
        "role": "SuperAdmin",
        "unique-id": "802762",
        "enabled": 1,
        "email": "john@zylker.com",
        "user_auto_id": "1000000000448",
        "username": "john"
      },
      {
        "role": "SuperAdmin",
        "unique-id": "802768",
        "enabled": 1,
        "email": " john@zylker.com",
        "user_auto_id": "1000000000450",
        "username": "n"
      }
    ],
    "name": "GET_USER"
  }
}

Get user group details

Fetch the list of a specific user group in your Vault account.

OAUTH Scope

ZohoVault.user.READ

CopiedGET /api/rest/json/v1/usergroup/{groupid}

Response Example

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "operation": {
        "result": {
            "message": "",
            "status": "Success"
        },
        "Details": {
            "groupmembers": [
                {
                    "username": "john",
                    "user_auto_id": "1000000000448",
                    "email": "john@zylker.com"
                },
                {
                    "username": " john@zylker.com",
                    "user_auto_id": "1000000000450",
                    "email": " john@zylker.com"
                }
            ],
            "groupname": "via API name update",
            "description": "some description",
            "username": "John"
        },
        "name": "GET_USER_GROUP_DETAILS"
    }
}

Get user group details

Fetch the list of a specific user group in your Vault account.

OAUTH Scope

ZohoVault.user.READ

CopiedGET /api/rest/json/v1/usergroup/{groupid}

Response Example

CopiedHTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "operation": {
        "result": {
            "message": "",
            "status": "Success"
        },
        "Details": {
            "groupmembers": [
                {
                    "username": "john",
                    "user_auto_id": "1000000000448",
                    "email": "john@zylker.com"
                },
                {
                    "username": " john@zylker.com",
                    "user_auto_id": "1000000000450",
                    "email": " john@zylker.com"
                }
            ],
            "groupname": "via API name update",
            "description": "some description",
            "username": "John"
        },
        "name": "GET_USER_GROUP_DETAILS"
    }
}

Add new user group

Create a new user group in your Vault account.

OAUTH Scope

ZohoVault.user.CREATE

CopiedPOST /api/rest/json/v1/usergroup

Request Example

Copied$ curl https://vault.zoho.com/api/rest/json/v1/usergroup \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-authtoken <YourValidAuthtoken>" \
    -d 'INPUT_DATA={
"groupName" : "",
"description" : "",
"groupMembers" : [userid array]
}'

Response Examples

CopiedHTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "operation": {
        "result": {
            "message": "User group added successfully",
            "status": "Success"
        },
        "name": "ADD_USER_GROUP"
    }

Update user group

Update the user group details in your Vault account.

OAUTH Scope

ZohoVault.user.UPDATE

CopiedPUT /api/rest/json/v1/usergroup/{groupid}

Request Example

Copied$ curl https://vault.zoho.com/api/rest/json/v1/usergroup/{groupid} \
    -H "Content-Type: application/json;charset=UTF-8" \
    -H "Authorization: Zoho-authtoken <YourValidAuthtoken>" \
    -d 'INPUT_DATA= {
"groupName" : "Name for group",
"description" : "description",
"groupMembers" : [userid array]
}'

Response Example

CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "operation": {
        "result": {
            "message": "User group updated successfully",
            "status": "Success"
        },
        "name": "EDIT_USER_GROUP"
    }
}