The updateSocialLoginSettings() GraphQL mutation is used to update the social login options for an organization. This field is not yet available. It's described here as a preview. It requires that the feature be enabled for the organization.

For more information on user authorization, see the Managing Users & Permissions documentation page.

Syntax

Below is the syntax for the updateSocialLoginSettings() mutation field:

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

Given Datatypes

For the given datatype, SocialLoginSettingsInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: SocialLoginSettingsInput

ParameterTypeRequired[a]DefaultDescription
socialProviderProfileSocialProviderProfileyes This datatype is an enumerated list: Google, Github, or Bitbucket.
filterSocialLoginFieldyes This datatype is an enumerated list: AllowAll, DenyAll, or AllowSelected.
allowList[string]yes The list of social logins allowed.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

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

Table: Organization

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique id for the Organization.
namestringyes The name for the Organization.
descriptionstring  The description for the Organization. Can be null.
detailsOrganizationDetailsyes Any additional details related to the organization (see OrganizationDetails Table).
statsOrganizationStatsyes Statistics of the organization (see OrganizationStats Table).
configsOrganizationConfigsyes Organization configurations and settings (see OrganizationDetails Table).
searchDomains[SearchDomain]yes Search domains within the organization (see SearchDomain Table).
readonlyDashboardIPFilterstring  IP filter for readonly dashboard links.
createdAtlong  Date organization was created.
trialStartedAtlong  Date organization's trial started.
isActionAllowedtypeyes Check if current user has a given permission in organization. OrganizationAction is the action to check if a user is allowed to perform on an organization (see OrganizationAction Table).
limits[Limit]yes Limits assigned to the organization (see Limit Table).
externalPermissionsbooleanyes Whether permissions are managed externally.
externalGroupSynchronizationbooleanyes Whether there is group synchronization.
defaultCachePolicyCachePolicy  The default cache policy of this organization. PREVIEW: Cache policies are a limited feature and is subject to change. See CachePolicy Table.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.