🎯API Stability
Short-TermThis API may change in future versions. Use with caution in production environments.

Summary

The updateSocialLoginSettings() mutation configures social identity provider (IdP) authentication for an organization. It controls which social providers can authenticate users: Google, GitHub, or Bitbucket. The organization can permit all accounts from a provider, or restrict access to those in a named allow list. Supply one SocialLoginSettingsInput object per provider to configure. Pass multiple objects in a single call to update several providers at once.

Syntax

graphql
updateSocialLoginSettings(
      input: [SocialLoginSettingsInput!]!
   ): Organization!

The required input argument accepts a non-empty array of SocialLoginSettingsInput objects. GraphQL permits omitting the brackets when passing a single object. The mutation returns a non-null Organization! object representing the organization after the update.

Input parameters

Each entry in the input array is a SocialLoginSettingsInput object that specifies one provider's authentication settings. All three fields are required. The socialProviderProfile field identifies the provider: Google, GitHub, or Bitbucket. The filter field controls access: AllowAll permits any account authenticated by that provider, while AllowList restricts login to the accounts enumerated in the allowList field. When filter is AllowAll, pass an empty array for allowList.

Table: SocialLoginSettingsInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowListStringyes Preview The list of social logins allowed.
filterSocialLoginFieldyes Preview Whether to allow some or all, or deny all. See SocialLoginField.
socialProviderProfileSocialProviderProfileyes Preview This name of the social provider. See SocialProviderProfile.

Example

Raw
graphql
mutation {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}
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 {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}"
}
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 {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}"
}
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 { ^
  updateSocialLoginSettings(input: ^
       { socialProviderProfile: Google, ^
         filter: AllowAll, ^
         allowList: [] ^
      } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}"
}'
    "$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 {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}";
$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 {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}"
}'''

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 {
  updateSocialLoginSettings(input:
       { socialProviderProfile: Google,
         filter: AllowAll,
         allowList: []
      } )
  { id }
}"
}
);


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

The mutation returns the updated Organization object. To confirm the applied settings, read the configs.socialLogin field, which contains the filter mode, provider name, and allow list for each configured provider. The returned object also exposes organization-level configuration, URL endpoints, usage limits, and other administrative properties.

Table: Organization Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
actionOrganizationAction):Booleanyes Short-Term The action to check if a user is allowed to perform on an organization.
cidString  Short-Term The CID corresponding to the organization.
configsOrganizationConfigsyes Short-Term Organization configurations and settings. See OrganizationDetails.
createdAtLong  Short-Term Date organization was created.
defaultCachePolicyCachePolicy  Short-Term The default cache policy of the organization. See CachePolicy. This is a preview and subject to change.
deletedAtLong  Short-Term Day organization was deleted if it was marked for deletion.
descriptionString  Short-Term The description for the Organization. Can be null.
detailsOrganizationDetailsyes Short-Term Any additional details related to the organization. See OrganizationDetails.
externalGroupSynchronizationBooleanyes Short-Term Whether there is group synchronization.
externalPermissionsBooleanyes Short-Term Whether permissions are managed externally.
idStringyes Short-Term The unique id for the Organization.
ingestUrlString  Short-Term The ingest URL for the organization.
limitsLimityes Short-Term Limits assigned to the organization. See Limit.
limitsV2LimitV2yes Short-Term Limits assigned to the organization. See LimitV2.
nameStringyes Short-Term The name for the Organization.
publicUrlString  Short-Term The public URL for the organization.
readonlyDashboardIPFilterString  Short-Term IP filter for readonly dashboard links.
searchDomainsSearchDomainyes Short-Term Search domains within the organization. See SearchDomain.
statsOrganizationStatsyes Short-Term Statistics of the organization. See OrganizationStats.
trialStartedAtLong  Short-Term Date organization's trial started.