MAmacrometa
Administration

Modify Tenant

Update a tenant.

Note: Requires administrator permissions.

patch/_api/tenant/{tenant}

Request

Path parameters

tenantstring string required

The name of the tenant.

Request body

activeboolean

True if the tenant is active.

statusstring

Status of the tenant. Possible values: active | expired | delinquent | inactive

displayNamestring

Name of the tenant.

metadataobject

Object with metadata key-value pairs.

Example request

{
  "active": true,
  "status": "active",
  "metadata": {
    "key": "value"
  }
}

Response

Successfully updated tenant.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

Example response

{
  "code": 200,
  "result": [
    {
      "tenant": "Test",
      "active": true,
      "status": "available",
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.