Update a user attribute for tenants (Beta)

PATCH

/v2/user-attributes/:userAttributeId/tenants

Update a user attribute for one or more tenants. Currently, this endpoint only supports deleting a user attribute assignment.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

Retrieve the userAttributeId by calling the /v2/user-attributes endpoint.
Specify one or more tenants by tenantOrganizationId. Retrieve the tenantOrganizationId by calling the /v2/tenants endpoint and using the tenantOrganizationId included in the response.

Update a user attribute for one or more tenants. Currently, this endpoint only supports deleting a user attribute assignment. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint. - Specify one or more tenants by tenantOrganizationId. Retrieve the **tenantOrganizationId** by calling the [/v2/tenants](https://help.sigmacomputing.com/reference/list-tenants) endpoint and using the `tenantOrganizationId` included in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

userAttributeIdstringRequired

Request

The request body.

deletelist of objectsRequired

The tenants whose assignments are to be revoked.

Response

The response body.

$	curl -X PATCH https://api.sigmacomputing.com/v2/user-attributes/userAttributeId/tenants \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"delete": [
>	{
>	"tenantOrganizationId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890"
>	},
>	{
>	"tenantOrganizationId": "f0e1d2c3-b4a5-6789-0abc-def123456789"
>	}
>	]
>	}'