• Product integration
  • >
  • Objects
  • >
  • ProductIntegrationSingleSignOnConfigurationSetupForm

Preview

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

ProductIntegrationSingleSignOnConfigurationSetupForm

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

This page contains

Fields

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: [ProductIntegrationSetupFormPlaceholderParameter!] PREVIEW

A descriptor object used to define the data to be collected from Company Admins when importing an application to their company. The placeholder identifiers can be used within your configuration fields and are automatically replaced with the values entered by the Company Administrator.

Parent objects of ProductIntegrationSingleSignOnConfigurationSetupForm

ProductIntegrationBookmarkConfiguration PREVIEW

The configuration used for Bookmark single sign-on in a product integration.

ProductIntegrationOpenIdConfiguration PREVIEW

The configuration used for OpenID 2.0 single sign-on in a product integration.

ProductIntegrationOpenIdConnectConfiguration PREVIEW

The configuration used for OpenID Connect single sign-on in a product integration.

ProductIntegrationSamlConfiguration PREVIEW

The configuration used for SAML single sign-on in a product integration.

Mutations for ProductIntegrationSingleSignOnConfigurationSetupForm

addProductIntegrationSingleSignOnConfigurationSetupForm PREVIEW

Add a single sign-on setup form configuration to an existing product integration

updateProductIntegrationSingleSignOnConfigurationSetupForm PREVIEW

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