Users

Start connecting SSO

Changed on

Start connecting the instance SSO provider to the current account. Send the user to authorization_url, then finish with complete_sso, which returns linked and creates no new session. Works while SSO is required. Requires sudo mode verification.

post/users/@me/sso/link/start

Request

Request body

passwordstring
mfa_method'totp' | 'webauthn' | 'email_code'

MFA method to use for verification

mfa_codestring

MFA verification code from an authenticator app

email_code_ticketstring

Ticket from POST /users/@me/sudo/email-code, sent with mfa_method email_code

email_codestring

The 6-digit code from the email, sent with mfa_method email_code

webauthn_challengestring

WebAuthn challenge string

Response

Success

authorization_urlstring required

URL to redirect user to for SSO authentication

statestring required

State parameter for CSRF protection

redirect_uristring required

OAuth redirect URI used for the SSO provider callback

client_bindingstring required

Secret the client keeps and sends back with the code and state to complete this sign-in

Changes