Get Tenant by Name

{ getTenantByName }

Returns a tenant and its metadata using its name.

Method

/API2/access/getTenantByName
  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Can be used by Enterprise Admin users only
  • REST API only via POST actions.
  • Input Parameters

    Name

    name

    Type

    string

    Description

    The tenant's name

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    The tenant object contains all relevant meta-data for the tenant.

    Notes

    Use this method to find the tenant ID needed in other methods.

    Examples