updateLoginBridge()

The updateLoginBridge() GraphQL mutation is used to update settings for the login bridge.

Syntax

Below is the syntax for the updateLoginBridge() mutation field:

graphql
updateLoginBridge(
      input: LoginBridgeUpdateInput!
   ): LoginBridge!

Given Datatypes

For the input (i.e., LoginBridgeUpdateInput), there are several parameters that may be given. Below is a list of them along with their datatype and a description of each:

Table: LoginBridgeUpdateInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 19, 2024
additionalAttributesstring  Any additional attributes.
allowedUsers[string]yes A list of users allowed to access the bridge.
descriptionstring  A description of the login bridge to update.
generateUserNameboolean  Whether to generate user names.
groupAttributestring  The group attributes.
groups[string]yes Any groups associated with the login bridge.
issuerstring  The issuer to update.
loginUrlstring  The URL of the login bridge.
namestring  The name of the login bridge to update.
organizationIdAttributeNamestring  The organization's unique identifier of the attribute name.
organizationNameAttributestring  The organization's name of the attribute.
privateSamlCertificatestring  The private SAML certificate.
publicSamlCertificatestring  The publlic SAML certificate.
relayStateUrlstring  The relay state URL.
remoteIdstring  The remote unique identifier of the login bridge.
samlEntityIdstring  The unique identifier of the SAML entity.
termsDescriptionstring  A description of the terms.
termsLinkstring  A link to the terms and conditions.

Returned Datatypes

The returned datatype LoginBridge has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: LoginBridge

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
additionalAttributesstring  Any additional attributes.
allowedUsers[User]yes A list of users allowed to access the bridge. See User.
anyUserAlreadyLoggedInViaLoginBridgebooleanyes True if any user in this organization has logged in to CrowdStream via LogScale. Requires manage organizations permissions.Whether to generate user names.
descriptionstringyes A description of the login bridge.
generateUserNamebooleanyes Whether to generate user names.
groupAttributestringyes Any group attributes.
groups[string]yes Any groups associated with the login bridge.
issuerstringyes The issuer of the login bridge.
loginUrlstringyes The URL for logging in.
namestringyes The name of the login bridge.
organizationIdAttributeNamestringyes The organization's unique identifier of the attribute name.
organizationNameAttributeNamestring  The organization's name of the attribute name.
publicSamlCertificatestringyes The publlic SAML certificate.
relayStateUUrlstringyes The relay state URL.
remoteIdstringyes The unique identifier of the remote connection.
samlEntityIdstringyes The unique identifier of the SAML entity.
showTermsAndConditionsbooleanyes Whether to show the terms and conditions.
termsDescriptionstringyes A description of the terms.
termsLinkstringyes A link to the terms and conditions.