Skip to main content

IntegrationCredentialDefinition

Metadata for a stored integration credential, without its value.

type IntegrationCredentialDefinition {
  editable: Boolean!
  label: String!
  name: String!
  purpose: IntegrationCredentialPurposeEnum!
  requiredOnCreate: Boolean!
}

Fields​

IntegrationCredentialDefinition.editable ● Boolean! non-null scalar common​

Whether to enter this field directly instead of using a connection flow.

IntegrationCredentialDefinition.label ● String! non-null scalar common​

Provider-specific credential label.

IntegrationCredentialDefinition.name ● String! non-null scalar common​

Field name on IntegrationDetails and the setupIntegration and updateIntegration inputs.

IntegrationCredentialDefinition.purpose ● IntegrationCredentialPurposeEnum! non-null enum integrations​

Whether this credential identifies the app or the connected account.

IntegrationCredentialDefinition.requiredOnCreate ● Boolean! non-null scalar common​

Whether setup should collect this credential before creating the integration.

Member Of​

IntegrationConnectionDefinition object