1. Docs
  2. API Reference
  3. SocialProviderResponseDto

SocialProviderResponseDto

Example

JSON
{
  "slug": "google",
  "kind": "google",
  "method": "google",
  "display_name": "string",
  "client_id": "string",
  "client_secret_set": false,
  "apple_team_id": "string",
  "apple_key_id": "string",
  "apple_private_key_set": false,
  "discovery_url": "string",
  "scopes": [
    "string"
  ],
  "enabled": false,
  "verified_at": "2026-04-20T12:00:00.000Z",
  "callback_url": "https://auth.example.com/v1/identity/auth/social/google/callback",
  "version": 0,
  "created_at": "2026-04-20T12:00:00.000Z",
  "updated_at": "2026-04-20T12:00:00.000Z"
}

Properties

17 properties 17 required

slug string Required

The provider's name in this Environment: the kind for a named provider, the developer's own name for a custom one.

Examplegoogle
kind enum Required
Enumgooglegithubmicrosoftappleoidc
method string Required

The sign-in method the provider adds while enabled: the kind, or `oidc:<slug>` for a custom provider. An organization's policy names it in `allowed_sign_in_methods`.

Examplegoogle
display_name string Required

What a custom provider's sign-in button says; null for a named provider.

nullable
client_id string Required
client_secret_set boolean Required

Whether a client secret is stored.

apple_team_id string Required
nullable
apple_key_id string Required
nullable
apple_private_key_set boolean Required

Whether an Apple private key is stored.

discovery_url string Required
nullable
scopes array of string Required
nullable
enabled boolean Required
verified_at string Required

When a test sign-in through a custom provider last completed. A custom provider can be enabled only while this is set.

format: date-timenullable
callback_url string Required

The redirect URI to register with the provider for this Environment's sign-ins.

Examplehttps://auth.example.com/v1/identity/auth/social/google/callback
version number Required

The value to send as `If-Match` to change this provider.

created_at string Required
format: date-time
updated_at string Required
format: date-time
Was this page helpful?

Tell us how we can improve this guide.

Canopy