user/social-auth

title

title

SocialAuthAuthFacebookSchema

POST/user/social-auth/auth/apple/

curl https://odkmedia.io/odx/api/v2/user/social-auth/auth/apple \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --data '{
  "code": "code",
  "email": "test@example.com",
  "first_name": "first_name",
  "last_name": "last_name",
  "redirect_uri": "redirect_uri"
}'

Example Request Body

{
  "code": "code",
  "email": "test@example.com",
  "first_name": "first_name",
  "last_name": "last_name",
  "redirect_uri": "redirect_uri"
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "token": "token",
    "user": {
      "email": "test@example.com",
      "external": {
        "kcp": {
          "user_id": "user_id",
          "user_type": "Anonymous"
        }
      },
      "id": 0,
      "is_email_verified": true,
      "is_odk_coupon_user": true,
      "login_type": "email",
      "name": "name",
      "subscription_expire_date": "2024-08-25",
      "subscription_interval_unit": "month",
      "subscription_is_cancellable": false,
      "subscription_max_profile_count": 0,
      "subscription_price": 0,
      "subscription_provider": "web",
      "subscription_trial_end_date": "2024-08-25",
      "subscription_type": "basic",
      "userinfo": {
        "birthday": "2001-01-01",
        "gender": "m",
        "is_receive_mail": true,
        "language": "en"
      }
    }
  }
}

json

application/json

auth with facebook

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/auth/facebook/

Authorize with response from 'Facebook login'

auth with facebook › query Parameters

debug

string

If value is "on", debug is included in response.

auth with facebook › Headers

Service-Name

string · enum · required

Only "odk" is supported.

Enum values:

odk

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

auth with facebook › Request Body

access_token

string · required

Access token

expires_in

integer · min: 0 · required

Time remaining before token expires (second)

auth with facebook › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

POST/user/social-auth/auth/facebook/

curl https://odkmedia.io/odx/api/v2/user/social-auth/auth/facebook \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --data '{
  "access_token": "access_token",
  "expires_in": 0
}'

Example Request Body

{
  "access_token": "access_token",
  "expires_in": 0
}

json

Example Responses

{
  "code": "code",
  "debug": {
    "device": {
      "app_version": "app_version",
      "device_identifier": "device_identifier",
      "os": "os",
      "os_version": "os_version",
      "package_name": "package_name"
    },
    "request": {
      "body": {},
      "country": "country",
      "custom_headers": {},
      "ip": "ip",
      "qs": {},
      "user_agent": "user_agent"
    }
  },
  "messages": {},
  "title": "title",
  "result": {
    "token": "token",
    "user": {
      "email": "test@example.com",
      "external": {
        "kcp": {
          "user_id": "user_id",
          "user_type": "Anonymous"
        }
      },
      "id": 0,
      "is_email_verified": true,
      "is_odk_coupon_user": true,
      "login_type": "email",
      "name": "name",
      "subscription_expire_date": "2024-08-25",
      "subscription_interval_unit": "month",
      "subscription_is_cancellable": false,
      "subscription_max_profile_count": 0,
      "subscription_price": 0,
      "subscription_provider": "web",
      "subscription_trial_end_date": "2024-08-25",
      "subscription_type": "basic",
      "userinfo": {
        "birthday": "2001-01-01",
        "gender": "m",
        "is_receive_mail": true,
        "language": "en"
      }
    }
  }
}

json

application/json

de-authorize

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/deauthorize/{backend_name}/{service_name}/

de-authorize › path Parameters

backend_name

string · enum · required

Enum values:

facebook

apple

service_name

string · required

de-authorize › query Parameters

debug

string

If value is "on", debug is included in response.

de-authorize › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

result

disconnect

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/disconnect/{backend_name}/

disconnect › path Parameters

backend_name

string · enum · required

Enum values:

facebook

apple

disconnect › query Parameters

debug

string

If value is "on", debug is included in response.

disconnect › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

result

user/reset-password user/verify-email

auth with apple

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/auth/apple/

Authorize with response from 'Sign in with Apple'

auth with apple › query Parameters

debug

string

If value is "on", debug is included in response.

auth with apple › Headers

Service-Name

string · enum · required

Only "odk" is supported.

Enum values:

odk

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

auth with apple › Request Body

SocialAuthAuthAppleSchema

code

string · required

Authorization code

email

string · email

first_name

string

last_name

string

redirect_uri

string

Redirect URI used in initial authorization request

auth with apple › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

SocialAuthAuthFacebookSchema

auth with facebook

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/auth/facebook/

Authorize with response from 'Facebook login'

auth with facebook › query Parameters

debug

string

If value is "on", debug is included in response.

auth with facebook › Headers

Service-Name

string · enum · required

Only "odk" is supported.

Enum values:

odk

Accept-Language

string · enum

"zh-Hans", "zh-Hant" is deprecated.

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

auth with facebook › Request Body

access_token

string · required

Access token

expires_in

integer · min: 0 · required

Time remaining before token expires (second)

auth with facebook › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

de-authorize

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/deauthorize/{backend_name}/{service_name}/

de-authorize › path Parameters

backend_name

string · enum · required

Enum values:

facebook

apple

service_name

string · required

de-authorize › query Parameters

debug

string

If value is "on", debug is included in response.

de-authorize › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

result

disconnect

POST

https://odkmedia.io/odx/api/v2

/user/social-auth/disconnect/{backend_name}/

disconnect › path Parameters

backend_name

string · enum · required

Enum values:

facebook

apple

disconnect › query Parameters

debug

string

If value is "on", debug is included in response.

disconnect › Responses

code

code

debug

This property is included when debug is "on" in querystring.

messages

title

title

result