UpdateTenant
Updates a tenant under the root tenant with tenant specific operations. The operation UpdateTenant is only allowed on the root tenant, because a child tenant does not contain tenants.
| Element | Required | Description |
|---|---|---|
| TenantName | Yes | Specifies the name of tenant |
| UserName | No | Specifies the user in the tenant. The user must be specified when the Operations elements is used |
| Properties | Choice | Start element for the properties Name, Description, Active and UserManagement on the tenant |
| Operations | Choice | Start element for the operations on the tenant |
The elements Properties and Operations can be used together.
Update properties
The element Properties updates the properties for the tenant. Only the properties that should be updated are specified.
| Property Element | Description |
|---|---|
| Name | Specifies the name of tenant |
| Description | Descriptive text for the tenant |
| Active | Specifies if the tenant is active (Yes) or not (No) |
| UserManagement | Local user management is specified by Yes and central user management is specified by No |
The element Properties will not result in a task and are executed in the root tenant. The UserName element is not required when only the Properties element is used.
Example of the UpdateTenant operation that renames and activates the tenant:
<UpdateTenant>
<TenantName>MyTenantName</TenantName>
<Properties>
<Name>MyNewTenantName</Name>
<Active>Yes</Active>
</Properties>
</UpdateTenant>
Update operations
The element Operations contains the operations like for example ImportDatasource for the tenant. The UpdateTenant operation will fork a new task in the child tenant to execute the script between Operations elements. The UserName element is required when the Operations elements is used.
Example of the UpdateTenant operation:
<UpdateTenant>
<TenantName>MyTenantName</TenantName>
<UserName>MyUser</UserName>
<Operations>
<ImportDatasource>datasource.xml</ImportDatasource>
</Operations>
</UpdateTenant>