Get Tenant by Name
{ getTenantByName }
Returns a tenant and its metadata using its name.
Method
/API2/access/getTenantByName
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
User Operations (JavaScript):
This example demonstrates how to find and delete users, roles and tenants.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.
Content and Tag Operations (JavaScript):
This example demonstrates how to find item's and the manipulation of content tags.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.