updateProductIntegrationSingleSignOnConfigurationSetupForm is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.


Update the single sign-on setup form configuration within an existing product integration

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:






    input UpdateProductIntegrationSingleSignOnConfigurationSetupFormInput PREVIEW

    UpdateProductIntegrationSingleSignOnConfigurationSetupFormInput fields

    integrationConfigurationId ID!

    Unique ID of the product integration configuration the setup form will be updated in.

    overview String

    An overview or greeting that will be presented to the user when prompted to configure this application for single sign-on.

    instructions String

    Provide the user with instructions to configure single sign-on. Instructions can contain the following placeholders: {idp.issuer}, {idp.login.url}, {sp.login.url}, {certificate.url}, {certificate.content}, {certificate.fingerprint}, {metadata.url}, or {marketplace.url}.

    parameters [UpdateSetupFormPlaceholderParameterInput!] PREVIEW

    The placeholder parameters to update within a product integration setup form

    Return Fields

    setupForm ProductIntegrationSingleSignOnConfigurationSetupForm PREVIEW

    A descriptor object used to define the setup form presented to Company Admins when importing an application to their company.

    userErrors [UpdateProductIntegrationSingleSignOnConfigurationSetupFormError!] PREVIEW

    A list of errors

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.