> For AI agents: [llms.txt](https://docs.trustedauth.com/llms.txt) provides a Markdown index of this documentation.

# Tenants

Tenant controllers

[📄️Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. Get Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. Caller requires the SPIDENTITYPROVIDERS:VIEW permission.](/api/openapi/admin-api/get-sp-identity-provider-using-get.md)

[📄️Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management Set Tenant Identity Provider and Service Provider OIDC Application for Tenant Management. Caller requires the SPIDENTITYPROVIDERS:EDIT permission.](/api/openapi/admin-api/set-sp-identity-provider-using-put.md)

[📄️Get the result of an asynchronous tenant creation operation Get the result of a tenant creation operation for a service provider. The results for a given operation can only be retrieved once. Caller requires the TENANTS:ADD permission from a service provider role.](/api/openapi/admin-api/get-create-tenant-async-result-using-get.md)

[📄️Get the status of an asynchronous tenant creation operation Get the status of a tenant creation operation for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.](/api/openapi/admin-api/get-create-tenant-async-status-using-get.md)

[📄️Lists a page of entitlement usage information Returns tenant usage information for the provided search parameters. Caller requires the TENANTS:VIEW permission. The following searchByAttributes are supported: <ul><li>startTime: a <b>mandatory</b> String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL. </li><li>endTime: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL. </li><li>tenantId: The UUID of the tenant. Allowed operators are: EQUALS.</li><li>isTrial: true or false. Allowed operator: EQUALS. </li><li>usageType: the type of entitlement: USERS, ISSUANCE. Allowed operator: EQUALS. </li></ul>The orderByAttribute supports these attribute names: startTime.](/api/openapi/admin-api/get-entitlement-usage-info-using-post.md)

[📄️Get a tenant Get the specified tenant for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.](/api/openapi/admin-api/get-tenant-using-get.md)

[📄️Delete a tenant Delete the specified tenant for a service provider. Caller requires the TENANTS:REMOVE permission from a service provider role.](/api/openapi/admin-api/remove-tenant-using-delete.md)

[📄️Lock a tenant Lock the specified tenant for a service provider. Caller requires the TENANTS:EDIT permission from a service provider role.](/api/openapi/admin-api/lock-tenant-using-put.md)

[📄️Unlock a tenant Unlock the specified tenant for a service provider. Caller requires the TENANTS:EDIT permission from a service provider role.](/api/openapi/admin-api/unlock-tenant-using-put.md)

[📄️Get entitlements for tenant Get all entitlements for the specified tenant of the current service provider. Caller requires the SPENTITLEMENTS:VIEW permission from a service provider role.](/api/openapi/admin-api/get-tenant-entitlements-using-get.md)

[📄️Set an entitlement Set the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:EDIT permission from a service provider role.](/api/openapi/admin-api/set-tenant-entitlement-using-put.md)

[📄️Get an entitlement Get the specified entitlement for a tenant. Caller requires the SPENTITLEMENTS:VIEW permission from a service provider role.](/api/openapi/admin-api/get-tenant-entitlement-using-get.md)

[📄️Delete an entitlement Delete the entitlement for the specified tenant. Caller requires the SPENTITLEMENTS:REMOVE permission from a service provider role.](/api/openapi/admin-api/delete-tenant-entitlement-using-delete.md)

[📄️Lists a page of tenants Returns tenants for the provided search parameters. Caller requires the TENANTS:VIEW permission. The following searchByAttributes are supported: <ul><li>hostname: a String up to 100 characters. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.</li><li>companyName: a String up to 100 characters. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.</li><li>contractMode: PRODUCTION, TRIAL, UNKNOWN. Allowed operator: EQUALS.</li><li>locked: true or false. Allowed operator: EQUALS. </li><li>serviceProvider: true or false. Allowed operator: EQUALS. </li><li>authenticationAccount: true or false. Allowed operator: EQUALS. </li><li>issuanceAccount: true or false. Allowed operator: EQUALS. </li><li>spIdp: true or false. Allowed operator: EQUALS. </li></ul>The orderByAttribute supports these attribute names: hostname, companyName, contractMode, locked, serviceProvider, authenticationAccount, issuanceAccount, spIdp.](/api/openapi/admin-api/get-tenants-page-using-post.md)

[📄️Create a tenant asynchronously <p>Create a new tenant for a service provider. Caller requires the TENANTS:ADD permission from a service provider role.</p><p>Notes on CreateTenantParms attributes: </p><b>adminUser</b> (UserParms):<ul> <li>The locale attribute is ignored if provided. It defaults to English for the first super administrator.</li> <li>The status attributes is ignored if provided. It defaults to ACTIVE for the first super administrator.</li> <li>The userId is required.</li></ul><b>adminApiApplication</b> (AdminApiApplicationParms):<ul> <li>The spRoleId attribute is not supported. An error is returned if provided.</li></ul><b>entitlements</b> (EntitlementParms):<ul> <li>The contractMode attribute is required. It must be either TRIAL or PRODUCTION.</li> <li>The quantity attribute is required.</li> <li><b>entitlements.issuance</b> (EntitlementParms.IssuanceParms):</li> <li>The entitlements.issuance attribute is required if you are creating an Issuance tenant.</li> <li>The serviceBundles attribute is required. One service bundle (of those supported by the service provider contract) must be defined.</li></ul>](/api/openapi/admin-api/create-tenant-async-using-post.md)