addLoginBridgeAllowedUsers()

The addLoginBridgeAllowedUsers() GraphQL mutation field is used to add a login bridge to a given organization.

Syntax

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

graphql
addLoginBridgeAllowedUsers(
      userID: string!
    ): LoginBridge!

Returned Data Types

For the LoginBridge, there are several parameters that may be returned. They're described below:

Table: LoginBridge

ParameterTypeRequired[a]DefaultDescription
namestringyes The name of the login bridge.
issuerstringyes The issuer of the login bridge.
descriptionstringyes A description of the login bridge.
remoteIdstringyes The unique identifier of the remote connection.
loginUrlstringyes The URL for logging in.
relayStateUUrlstringyes The relay state URL.
samlEntityIdstringyes The unique identifier of the SAML entity.
publicSamlCertificatestringyes The publlic SAML certificate.
groupAttributestringyes Any group attributes.
organizationIdAttributeNamestringyes The organization's unique identifier of the attribute name.
organizationNameAttributeNamestring  The organization's name of the attribute name.
additionalAttributesstring  Any additional attributes.
groups[string]yes Any groups associated with the login bridge.
allowedUsers[User]yes A list of users allowed to access the bridge.
generateUserNamebooleanyes Whether to generate user names.
termsDescriptionstringyes A description of the terms.
termsLinkstringyes A link to the terms and conditions.
showTermsAndConditionsbooleanyes Whether to show 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.