Get a Tenant's Users

{ getAllUsersByTenant }

Returns a list of all users for a given tenant.

Method

/API2/access/getAllUsersByTenant

  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Method operates via POST actions only.
  • Input Parameters

    Name

    tenantId

    Type

    string

    Description

    The system tenant ID

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    Returns a generic response object with the list of users for the tenant in the system Note that the response is returned as a list of items of this object type.

    Notes

    Use 'getTenantByName' to find the tenant and its ID. The results of this function can be used with other methods like 'getUser' to perform user-based operations.

    Code Snippets