auth

Get all available OAuth providers

Returns a list of all supported OAuth providers with their configuration details

GET/api/auth/oauth/providers/available

Authentication

Public — No Auth Required

SDK setup

Create a client instance. No authentication is required for this endpoint.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.auth.getOAuthProviders();
const result = await client.auth.getOAuthProviders();

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

No Request Yet

Send a request to see the full inspector

Responses

200List of available OAuth providers
json
{
  "providers": [
    {
      "name": "google",
      "displayName": "Google",
      "strategy": "google",
      "defaultScope": [
        "profile",
        "email"
      ],
      "callbackUrl": "/api/auth/oauth/callback/google",
      "requiredFields": [
        "clientId",
        "clientSecret"
      ]
    },
    {
      "name": "github",
      "displayName": "GitHub",
      "strategy": "github",
      "defaultScope": [
        "user:email"
      ],
      "callbackUrl": "/api/auth/oauth/callback/github",
      "requiredFields": [
        "clientId",
        "clientSecret"
      ]
    }
  ],
  "total": 29
}
{
  "providers": [
    {
      "name": "google",
      "displayName": "Google",
      "strategy": "google",
      "defaultScope": [
        "profile",
        "email"
      ],
      "callbackUrl": "/api/auth/oauth/callback/google",
      "requiredFields": [
        "clientId",
        "clientSecret"
      ]
    },
    {
      "name": "github",
      "displayName": "GitHub",
      "strategy": "github",
      "defaultScope": [
        "user:email"
      ],
      "callbackUrl": "/api/auth/oauth/callback/github",
      "requiredFields": [
        "clientId",
        "clientSecret"
      ]
    }
  ],
  "total": 29
}
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Errors

CodeMeaning
401Authentication required or invalid token.
403Access denied or insufficient permissions.

Next steps

Edit this page on GitHub