RIripple
Tenants

Update a tenant

put/v1/domains/{domainId}/omnibus/{omnibusId}/tenants/{tenantId}

Request

Path parameters

domainIdstring uuid required
omnibusIdstring uuid required
tenantIdstring uuid required

Request body

aliasstring required

Alias for the tenant within the omnibus structure

descriptionstring

Optional description for the tenant (max 250 characters)

status'LOCKED' | 'UNLOCKED'

Response

OK

idstring uuid required

Unique identifier of the tenant

omnibusIdstring uuid required

Identifier of the omnibus structure this tenant belongs to

aliasstring required

Alias of the tenant

isHostboolean required

Whether this tenant is the host tenant of the omnibus structure. This field is immutable and set at creation time.

status'LOCKED' | 'UNLOCKED' required
createdAtstring date-time required

Timestamp when the tenant was created

updatedAtstring date-time required

Timestamp when the tenant was last updated

descriptionstring

Description of the tenant

Changes

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