updateProductIntegrationSingleSignOnConfigurationSetupForm
Update the single sign-on setup form configuration within an existing product integration
This page contains
Arguments
| input UpdateProductIntegrationSingleSignOnConfigurationSetupFormInput! |
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}. They can also contain {sp.acs.url}, {sp.audience}, {sp.nameid.format}, and {sp.relay.state}, which show the values the vendor application is configured with. {sp.relay.state} is empty when none is set. A value containing <, >, " or ' is not substituted. Use the tokens in text, never inside an HTML attribute. Values are shown as stored; login-time codes such as {company.uuid} are not expanded. |
| parameters [UpdateSetupFormPlaceholderParameterInput!] | The placeholder parameters to update within a product integration setup form |
Return Fields
| setupForm ProductIntegrationSingleSignOnConfigurationSetupForm | A descriptor object used to define the setup form presented to Company Admins when importing an application to their company. |
| userErrors [UpdateProductIntegrationSingleSignOnConfigurationSetupFormError!] | 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.