Skip to main content

scopedConfigVariable Query

Returns 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]. 3. The signed-in User has any of the following permissions for their Customer: [customer_manage_integrations]. 4. The object has attributes variable_scope with value customer and managed_by with value customer and customer with value None.. 5. The object has attributes default_for_component with value True..

Input fields​

ArgumentTypeDescription
idID!The ID of the ScopedConfigVariable object.

Return fields (ScopedConfigVariable)​

allowRemove (Boolean!)​

Specifies whether the signed-in User can remove the ScopedConfigVariable.

allowUpdate (Boolean!)​

Specifies whether the signed-in User can update the ScopedConfigVariable.

authorizeUrl (String)​

The Authorize URL of this Config Variable if associated with an OAuth 2.0 Connection.

connection (Connection)​

The Connection to which this variable is associated.

customer (Customer)​

The Customer with which this Config Variable is associated.

customerConfigVariables (CustomerConfigVariableConnection!)​

The Scoped Config Variable with which this Config Variable is associated.

customers (CustomerConnection!)​

Returns a list of Customers using this config variable.

defaultForComponent (Boolean!)​

Specifies whether this Config Variable is required for Customers using the related Component.

description (String)​

Additional notes about the Scoped Config Variable.

hasDeployedInstances (Boolean!)​

Indicates this config variable is in use on an Instance.

id (ID!)​

The ID of the object

inputs (ExpressionConnection)​

The collection of Expressions that serve as inputs to this variable.

instances (InstanceConnection!)​

Returns a list of Instances of Integrations using this config variable.

integrations (IntegrationConnection!)​

Returns a list of Integrations using this config variable.

isInUse (Boolean!)​

Indicates that this config variable is currently in use by at least one Instance or Integration version.

key (String!)​

The display name of this variable.

lastConfiguredAt (DateTime)​

The timestamp of the most recent inputs reconfiguration.

lastSuccessfulRefreshAt (DateTime)​

The timestamp of the last successful OAuth2 token refresh.

logs (LogConnection!)​

The ScopedConfigVariable which relates to the Log entry.

managedBy (ScopedConfigVariableManagedBy!)​

Enforces which group of users can modify the variable.

meta (JSONString)​

Contains arbitrary metadata about this variable.

oAuthRedirectConfig (OAuthRedirectConfig)​

Configuration for OAuth custom redirects.

refreshAt (DateTime)​

The timestamp at which the OAuth2 token will automatically be refreshed, if necessary. Only applies to OAuth2 methods where refresh is necessary.

requiredConfigVariables (RequiredConfigVariableConnection!)​

Scoped Config Variable providing configuration for this Required Config Variable.

stableKey (String!)​

The stable key for referencing this variable from Integrations. Cannot change after setting.

status (ScopedConfigVariableStatus)​

Status indicating if this Connection is working as expected or encountering issues.

variableScope (ScopedConfigVariableVariableScope!)​

Specifies the scope of the variable.

workflows (WorkflowConnection!)​

Returns a list of Workflows using this config variable.