Auth Service (v2)

Authenticate

Get OAuth token or start authentication flow if needed.

post/v2/auth/authenticate

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Request body

user_idstring nullable
ls_user_idstring nullable
agent_idstring nullable
providerstring required
scopesstring[] required
use_agent_builder_public_oauthboolean
force_newboolean
token_idstring uuid nullable
redirect_uristring nullable
is_defaultboolean
check_onlyboolean

Response

Successful Response

status'completed' | 'pending' | 'connection_required' | 'token_expired' required

Valid authentication status values.

urlstring nullable
auth_idstring nullable
tokenstring nullable
user_idstring nullable
metadataobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.