API Stability Long-Term

The identityProvider() GraphQL query is used to get information on a specific identity provider.

For more information on identity providers, see the Requirements for identity provider configuration documentation page.

Syntax

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

graphql
identityProvider(
     id: string!
   ): IdentityProviderAuthentication!

Below is an example of how this query field might be used:

Raw
graphql
query {
  identityProvider(id: "idp-1234") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}
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 {
  identityProvider(id: \"idp-1234\") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}"
}
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 {
  identityProvider(id: \"idp-1234\") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}"
}
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 { ^
  identityProvider(id: \"idp-1234\") { ^
    id, name,  ^
    humioManaged,  ^
    lazyCreateUsers ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  identityProvider(id: \"idp-1234\") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}"
}'
    "$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 {
  identityProvider(id: \"idp-1234\") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}";
$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 {
  identityProvider(id: \"idp-1234\") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}"
}'''

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 {
  identityProvider(id: \"idp-1234\") {
    id, name, 
    humioManaged, 
    lazyCreateUsers
  }
}"
}
);


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 Datatypes

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

Table: IdentityProviderAuthentication

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 17, 2024
debugbooleanyes Long-TermWhether debug mode is enabled.
defaultIdpbooleanyes Long-TermThe default identity provider system.
domains[string]yes Long-TermA list of domains associated with the identity provider.
humioManagedbooleanyes Long-TermWhether authentication is managed by LogScale.
idstringyes Long-TermThe unique identifier of the identity provider used for authentication.
lazyCreateUsersbooleanyes Long-TermWhether to wait to create users until last moment when needed.
namestringyes Long-TermThe name of the identity provider.