API Stability Long-Term

The findIdentityProvider() GraphQL query finds information on an identity provider.

For more information on identity providers, see the Authentication and Identity Providers documentation page.

Syntax

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

graphql
findIdentityProvider(
     email: string!
   ): IdentityProviderAuth!

There is no special input datatype for this query field. The IdentityProviderAuth return datatype is used to return information about the identity provider. It's described in a table in the Return Datatype section. Below is an example of how those parameters are entered:

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/graphql',
  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 Datatypes

The returned datatype IdentityProviderAuth has a few parameters. Below is a list of them along with their datatypes and a description of each:

Table: IdentityProviderAuth

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
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.