addLoginBridgeAllowedUsers()

Summary

The addLoginBridgeAllowedUsers() GraphQL mutation field is used to add a user to the list of allowed login bridge users.

To remove a user from the allowed list, use the removeLoginBridgeAllowedUsers() mutation. To add a login bridge, use setLoginBridge(). To make changes, use updateLoginBridge() and removeLoginBridge() to delete it, completely.

Hide Query Example

Show Allowed Users Query

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

graphql

query {
     organization {
       configs {
         subdomains: {
           loginBridge { allowedUsers { id, username } }
           }
       }
     }
   }

API Stability Long-Term

Syntax

graphql

addLoginBridgeAllowedUsers(
      userID: string!
    ): LoginBridge!

You'll have to give the unique identifier of the login bridge user. Click on Show Query link below for an example of how to get a user identifier.

Hide Query Example

Show Users Query

To get a list of users, you could execute the users() like this:

graphql

query {
     users { id, username  }
     }
   }

From the results of the query here, you can get the unique identifiers of the users you want to add.

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

For the input, you will have to give the unique identifier of the login bridge user. Click on the Show Query link in the Syntax section above for an example of how to get a user identifier.

Table: Input Parameters & Datatypes

Parameter	Type	Required	Default	Description
This table contains all input parameters for this mutation.
userID	string	yes		The unique identifier of the login bridge user.

Returned Values

For the results, you can get the login URL, SAML information, and other values you might need. 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