Skip to main content

Create a tenant

POST 
/api/web/v4/tenants
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Create a new tenant for a service provider. Caller requires the TENANTS:ADD permission from a service provider role.
Notes on CreateTenantParms attributes:
adminUser (UserParms):

  • The locale attribute is ignored if provided. It defaults to English for the first super administrator.
  • The status attributes is ignored if provided. It defaults to ACTIVE for the first super administrator.
  • The userId is required.
adminApiApplication (AdminApiApplicationParms):
  • The spRoleId attribute is not supported. An error is returned if provided.
entitlements (EntitlementParms):
  • The contractMode attribute is required. It must be either TRIAL or PRODUCTION.
  • The quantity attribute is required.
  • entitlements.issuance (EntitlementParms.IssuanceParms):
  • The entitlements.issuance attribute is required if you are creating an Issuance tenant.
  • The serviceBundles attribute is required. One service bundle (of those supported by the service provider contract) must be defined.

Request​

Responses​

Successful