Skip to content
Chatto v0.5.0

ExternalIdentityAuthService

Chatto exposes this service below /api/connect.

Shared message and enum definitions are documented in Shared Types And Enums.

Public external identity authentication operations.

Reads safe metadata for a pending create/link flow. This public RPC requires a valid pending-flow capability token and returns NOT_FOUND when the token is unknown or expired. Returns FAILED_PRECONDITION when a managed provider username cannot be assigned; the user must contact the operator.

POST /api/connect/chatto.auth.v1.ExternalIdentityAuthService/GetPendingExternalIdentity

Request to inspect a pending external identity flow.

FieldTypeDescription
tokenstringRaw pending flow token from the provider callback redirect.

Result: GetPendingExternalIdentityResponse

Section titled “Result: GetPendingExternalIdentityResponse”

Result of inspecting a pending external identity flow.

FieldTypeDescription
pendingPendingExternalIdentityPending flow metadata.

Creates a passwordless account from a pending provider identity. This public RPC requires a valid create-flow capability token.

POST /api/connect/chatto.auth.v1.ExternalIdentityAuthService/CreateExternalIdentityAccount

Input: CreateExternalIdentityAccountRequest

Section titled “Input: CreateExternalIdentityAccountRequest”

Request to create a new passwordless account from a pending provider identity.

FieldTypeDescription
tokenstringRaw pending create token from the provider callback redirect.
loginstringDesired username. Ignored when choose_username is externally managed; the server assigns a name from the verified provider claim in that case. Otherwise, it must contain 2 to 32 characters and use a valid username format.
display_namestringDesired display name. When omitted, the server uses a valid provider hint and otherwise falls back to the assigned username.
invitation_codestringRequired on invite-only servers when the flow has no valid invitation. A supplied code replaces the flow’s invitation for this attempt; an invalid code fails without fallback. Consumed only when account creation succeeds.

Result: CreateExternalIdentityAccountResponse

Section titled “Result: CreateExternalIdentityAccountResponse”

Result of creating an account from a pending provider identity.

FieldTypeDescription
user_idstringNewly created user ID.
loginstringNewly created username.
tokenstringShort-lived bearer access token for the new session.
refresh_tokenstringRotating refresh credential for renewing the bearer session.
expires_inint64Lifetime of the access token in seconds.
refresh_token_expires_inint64Remaining lifetime of the current renewable-session window in seconds. A successful refresh can advance this window for an active session.

Links a provider identity using a pending link-flow capability token. This public RPC requires a valid link-flow capability token.

POST /api/connect/chatto.auth.v1.ExternalIdentityAuthService/ConfirmExternalIdentityLink

Request to confirm a pending provider link using the flow capability token.

FieldTypeDescription
tokenstringRaw pending link token from the provider callback redirect.

Result: ConfirmExternalIdentityLinkResponse

Section titled “Result: ConfirmExternalIdentityLinkResponse”

Result of confirming a provider identity link.

FieldTypeDescription
linked_identitychatto.api.v1.LinkedExternalIdentityLinked identity metadata.

Cancels a pending provider identity flow. This public RPC requires a valid pending-flow capability token.

POST /api/connect/chatto.auth.v1.ExternalIdentityAuthService/CancelExternalIdentityFlow

Request to cancel a pending external identity flow.

FieldTypeDescription
tokenstringRaw pending flow token.

Result: CancelExternalIdentityFlowResponse

Section titled “Result: CancelExternalIdentityFlowResponse”

Result of cancelling a pending external identity flow.