SIsigmacomputing
Tenants

Update details of a tenant organization

Update the details of an existing tenant organization. The organization name and slug can be updated through this endpoint.

Usage notes

  • To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
  • Retrieve the tenantOrganizationId by calling the /v2/tenants endpoint.
patch/v2/tenants/{tenantOrganizationId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

tenantOrganizationIdstring required

Request body

tenantOrganizationNamestring

New name for the tenant organization

tenantOrganizationSlugstring

New URL identifier for the tenant organization

Response

The response body.

tenantOrganizationIdstring required

Unique identifier of the tenant organization

parentOrganizationIdstring required

Unique identifier of the tenant's parent organization

createdBystring required

Unique identifier of the user who created the tenant organization

updatedBystring required

Unique identifier of the user who last updated the tenant organization

createdAtstring date-time required

Timestamp when the tenant organization was created. Format: ISO 8601 timestamp

updatedAtstring date-time required

Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp

tenantOrganizationNamestring required

Name of the tenant organization to create

tenantOrganizationSlugstring required

URL identifier for the tenant organization

sharedAtstring date-time

Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp

tenantCloudProviderstring

Cloud provider the tenant organization is hosted on

tenantRegionstring

Region the tenant organization is hosted in

tenantApiUrlstring

Base URL for accessing the tenant organization API

Changes

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