setLoginBridgeTermsState()

The setLoginBridgeTermsState() GraphQL mutation is used to set the terms state of the login bridge.

Syntax

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

graphql
setLoginBridgeTermsState(
      accepted: boolean!
   ): LoginBridge!

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

ParameterTypeRequired[a]DefaultDescription
additionalAttributesstring  Any additional attributes.
allowedUsers[User]yes A list of users allowed to access the bridge.
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.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.