Get OAuth Providers

GET

/api/v1/sectors/{sectorID}/oauth/providers

curl --request GET \
  --url https://api.spartanauth.com/api/v1/sectors/example/oauth/providers

Returns the public OAuth provider configuration for a sector, including which providers are enabled and their non-secret metadata. Public endpoint used to render login pages and admin forms without exposing stored secrets.

Parameters

Path Parameters

sectorID

required

string

Responses

200

A successful response.

Media type application/json

object

providers

Array<object>

OAuthProviderPublicInfo is the safe-to-expose subset shown to login pages and the admin settings UI. None of the fields below are secrets — all secret/key material is write-only via OAuthProviderAdminConfig.

object

provider

string

enabled

boolean

clientID

needed by Apple JS SDK

string

redirectURI

override redirect URI (empty = auto-derived)

string

issuerURL

OIDC only: discovery document base URL

string

teamID

Apple: Team ID

string

keyID

Apple: Key ID

string

appID

GitHub App: numeric App ID (empty = OAuth App mode)

string

Example ^generated

{
  "providers": [
    {
      "provider": "example",
      "enabled": true,
      "clientID": "example",
      "redirectURI": "example",
      "issuerURL": "example",
      "teamID": "example",
      "keyID": "example",
      "appID": "example"
    }
  ]
}

default

An unexpected error response.

Media type application/json

object

code

integer format: int32

message

string

details

Array<object>

object

@type

string

key

additional properties

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}