Skip to main content
POST
Register a sign-in application

Authorizations

Authorization
string
header
required

Organization key (alk_…) created under Settings; acts for the whole organization

Body

application/json
name
string
required

Shown to agents on the sign-in page

Required string length: 1 - 120
redirect_uris
string[]
required

HTTPS callback URLs; http://localhost is allowed for development

Required array length: 1 - 10 elements
Required string length: 1 - 2048
website
string

https URL shown to agents

Maximum string length: 2048
logo_url
string
Maximum string length: 2048
description
string

Shown in the directory; required to be listed

Maximum string length: 300
listed
boolean

List the application in the public directory (needs description and website)

initiate_login_uri
string

Where an agent that starts the sign-in from its side lands (OpenID Connect initiate_login_uri); receives iss and login_hint

Maximum string length: 2048
max_signups_per_owner
integer | null

How many agents of one owner may sign in; 0 pauses new agents, omit for no cap

Required range: 0 <= x <= 100000

Response

Application with its secret

application
object
required
client_secret
string
required

Shown once