Skip to main content

updateScopedConfigVariable Mutation

Updates the specified ScopedConfigVariable object.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_integrations, org_manage_customers]. 2. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_manage_integrations].

Input fields (UpdateScopedConfigVariableInput!)

ArgumentTypeDescription
keyStringThe display name of this variable.
descriptionStringAdditional notes about the Scoped Config Variable.
defaultForComponentBooleanSpecifies whether this Config Variable is required for Customers using the related Component.
inputs[InputExpression]The collection of Expressions that serve as inputs to this variable.
oAuthRedirectConfigOAuthRedirectConfigInputConfiguration for OAuth redirects.
redeployBooleanIndicates whether to redeploy Instances using Scoped Config Variable.
unsetOAuthRedirectConfigBooleanWhen true, removes oAuthSuccessRedirectUri and oAuthFailureRedirectUri from meta.
idIDThe ID of the ScopedConfigVariable to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (UpdateScopedConfigVariablePayload)

clientMutationId (String)
errors ([ErrorType!]!)
scopedConfigVariable (ScopedConfigVariable)