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

Summary

The setLoginBridgeTermsState() mutation records whether a user has accepted the terms of use for a login bridge. Use this mutation after creating or updating a login bridge that has terms configured. The mutation returns the updated LoginBridge object reflecting the new terms state.

Syntax

graphql
setLoginBridgeTermsState(
      accepted: Boolean!
   ): LoginBridge!

The required accepted argument is a non-null Boolean that records whether the user has accepted the login bridge terms. The mutation returns a non-null LoginBridge object.

The returned LoginBridge object includes the login URL, the public SAML certificate, and the relay state URL. The Returned Values section lists all available fields.

Example

Raw
graphql
mutation {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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 {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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 {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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 { ^
  setLoginBridgeTermsState(  ^
       accepted: true ^
  ) ^
  { remoteId } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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 {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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 {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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 {
  setLoginBridgeTermsState( 
       accepted: true
  )
  { 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": {
    "setLoginBridgeTermsState": {
      "remoteId": "over-there-123",
      }
    }
  }
}

Input Parameters

Provide one required Boolean argument to record the terms acceptance state.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
accepted boolean yes   Set to true to record that the user accepted the login bridge terms of use. Set to false to record that the user declined.

Returned Values

The mutation returns the updated LoginBridge object. Available fields include the login URL, the public SAML certificate, and the relay state URL, as described in the following table.

Table: LoginBridge Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
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.