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 a sub-organization.
Authenticate with your organization API key. Include
subOrgId as a query parameter or in the request body when using an org-wide key. Sub-org-scoped keys automatically target their sub-organization.GET
/v1/social/providersList social login providers and enabled state. Requires social.read.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
| subOrgId | string | No | Sub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org. |
Response — 200
{ "providers": [ { "provider": "google", "enabled": true } ] }
PUT
/v1/social/providersEnable or disable a social provider. Requires social.write.
Query Parameters
| Param | Type | Required | Description |
|---|---|---|---|
| subOrgId | string | No | Sub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org. |
Request Body
| Param | Type | Required | Description |
|---|---|---|---|
| provider | string | Yes | google, github, apple, or microsoft |
| enabled | boolean | Yes | Whether the provider is enabled |
| subOrgId | string | Yes | Sub-organization ID. Required for org-wide keys on write operations; optional on list when the key is scoped to one sub-org. |
Response — 200
{ "providers": [ /* updated */ ] }