Social API

API endpoints for managing the social identity providers used for social login and registration.

In addition to reference information for each endpoint, this section of the documentation includes the following articles:








Tokens and Authentication

EndpointMethods

Authenticate a Social Login

/auth_info
Authenticate a user logging in by using a social login provider.
  • POST

Exchange a Social Login Token for an Access Token

/signin/oauth_token
Exchange a social identity provider OAuth token or IDP token for an Identity Cloud social login token.
  • POST




Social Login Providers

EndpointMethods

List Your Social Login Providers

/get_available_providers
View the social login identity providers that can be used by an application.
  • POST

List Your Configured Social Login Providers

/providers
View the social login providers configured for an application
  • POST

Assign Social Login Providers

/set_auth_providers    
Update the set of social login identity providers users can employ when logging on or registering.
  • POST




Social Login Settings and Configuration

EndpointMethods

Add a Domain to an Allow List

/add_domain_patterns     
Add a domain to an application allow list. If the allow list is configured, then only the domains included on that list are allowed to communicate with your social login application.
  • POST

List Your Social Login Application Settings

/get_app_settings
View application properties such as the privacy policy and favicon URLs.
  • POST

View a Domain Allow List

/get_domain_patterns
View the domains on an application allow list. If the allow list is configured, then only the domains included on that list are allowed to communicate with your social login application.
  • POST

Modify Social Login Application Settings

/set_app_settings
Update application properties such as the privacy policy and favicon URLs.
  • POST

Modify a Domain Allow List

/set_domain_patterns
Update the allow list for an application. If the allow list is configured, then only the domains included on that list are allowed to communicate with your social login application.
  • POST




User Profiles

EndpointMethods

Associate a Primary Key with a Social Login Provider

/map
Associate a primary key with a user's social identity.
  • POST

Remove a Social Login Provider from a Primary Key

/unmap
Remove a social login identity provider from a user's primary key.
  • POST