Skip to main content

updateIntegration

form schema

Change an integration's configuration.

The new config replaces the current one and must conform to the integration type's configSchema. The change applies right away. Only some integration types accept a new config; for the others, delete the integration and create it again.

For SCIM, seat_attribute and seat_value set which users hold a seat. A change gives or releases seats for every provisioned user.

mutation {
  updateIntegration(
    organizationId: "my-org"
    id: "scim"
    input: {
      config: "{\"seat_attribute\": \"roles\", \"seat_value\": \"licensed\"}"
    }
  ) {
    result {
      id
      config
    }
    successful
    messages { field message }
  }
}
updateIntegration(
  organizationId: ID!
  id: ID!
  input: UpdateIntegrationInput!
): IntegrationPayload

Form Schema​

This mutation supports dynamic form generation using JSON Schema.

Loading schema...

Arguments​

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

Your organization's unique identifier.

updateIntegration.id ● ID! non-null scalar {#id}​

The integration type identifier to change.

updateIntegration.input ● UpdateIntegrationInput! non-null input {#input}​

Change an integration's configuration. The config payload must conform to the integration type's configSchema and replaces the current config.

Type​

IntegrationPayload object​