Back to API overview

Social Login

2 endpoints

OAuth sign-in with Google, Apple, Microsoft, and GitHub.

social.read
social.write

Enable or disable social login providers for an organization.

Authenticate with your organization API key. Include subOrgId as a query parameter or in the request body when using an org-wide key. Organization-scoped keys automatically target their organization.
GET
/v1/social/providers

List social login providers and enabled state. Requires social.read.

Query Parameters

ParamTypeRequiredDescription
subOrgIdstringNoOrganization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one organization.

Response — 200

{ "providers": [ { "provider": "google", "enabled": true } ] }
PUT
/v1/social/providers

Enable or disable a social provider. Requires social.write.

Query Parameters

ParamTypeRequiredDescription
subOrgIdstringNoOrganization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one organization.

Request Body

ParamTypeRequiredDescription
providerstringYesgoogle, github, apple, or microsoft
enabledbooleanYesWhether the provider is enabled
subOrgIdstringYesOrganization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one organization.

Response — 200

{ "providers": [ /* updated */ ] }