Preview

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

updateProductIntegrationOpenIdConnectConfiguration

Update the OpenID Connect single sign-on configuration within an existing product integration

This page contains

    Authorization Rules

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

    Scopes

    product.integrations.write.instance

    product.integrations.write.tenant

    product.integrations.write.vendor

    Arguments

    input UpdateProductIntegrationOpenIdConnectConfigurationInput! PREVIEW

    UpdateProductIntegrationOpenIdConnectConfigurationInput fields

    integrationConfigurationId ID!

    Unique ID of the product integration configuration the OpenID Connect single sign-on configuration will be updated within.

    clientCreationMethod ProductIntegrationOpenIdConnectCredentialMethod PREVIEW

    Defines if an OpenID Connect client configuration should be unique to each subscription or shared across subscriptions. Cannot be edited after publish.

    grantTypes [ProductIntegrationOpenIdConnectGrantType!] PREVIEW

    The allowed OAuth 2.0 grants types for this product integration

    redirectUrls [String!]

    The list of URLs where the authorization code is allowed to be sent during SSO

    allowOidcScope Boolean

    Defines if the openid scope scope is allowed to be requested. Must be set to TRUE.

    allowUserScopes Boolean

    Defines if the email, profile, and company scopes are allowed to be requested.

    allowRoleScopes Boolean

    Defines if role scopes (e.g. ROLE_USER) are allowed to be requested.

    initiateLoginUrl String

    URL a user is redirected to when they click the 'MyApps' tile to initiate single sign-on.

    logoutUrl String

    URL used to log a user out of your application. Asynchronously called when user logs out of the marketplace.

    Return Fields

    openIdConnectConfiguration ProductIntegrationOpenIdConnectConfiguration PREVIEW

    The updated OpenID Connect configuration within a product integration

    userErrors [UpdateProductIntegrationOpenIdConnectConfigurationError!] 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.