API Stability Long-Term

The loginBridgeRequest() GraphQL query is used to make a login bridge request.

Related to this query are the setLoginBridge(), updateLoginBridge(), and removeLoginBridge() mutation fields.

Syntax

Below is the syntax for the loginBridgeRequest() query field:

graphql
loginBridgeRequest: LoginBridgeRequest!

There are no special input parameters for this query field. For the results, you can request the login URL, and some other information. See the Returned Datatype section.

Example

Below is an example using this query field:

Raw
graphql
query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}
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" : "query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}"
}
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" : "query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}"
}
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" : "query { ^
  loginBridgeRequest  ^
  { loginUrl,  ^
    relayState } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}"
}'
    "$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 = "query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}";
$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" : "query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}"
}'''

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" : "query {
  loginBridgeRequest 
  { loginUrl, 
    relayState }
}"
}
);


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": {
    "loginBridgeRequest": {
      "loginUrl": "https://bridge.company.com",
      "relayState": "Active"
    }
  }
}

Returned Datatype

The returned datatype provides the login URL, the response from SAML, and the relay state. These are described in the table here:

Table: LoginBridgeRequest

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 26, 2024
loginUrlstringyes Long-TermThe URL for the login bridge.
relayStatestringyes Long-TermA relay state of the login bridge.
samlResponsestringyes Long-TermThe SAML response.