updateCustomAttribute

form schema

Replace the closed set of values for an existing custom attribute.

Adding a value is always accepted. Removing a value is refused while a policy or grant condition on this key would be left matching no permitted value; the error names each one so you can edit or delete it first.

Resources tagged before this update are not validated or rewritten. A resource keeps a value the attribute no longer declares, and updates to that resource still succeed. Set the attribute to a value from the new set to clear it. New writes must use a value from the new set. Requires the organization:manageCustomAttributes action.

updateCustomAttribute(
  organizationId: ID!
  id: UUID!
  input: UpdateCustomAttributeInput!
): CustomAttributePayload

Form Schema

This mutation supports dynamic form generation using JSON Schema.

• JSON Schema
• UI Schema

Loading schema...

Arguments

updateCustomAttribute.organizationId ● ID! non-null scalar {#organization-id}

Your organization's unique identifier.

updateCustomAttribute.id ● UUID! non-null scalar {#id}

The identifier of the custom attribute to update.

updateCustomAttribute.input ● UpdateCustomAttributeInput! non-null input {#input}

Replace the closed set of values for an existing custom attribute. The key and scope are immutable.

Type

CustomAttributePayload object