HEhexclave
Oauth

OAuth authorize endpoint

Changed on

This endpoint is used to initiate the OAuth authorization flow. there are two purposes for this endpoint: 1. Authenticate a user with an OAuth provider. 2. Link an existing user with an OAuth provider.

get/auth/oauth/authorize/{provider_id}

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/auth/oauth/authorize/{provider_id}
  • Auth
    none declared

Path parameters

provider_idstring required

Query parameters

type'authenticate' | 'link'
tokenstring
provider_scopestring
error_redirect_uristring
after_callback_redirect_urlstring
stack_response_mode'json' | 'redirect'

Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided.

hexclave_response_mode'json' | 'redirect'

Response mode for the OAuth authorize endpoint. Defaults to 'redirect' if not provided.

bot_challenge_tokenstring
bot_challenge_phase'invisible' | 'visible'
bot_challenge_unavailable'true'
client_idstring required
client_secretstring required
redirect_uristring required
scopestring required
statestring required
grant_type'authorization_code' required
code_challengestring required
code_challenge_method'S256' required
response_typestring required

Response

Successful response

locationstring required

Changes

  • 198347feb65dRevision changes
    • breaking

      the query request parameter code_challenge_method was restricted to a list of enum values

    • info

      added the new enum value S256 to the query request parameter code_challenge_method

  • de6e4ea31e6aRevision changes
    • breaking

      for the query request parameter stack_response_mode, default value redirect was removed

    • info

      added the new optional query request parameter hexclave_response_mode