Enterprises, users and user groups management

Enterprises, users, and user groups are the core building blocks for managing access, organization, and reporting in the platform.

• Enterprises define the organizational boundaries for customers or tenants.

• Users represent individual accounts that interact with the system.

• User Groups organize users into teams, departments, or functional units for easier assignment, permissions management, and reporting.

This section explains how to manage these entities through the API, with practical use cases and endpoint references to help you:

• Onboard and organize team members.

• Maintain and update group memberships

• Password management

Manage users in an enterprise

Get all users of an enterprise

Endpoint: GET /api/v3/enterprises/{enterpriseId}/users Retrieve a list of all users belonging to a specific enterprise.

When to use:

• Display the full directory of an enterprise.

• Prepare for bulk operations such as assigning users to groups.

GET /api/v3/enterprises/{enterpriseId}/users HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "users": [
    {
      "id": 12,
      "userId": 12,
      "profileId": 25,
      "enterprise": {
        "id": 12,
        "name": "My enterprise name",
        "logo": "https://cloud.apizee.com/img/users/xxxxxx/default",
        "domain": "my.domain.com",
        "apiKey": "51az89eaz1a5z16az1az598"
      },
      "nickname": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "username": "my.username@email.com",
      "is_agent": "false",
      "email": "my.email@email.com",
      "photo_url": "https://cloud.apizee.com/img/users/xxxxxx/default",
      "title": "agent",
      "phone": "XXXXXXXXX",
      "mobile": "XXXXXXXXX"
    }
  ]
}

Create a new user

Endpoint: POST /api/v3/users Add a new user to the system.

When to use:

• Onboard a new agent or admin.

• Automate user creation from an external system.

POST /api/v3/users?username=text&password=password HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resultCode": "OK",
  "userId": "12"
}

Update user properties

Endpoint: PUT /api/v3/users Modify a user’s profile or settings.

When to use:

• Update contact details or role.

• Adjust permissions without recreating the account.

PUT /api/v3/users?Userid=1 HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "12"
}

Delete user

Endpoint: DELETE /api/v3/users Remove a user account.

When to use:

• Offboard a departing employee.

• Clean up inactive or duplicate accounts.

DELETE /api/v3/users?userId=1 HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resultCode": "OK",
  "userId": "12"
}

Manage user groups

Get all user groups of an enterprise

Endpoint: GET /api/v3/enterprises/{enterpriseId}/groups Retrieve all user groups within an enterprise.

When to use:

• Review available teams for assignment.

• Audit organizational structure.

GET /api/v3/enterprises/{enterpriseId}/groups HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 103,
    "name": "Sales Team",
    "description": "Sales representatives for North America",
    "external_reference": null
  },
  {
    "id": 104,
    "name": "Engineering",
    "description": "Research and Development division",
    "external_reference": null
  }
]

Get all users in a user group

Endpoint: GET /api/v3/enterprises/{enterpriseId}/groups/{groupId}/members Retrieve all users assigned to a group.

When to use:

• Review team composition.

• Prepare for team restructuring.

GET /api/v3/enterprises/{enterpriseId}/groups/{groupId}/members HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  [
    111,
    123
  ]
]

Manage user accounts and credentials

Get personal information of current authenticated user

Endpoint: GET /api/v3/users/me Retrieve the profile of the currently authenticated user.

When to use:

• Display user details in self-service portals.

• Pre-fill account settings forms.

GET /api/v3/users/me HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "photo_url": "https://my.site.com/root/to/photo.jpg",
  "enterpriseId": 15,
  "userId": 12,
  "apiKey": "aze41989caz26a2z4e98c",
  "nickname": "John Doe",
  "token": "6a54c065a8z91a6z19a",
  "is_agent": "true",
  "ccs": "ccs.apizee.com"
}

Get user id

Endpoint: GET /api/v3/users/id Retrieve the ID of a user from email address.

When to use:

• Get a user’s ID before performing updates or assignments.

GET /api/v3/users/id?email=text HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "12",
  "enterpriseOd": 18,
  "firstName": "John",
  "lastName": "Doe",
  "resultCode": "OK"
}

Change user password

Endpoint: POST /api/v3/users/password/reset Send a password reset link by email.

When to use:

• Help a user regain access.

• Enforce password rotation.

• Bulk reset password in cas of a security event.

POST /api/v3/users/password/reset?login=text HTTP/1.1
Host: cloud.apizee.com
Accept: */*

{
  "resultCode": "OK"
}