Summary

The findIdentityProvider() GraphQL query field is used to get information on an identity provider for a particular user account, based on the account's email address.

API Stability Long-Term

Syntax

graphql
findIdentityProvider(
     email: string!
   ): IdentityProviderAuth

You'll need to give the email address for the account. For the results, you can get the identifier and name of the provider. Of more interest will probably be the authentication method, which will include a host of information. See the Returned Values section for details.

Example

Raw
graphql
query {
  findIdentityProvider(email: "bob@company.com") {
    id, name, authenticationMethod
  }
}
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 {
  findIdentityProvider(email: \"bob@company.com\") {
    id, name, authenticationMethod
  }
}"
}
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 {
  findIdentityProvider(email: \"bob@company.com\") {
    id, name, authenticationMethod
  }
}"
}
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 { ^
  findIdentityProvider(email: \"bob@company.com\") { ^
    id, name, authenticationMethod ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  findIdentityProvider(email: \"bob@company.com\") {
    id, name, authenticationMethod
  }
}"
}'
    "$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 {
  findIdentityProvider(email: \"bob@company.com\") {
    id, name, authenticationMethod
  }
}";
$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 {
  findIdentityProvider(email: \"bob@company.com\") {
    id, name, authenticationMethod
  }
}"
}'''

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 {
  findIdentityProvider(email: \"bob@company.com\") {
    id, name, authenticationMethod
  }
}"
}
);


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();

Returned Values

For the results, you can request the ID and name of the provider. You can also get the authentication method, and a good bit of information on authentication (e.g., the authorization type, a URL and endpoint, the client ID).

Table: IdentityProviderAuth Datatype

ParameterTypeRequiredDefaultStabilityDescription
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 25, 2024
authenticationMethodAuthenticationMethodAuthyes Long-TermThe authentication method of the authentication provider. See AuthenticationMethodAuth.
idstringyes Long-TermThe unique identifier of the authentication provider.
namestringyes Long-TermThe name of the authentication provider.