Summary

The addLoginBridgeAllowedUsers() mutation adds a user to the allowed users list for a login bridge. A login bridge enables SAML-based authentication for an organization. Configure the bridge with setLoginBridge() before adding users. To remove a user from the allowed list, use removeLoginBridgeAllowedUsers().

API Stability Long-Term

Syntax

graphql
addLoginBridgeAllowedUsers(
      userID: String!
   ): LoginBridge!

The required userID argument accepts the unique identifier of the user to add. Use the users() query to retrieve user identifiers, as shown in the following example.

Hide Users Query

Show Users Query

Example

Raw
graphql
mutation {
  addLoginBridgeAllowedUsers(userID: "abc123")
  {name, issuer, samlEntityId}
}
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 {
  addLoginBridgeAllowedUsers(userID: \"abc123\")
  {name, issuer, samlEntityId}
}"
}
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 {
  addLoginBridgeAllowedUsers(userID: \"abc123\")
  {name, issuer, samlEntityId}
}"
}
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 { ^
  addLoginBridgeAllowedUsers(userID: \"abc123\") ^
  {name, issuer, samlEntityId} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addLoginBridgeAllowedUsers(userID: \"abc123\")
  {name, issuer, samlEntityId}
}"
}'
    "$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 {
  addLoginBridgeAllowedUsers(userID: \"abc123\")
  {name, issuer, samlEntityId}
}";
$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 {
  addLoginBridgeAllowedUsers(userID: \"abc123\")
  {name, issuer, samlEntityId}
}"
}'''

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 {
  addLoginBridgeAllowedUsers(userID: \"abc123\")
  {name, issuer, samlEntityId}
}"
}
);


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": {
    "addLoginBridgeAllowedUsers": {
      "name": "our-checker",
      "issuer": "mr-saml",
      "samlEntityId": "urn:oasis:names:tc:SAML:2.0:nameid-format:entity"
    }
  }
}

Input Parameters

This mutation accepts one required input parameter. Supply the unique identifier of the user to add to the allowed list. Use the users() query shown in the Syntax section to retrieve user identifiers.

Table: Input Parameters and Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
userID String yes   The unique identifier of the user to add to the login bridge allowed list. Retrieve this value from the users() query.

Returned Values

The mutation returns a LoginBridge object after the user is added. The object includes the login URL, SAML configuration, and the current allowed users list.

Table: LoginBridge Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
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: Oct 14, 2026 
additionalAttributesString  Long-Term Any additional attributes.
allowedUsersUseryes Long-Term A list of users allowed to access the bridge. See User.
anyUserAlreadyLoggedInViaLoginBridgeBooleanyes 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.
descriptionStringyes Long-Term A description of the login bridge.
generateUserNameBooleanyes Long-Term Whether to generate user names.
groupAttributeStringyes Long-Term Any group attributes.
groupsStringyes Long-Term Any groups associated with the login bridge.
issuerStringyes Long-Term The issuer of the login bridge.
loginUrlStringyes Long-Term The URL for logging in.
nameStringyes Long-Term The name of the login bridge.
organizationIdAttributeNameStringyes Long-Term The organization's unique identifier of the attribute name.
organizationNameAttributeNameString  Long-Term The organization's name of the attribute name.
publicSamlCertificateStringyes Long-Term The public SAML certificate.
relayStateUUrlStringyes Long-Term The relay state URL.
remoteIdStringyes Long-Term The unique identifier of the remote connection.
samlEntityIdStringyes Long-Term The unique identifier of the SAML entity.
showTermsAndConditionsBooleanyes Long-Term Whether to show the terms and conditions.
termsDescriptionStringyes Long-Term A description of the terms.
termsLinkStringyes Long-Term A link to the terms and conditions.