Skip to content

AdminLoginProvider

An external login provider that users sign in, sign up, and link their accounts with. Its client secret is never shown.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
kind
required

The kind of an external login provider. oidc: an OpenID Connect provider found by its issuer’s discovery document. github: github.com. mastodon: one Mastodon server. discord: discord.com.

string
Allowed values: oidc github mastodon discord
display_name
required

The name of the provider on the administration screens, and on the sign-in button of an oidc provider as it is written.

string
issuer

The OpenID Connect issuer of an oidc provider, or the server’s URL (https://<host>) of a mastodon one; omitted for github and discord.

string
client_id
required
string
scopes
required

The scopes asked for besides the ones the kind needs, sorted.

Array<string>
allow_signup
required

Whether new users may sign up with the provider.

boolean
allow_link
required

Whether users may link their account to the provider.

boolean
claims
required

The conditions of an oidc provider, by claim; empty lets every user in.

Array<object>

A condition of an oidc provider: a user signs in only when the claim of the ID token has one of the values, such as hd for the domain of a Google Workspace organization.

object
claim
required

The name of the claim, up to 100 bytes.

string
<= 100 characters
values
required

The allowed values, 1 to 50 of up to 256 characters each, sorted.

Array<string>
>= 1 items <= 50 items
organizations
required

The GitHub Organizations, in lower case and sorted, one of which a user of a github provider must belong to; empty lets every GitHub user in.

Array<string>
guilds
required

The IDs of the Discord servers (guilds), sorted, one of which a user of a discord provider must belong to; empty lets every Discord user in.

Array<string>
state
required

Whether users sign in, sign up, and link their accounts with the provider. The sign-in screen shows only the enabled providers.

string
Allowed values: enabled disabled
state_changed_at
required
string format: date-time
callback_url
required

The redirect URI to register at the provider: https://<host>/auth/external/<id>/callback.

string
linked_users
required

The number of users whose accounts are linked to the provider; disabling or deleting it keeps them from signing in with it.

integer
created_at
required
string format: date-time
revised_at
required

When the settings last changed.

string format: date-time

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"kind": "oidc",
"display_name": "example",
"issuer": "example",
"client_id": "example",
"scopes": [
"example"
],
"allow_signup": true,
"allow_link": true,
"claims": [
{
"claim": "example",
"values": [
"example"
]
}
],
"organizations": [
"example"
],
"guilds": [
"example"
],
"state": "enabled",
"state_changed_at": "2026-04-15T12:00:00Z",
"callback_url": "example",
"linked_users": 1,
"created_at": "2026-04-15T12:00:00Z",
"revised_at": "2026-04-15T12:00:00Z"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site