Skip to content

CreateLoginProviderRequest

A new login provider. allow_signup is false and allow_link true unless given. client_id and client_secret are required, except for mastodon: without both, the server registers a client at the Mastodon server.

object
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 on the administration screens and on the sign-in button of an oidc provider, 1 to 100 characters without control characters.

string
<= 100 characters
issuer

For oidc, the issuer: an https URL without user info, a query, or a fragment, exactly as the ID tokens name it. For mastodon, the server, as a domain or as https://<host>. None for github and discord.

string
<= 2048 characters
client_id

The client ID that the provider gave, up to 512 bytes.

string
<= 512 characters
scopes

Scopes to ask for besides the ones the kind needs, at most 20 (read:org for the Organizations of github); none for mastodon. The guild condition of discord adds guilds itself.

Array<string>
<= 20 items
allow_signup

Whether new users may sign up with the provider.

boolean
allow_link

Whether users may link their account to the provider.

boolean
claims

The conditions on the claims of the ID token, for oidc only, at most 10.

Array<object>
<= 10 items

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

The GitHub Organizations a user must belong to one of, for github only, at most 50.

Array<string>
<= 50 items
guilds

The IDs of the Discord servers (guilds) a user must belong to one of, for discord only, at most 50; each is a decimal ID of up to 20 digits.

Array<string>
<= 50 items
client_secret

The client secret that the provider gave, up to 1024 bytes. It is never shown again.

string
<= 1024 characters

Example generated

{
"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"
],
"client_secret": "example"
}

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

Analytics on this site