🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The loginBridgeRequest() GraphQL query returns the data required to complete a SAML login bridge authentication, including the login URL, SAML response, and relay state.

Syntax

graphql
loginBridgeRequest(): LoginBridgeRequest!

This query takes no input. Returns a non-nullable LoginBridgeRequest object. See the Returned Values section for available fields.

Example

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 Values

Returns a non-nullable LoginBridgeRequest object with three fields: loginUrl (the URL to redirect the user to for authentication), samlResponse (the SAML response string), and relayState (the relay state value used to maintain context across the SAML redirect). The table below lists all fields:

Table: LoginBridgeRequest Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
loginUrlStringyes Long-Term The URL for the login bridge.
relayStateStringyes Long-Term A relay state of the login bridge.
samlResponseStringyes Long-Term The SAML response.