setLoginBridge()

Summary

The setLoginBridge() GraphQL mutation is used to set the login bridge.

Once a login bridge has been added, you may need to use the setLoginBridgeTermsState(). To add and remove users from the allowed list, use the addLoginBridgeAllowedUsers() and removeLoginBridgeAllowedUsers() mutations. To make changes to a login bridge, use updateLoginBridge() and removeLoginBridge() to remove it, completely.

Hide Query Example

Show Allowed Users and Groups Query

To get a list of allowed users and groups, you could execute the organization() query like this:

graphql

query {
     organization {
       configs {
         subdomains: {
           loginBridge { allowedUsers, groups }
           }
       }
     }
   }

API Stability Long-Term

Syntax

graphql

setLoginBridge(
      input: LoginBridgeInput!
   ): LoginBridge!

For the input, you'll have to give the login bridge information, such as the login URL, the SAML identity. See the Input Parameters for the parameters and details.

For the results, you can get the login URL, the response from SAML, and the relay state. See the Returned Values for what's available.

Example

Raw

graphql

mutation {
  setLoginBridge( input:
    { name: "my-bridge",
      description: "My Login Bridge",
      issuer: "toll-taker",
      remoteId: "over-there-123",
      loginUrl: "https://bridge.company.com",
      relayStateUrl: "https://state.company.com",
      samlEntityId: "abc123",
      privateSamlCertificate: "something",
      publicSamlCertificate: "something",
      allowedUsers: ["bob", "ted"],
      groupAttribute: "something",
      groups: ["sales","managers"],
      organizationIdAttributeName: "something",
      generateUserName: false,
      termsDescription: "Terms of Login",
      termsLink: "https://bridge.company.com/terms.page"
    } 
  )
  { remoteId }
}

Mac OS or Linux (curl)

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setLoginBridge( input:
    { name: \"my-bridge\",
      description: \"My Login Bridge\",
      issuer: \"toll-taker\",
      remoteId: \"over-there-123\",
      loginUrl: \"https://bridge.company.com\",
      relayStateUrl: \"https://state.company.com\",
      samlEntityId: \"abc123\",
      privateSamlCertificate: \"something\",
      publicSamlCertificate: \"something\",
      allowedUsers: [\"bob\", \"ted\"],
      groupAttribute: \"something\",
      groups: [\"sales\",\"managers\"],
      organizationIdAttributeName: \"something\",
      generateUserName: false,
      termsDescription: \"Terms of Login\",
      termsLink: \"https://bridge.company.com/terms.page\"
    } 
  )
  { remoteId }
}"
}
EOF

Mac OS or Linux (curl) One-line

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  setLoginBridge( input:
    { name: \"my-bridge\",
      description: \"My Login Bridge\",
      issuer: \"toll-taker\",
      remoteId: \"over-there-123\",
      loginUrl: \"https://bridge.company.com\",
      relayStateUrl: \"https://state.company.com\",
      samlEntityId: \"abc123\",
      privateSamlCertificate: \"something\",
      publicSamlCertificate: \"something\",
      allowedUsers: [\"bob\", \"ted\"],
      groupAttribute: \"something\",
      groups: [\"sales\",\"managers\"],
      organizationIdAttributeName: \"something\",
      generateUserName: false,
      termsDescription: \"Terms of Login\",
      termsLink: \"https://bridge.company.com/terms.page\"
    } 
  )
  { remoteId }
}"
}
EOF

Windows Cmd and curl

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  setLoginBridge( input: ^
    { name: \"my-bridge\", ^
      description: \"My Login Bridge\", ^
      issuer: \"toll-taker\", ^
      remoteId: \"over-there-123\", ^
      loginUrl: \"https://bridge.company.com\", ^
      relayStateUrl: \"https://state.company.com\", ^
      samlEntityId: \"abc123\", ^
      privateSamlCertificate: \"something\", ^
      publicSamlCertificate: \"something\", ^
      allowedUsers: [\"bob\", \"ted\"], ^
      groupAttribute: \"something\", ^
      groups: [\"sales\",\"managers\"], ^
      organizationIdAttributeName: \"something\", ^
      generateUserName: false, ^
      termsDescription: \"Terms of Login\", ^
      termsLink: \"https://bridge.company.com/terms.page\" ^
    }  ^
  ) ^
  { remoteId } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setLoginBridge( input:
    { name: \"my-bridge\",
      description: \"My Login Bridge\",
      issuer: \"toll-taker\",
      remoteId: \"over-there-123\",
      loginUrl: \"https://bridge.company.com\",
      relayStateUrl: \"https://state.company.com\",
      samlEntityId: \"abc123\",
      privateSamlCertificate: \"something\",
      publicSamlCertificate: \"something\",
      allowedUsers: [\"bob\", \"ted\"],
      groupAttribute: \"something\",
      groups: [\"sales\",\"managers\"],
      organizationIdAttributeName: \"something\",
      generateUserName: false,
      termsDescription: \"Terms of Login\",
      termsLink: \"https://bridge.company.com/terms.page\"
    } 
  )
  { remoteId }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

Perl

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  setLoginBridge( input:
    { name: \"my-bridge\",
      description: \"My Login Bridge\",
      issuer: \"toll-taker\",
      remoteId: \"over-there-123\",
      loginUrl: \"https://bridge.company.com\",
      relayStateUrl: \"https://state.company.com\",
      samlEntityId: \"abc123\",
      privateSamlCertificate: \"something\",
      publicSamlCertificate: \"something\",
      allowedUsers: [\"bob\", \"ted\"],
      groupAttribute: \"something\",
      groups: [\"sales\",\"managers\"],
      organizationIdAttributeName: \"something\",
      generateUserName: false,
      termsDescription: \"Terms of Login\",
      termsLink: \"https://bridge.company.com/terms.page\"
    } 
  )
  { remoteId }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";

Python

python

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  setLoginBridge( input:
    { name: \"my-bridge\",
      description: \"My Login Bridge\",
      issuer: \"toll-taker\",
      remoteId: \"over-there-123\",
      loginUrl: \"https://bridge.company.com\",
      relayStateUrl: \"https://state.company.com\",
      samlEntityId: \"abc123\",
      privateSamlCertificate: \"something\",
      publicSamlCertificate: \"something\",
      allowedUsers: [\"bob\", \"ted\"],
      groupAttribute: \"something\",
      groups: [\"sales\",\"managers\"],
      organizationIdAttributeName: \"something\",
      generateUserName: false,
      termsDescription: \"Terms of Login\",
      termsLink: \"https://bridge.company.com/terms.page\"
    } 
  )
  { remoteId }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

Node.js

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  setLoginBridge( input:
    { name: \"my-bridge\",
      description: \"My Login Bridge\",
      issuer: \"toll-taker\",
      remoteId: \"over-there-123\",
      loginUrl: \"https://bridge.company.com\",
      relayStateUrl: \"https://state.company.com\",
      samlEntityId: \"abc123\",
      privateSamlCertificate: \"something\",
      publicSamlCertificate: \"something\",
      allowedUsers: [\"bob\", \"ted\"],
      groupAttribute: \"something\",
      groups: [\"sales\",\"managers\"],
      organizationIdAttributeName: \"something\",
      generateUserName: false,
      termsDescription: \"Terms of Login\",
      termsLink: \"https://bridge.company.com/terms.page\"
    } 
  )
  { remoteId }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Example Responses

Success (HTTP Response Code 200 OK)

json

{
  "data": {
    "setLoginBridge": {
      "remoteId": "over-there-123",
      }
    }
  }
}

Input Parameters

For the input, you'll have to give the login bridge information, such as the login URL, the SAML identity and other SAML information. These parameters and others are described in the table below:

Table: LoginBridgeInput Input Datatype

Parameter	Type	Required	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 19, 2024
additionalAttributes	string		`Long-Term`	Any additional attributes.
allowedUsers	[string]	yes	`Long-Term`	A list of users allowed to access the bridge.
description	string	yes	`Long-Term`	A description of the login bridge to update.
generateUserName	boolean	yes	`Long-Term`	Whether to generate user names.
groupAttribute	string	yes	`Long-Term`	The group attributes.
groups	[string]	yes	`Long-Term`	Any groups associated with the login bridge.
issuer	string	yes	`Long-Term`	The issuer to update.
loginUrl	string	yes	`Long-Term`	The URL of the login bridge.
name	string	yes	`Long-Term`	The name of the login bridge to update.
organizationIdAttributeName	string	yes	`Long-Term`	The organization's unique identifier of the attribute name.
organizationNameAttribute	string		`Long-Term`	The organization's name of the attribute.
privateSamlCertificate	string	yes	`Long-Term`	The private SAML certificate.
publicSamlCertificate	string	yes	`Long-Term`	The public SAML certificate.
relayStateUrl	string	yes	`Long-Term`	The relay state URL.
remoteId	string	yes	`Long-Term`	The remote unique identifier of the login bridge.
samlEntityId	string	yes	`Long-Term`	The unique identifier of the SAML entity.
termsDescription	string	yes	`Long-Term`	A description of the terms.
termsLink	string	yes	`Long-Term`	A link to the terms and conditions.

Returned Values

For the results, you can get the login URL, the response from SAML, and the relay state. These are described in the table here:

Table: LoginBridge Datatype

Parameter	Type	Required	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 26, 2024
additionalAttributes	string		`Long-Term`	Any additional attributes.
allowedUsers	[User]	yes	`Long-Term`	A list of users allowed to access the bridge. See User.
anyUserAlreadyLoggedInViaLoginBridge	boolean	yes	`Long-Term`	True if any user in this organization has logged in to CrowdStream via LogScale. Requires manage organizations permissions. Whether to generate user names.
description	string	yes	`Long-Term`	A description of the login bridge.
generateUserName	boolean	yes	`Long-Term`	Whether to generate user names.
groupAttribute	string	yes	`Long-Term`	Any group attributes.
groups	[string]	yes	`Long-Term`	Any groups associated with the login bridge.
issuer	string	yes	`Long-Term`	The issuer of the login bridge.
loginUrl	string	yes	`Long-Term`	The URL for logging in.
name	string	yes	`Long-Term`	The name of the login bridge.
organizationIdAttributeName	string	yes	`Long-Term`	The organization's unique identifier of the attribute name.
organizationNameAttributeName	string		`Long-Term`	The organization's name of the attribute name.
publicSamlCertificate	string	yes	`Long-Term`	The public SAML certificate.
relayStateUUrl	string	yes	`Long-Term`	The relay state URL.
remoteId	string	yes	`Long-Term`	The unique identifier of the remote connection.
samlEntityId	string	yes	`Long-Term`	The unique identifier of the SAML entity.
showTermsAndConditions	boolean	yes	`Long-Term`	Whether to show the terms and conditions.
termsDescription	string	yes	`Long-Term`	A description of the terms.
termsLink	string	yes	`Long-Term`	A link to the terms and conditions.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

setLoginBridge()

Summary

Syntax

Example

Input Parameters

Returned Values

Enter search term

GraphQL Mutations

GraphQL API

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

setLoginBridge()

Summary

Related

Syntax

Example

Input Parameters

Returned Values

Enter search term