Skip to main content

Third-party Authorization token Login

POST 

/auth/v1/signin/with/provider

Log in using the provider_token generated from third-party authorization information.

Request

Query Parameters

    client_id string

    The client ID corresponding to the application, which defaults to the environment ID and can be omitted

Header Parameters

    x-device-id stringrequired

    Device ID

Body

    provider_id Identity source ID (string)required
    provider_token Third-party providerToken obtained via /auth/v1/provider/token (string)required
    force_disable_sign_up Force disable auto-registration. By default, this follows server configuration. Set to true for smooth client upgrades. (boolean)
    sync_profile Whether to forcibly synchronize profile information (e.g., nickname) from third parties (boolean)

Responses

A successful response.

Response Headers
    Schema
      token_type Access Token Type (string)

      Always returns Bearer

      access_token User's Access Token (string)

      Token used to access the Cloud Development HTTP API, with a maximum length of 4096 characters

      refresh_token User's Refresh Token (string)

      When the access_token expires, it can be refreshed using the refresh_token to obtain a new access_token. The default expiration time is 31 days. Maximum length is 128 characters

      expires_in int32

      Expiration time of the access_token in seconds

      scope Authorization Scope (string)
      sub User's Unique ID (string)
      groups string[]
    Loading...