Skip to content

List identity providers configured for the tenant

GET
/v1/auth/providers
curl --request GET \
--url https://example.com/v1/auth/providers \
--header 'Authorization: Bearer <token>'

Returns the OAuth 2.0 / OIDC providers a caller can login through. clientSecretRef is a REFERENCE — the plaintext client secret is never on the wire.

Page of provider configs.

Media typeapplication/json
object
data
required
Array<object>

OAuth 2.0 / OIDC provider configuration registered on a tenant. clientSecretRef is a REFERENCE resolved server-side (env-var key, secrets-manager path, KMS handle) — the plaintext client secret never crosses the wire.

object
providerId
required
string
>= 1 characters
kind
required
string
Allowed values: oauth2 oidc
clientId
required
string
>= 1 characters
clientSecretRef
required

Opaque reference resolved server-side. Never a plaintext secret.

string
>= 1 characters
authorizationEndpoint
required
string format: uri
tokenEndpoint
required
string format: uri
userinfoEndpoint
string format: uri
scopes
required
Array<string>
allowedRedirectUris

OAuth 2.1 BCP redirect-URI allowlist. Exact-string match required at /v1/auth/login. Absent/empty means no redirect-URI allowlist check (pass-through).

Array<string>
claimMapping

Per-provider claim mapping. All fields optional; closer to OIDC defaults (sub/email/name) → fewer overrides needed.

object
userId
string
>= 1 characters
email
string
>= 1 characters
displayName
string
>= 1 characters
scopes

Claim path + optional delimiter for extracting Kindgi OAuth scopes from provider claims. When absent, scopes come from the token response scope field instead.

object
claim
required
string
>= 1 characters
delimiter
string
metadata
Array<string>
metadata
object
key
additional properties
any
Example
{
"data": [
{
"kind": "oauth2"
}
]
}

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}