Skip to content
Start free in Cloud

Start authenticated social link REST API

POST
/api/user/security/social/{provider}/start
curl --request POST \
--url http://127.0.0.1:25737/api/user/security/social/google/start \
--header 'Content-Type: application/json' \
--cookie hk_token=<hk_token> \
--data '{}'

Starts a provider authorization bound to the authenticated HitKeep account.

provider
required
string
Allowed values: google github microsoft
Media typeapplication/json
object
Examplegenerated
{}

Provider authorization URL

Media typeapplication/json
object
auth_url
required
string format: uri
Examplegenerated
{
"auth_url": "https://example.com"
}

Provider unavailable

Media typeapplication/json
object
message
string
Examplegenerated
{
"message": "example"
}