Tenants

Modify the details of the given tenant.

put/v2/organizations/{organization}/tenants/{tenant}

Request

Path parameters

organizationstring required

Organization name.

tenantstring required

Tenant name.

Request body

deletionProtectionEnabledboolean

When set, prevents the resource from being deleted. In order to delete the resource this property needs to be set to false first.

descriptionstring
displayNamestring
etagstring
securityDomainstring

Security domains can be used to group different resources under the same security domain. Although security domain is not resource itself currently, it follows a fqn format organizations/myorg/securitydomains/mysecuritydomain, and a child cannot override any ancestor's security domain. Once a security domain is assigned to a Tenant, all the children resources will belong to that security domain in the same way a Workspace belongs to a Tenant, a Workspace will also belong to the security domain assigned to the Tenant. Security domains can also be used to define Security settings Authorization rules in which you can allow or deny request from or to a security domain.

Response

A successful response.

fqnstring
displayNamestring
etagstring
descriptionstring
securityDomainstring

Security domains can be used to group different resources under the same security domain. Although security domain is not resource itself currently, it follows a fqn format organizations/myorg/securitydomains/mysecuritydomain, and a child cannot override any ancestor's security domain. Once a security domain is assigned to a Tenant, all the children resources will belong to that security domain in the same way a Workspace belongs to a Tenant, a Workspace will also belong to the security domain assigned to the Tenant. Security domains can also be used to define Security settings Authorization rules in which you can allow or deny request from or to a security domain.

deletionProtectionEnabledboolean

When set, prevents the resource from being deleted. In order to delete the resource this property needs to be set to false first.

Changes

No recorded changes to this operation across all 3 revisions of this API.