Sigma REST APITenants{tenantOrganizationId}

Update details of a tenant organization

View as Markdown
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](https://help.sigmacomputing.com/reference/list-tenants) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

tenantOrganizationIdstringRequired

Request

The request body.
tenantOrganizationNamestringOptional
New name for the tenant organization
tenantOrganizationSlugstringOptional
New URL identifier for the tenant organization

Response

The response body.
tenantOrganizationIdstring
Unique identifier of the tenant organization
parentOrganizationIdstring
Unique identifier of the tenant's parent organization
createdBystring
Unique identifier of the user who created the tenant organization
updatedBystring
Unique identifier of the user who last updated the tenant organization
createdAtdatetime

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

updatedAtdatetime

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

tenantOrganizationNamestring
Name of the tenant organization to create
tenantOrganizationSlugstring
URL identifier for the tenant organization
sharedAtdatetimeOptional

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

tenantCloudProviderstringOptional
Cloud provider the tenant organization is hosted on
tenantRegionstringOptional
Region the tenant organization is hosted in
tenantApiUrlstringOptional
Base URL for accessing the tenant organization API