Page Comparison

This section guides you through invoking and working with the TenantManagementService and the operations you can work within this service.

...

Description

Adds a new tenant.

Permission Level

/permission/protected/manage/monitor/tenants

Input Parameters

Parameter	Type	Description
tenantInfoBean	TenantInfoBean	Contains tenant related data
tenantInfoBean.tenantDomain	String	The domain name of the tenant
tenantInfoBean.active	Boolean	True - activate the tenant False- deactivate the tenant
tenantInfoBean.admin	String	The admin username
tenantInfoBean.adminPassword	String	The admin password
tenantInfoBean.createdDate	DateTime	The date and time that the tenant was created
tenantInfoBean.email	String	The email address of the tenant
tenantInfoBean.firstname	String	The first name of the tenant
tenantInfoBean.lastname	String	The last name of the tenant
tenantInfoBean.originatedService	String	-
tenantInfoBean.successKey	String	-
tenantInfoBean.tenantDomain	String	The tenant domain
tenantInfoBean.tenantId	Int	The tenant ID
tenantInfoBean.usagePlan	String	-

Request

Expand

title	Click here to see the request

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.tenant.carbon.wso2.org" xmlns:xsd="http://beans.common.stratos.carbon.wso2.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:addTenant>
         <!--Optional:-->
         <ser:tenantInfoBean>
            <!--Optional:-->
            <xsd:active>?</xsd:active>
            <!--Optional:-->
            <xsd:admin>?</xsd:admin>
            <!--Optional:-->
            <xsd:adminPassword>?</xsd:adminPassword>
            <!--Optional:-->
            <xsd:createdDate>?</xsd:createdDate>
            <!--Optional:-->
            <xsd:email>?</xsd:email>
            <!--Optional:-->
            <xsd:firstname>?</xsd:firstname>
            <!--Optional:-->
            <xsd:lastname>?</xsd:lastname>
            <!--Optional:-->
            <xsd:originatedService>?</xsd:originatedService>
            <!--Optional:-->
            <xsd:successKey>?</xsd:successKey>
            <!--Optional:-->
            <xsd:tenantDomain>?</xsd:tenantDomain>
            <!--Optional:-->
            <xsd:tenantId>?</xsd:tenantId>
            <!--Optional:-->
            <xsd:usagePlan>?</xsd:usagePlan>
         </ser:tenantInfoBean>
      </ser:addTenant>
   </soapenv:Body>
</soapenv:Envelope>

Response

None

addSkeletonTenant()

Description

Adds a new tenant without userstore operations. The tenant will not be persisted in user store level and can be used to trigger post-tenant listeners without actuall creating the tenant.

Permission Level

/permission/protected/manage/monitor/tenants

Input Parameters

Parameter	Type	Description
tenantInfoBean	TenantInfoBean	Contains tenant related data
tenantInfoBean.tenantDomain	String	The domain name of the tenant
tenantInfoBean.active	Boolean	True - activate the tenant False- deactivate the tenant
tenantInfoBean.admin	String	The admin username
tenantInfoBean.adminPassword	String	The admin password
tenantInfoBean.createdDate	DateTime	The date and time that the tenant was created
tenantInfoBean.email	String	The email address of the tenant
tenantInfoBean.firstname	String	The first name of the tenant
tenantInfoBean.lastname	String	The last name of the tenant
tenantInfoBean.originatedService	String	-
tenantInfoBean.successKey	String	-
tenantInfoBean.tenantDomain	String	The tenant domain
tenantInfoBean.tenantId	Int	The tenant ID
tenantInfoBean.usagePlan	String	-

Request

Expand

title	Click here to see the request

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.tenant.carbon.wso2.org" xmlns:xsd="http://beans.common.stratos.carbon.wso2.org/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:addSkeletonTenant>
         <!--Optional:-->
         <ser:tenantInfoBean>
            <!--Optional:-->
            <xsd:active>?</xsd:active>
            <!--Optional:-->
            <xsd:admin>?</xsd:admin>
            <!--Optional:-->
            <xsd:adminPassword>?</xsd:adminPassword>
            <!--Optional:-->
            <xsd:createdDate>?</xsd:createdDate>
            <!--Optional:-->
            <xsd:email>?</xsd:email>
            <!--Optional:-->
            <xsd:firstname>?</xsd:firstname>
            <!--Optional:-->
            <xsd:lastname>?</xsd:lastname>
            <!--Optional:-->
            <xsd:originatedService>?</xsd:originatedService>
            <!--Optional:-->
            <xsd:successKey>?</xsd:successKey>
            <!--Optional:-->
            <xsd:tenantDomain>?</xsd:tenantDomain>
            <!--Optional:-->
            <xsd:tenantId>?</xsd:tenantId>
            <!--Optional:-->
            <xsd:usagePlan>?</xsd:usagePlan>
         </ser:tenantInfoBean>
      </ser:addSkeletonTenant>
   </soapenv:Body>
</soapenv:Envelope>

Response

None

activateTenant()

Description

Activates an existing tenant.

Permission Level

/permission/protected/manage/modify/tenants

Input Parameters

Parameter	Type	Description
tenantDomain	String	The domain name of the tenant

Request

Expand

title	Click here to see the request

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ser="http://services.mgt.tenant.carbon.wso2.org">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:activateTenant>
            <!Optional:>
            <ser:tenantDomain>example.com</ser:tenantDomain>
        </ser:activateTenant>
    </soapenv:Body>
</soapenv:Envelope>

Response

Expand

title	Click here to see the response

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:activateTenantResponse xmlns:ns="http://services.mgt.tenant.carbon.wso2.org">
            <ns:return xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" />
        </ns:activateTenantResponse>
    </soapenv:Body>
</soapenv:Envelope>

...

Versions Compared

Old Version 2

New Version 3

Key

addSkeletonTenant()

activateTenant()