user/reset-password

reset password

POST

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

/user/reset-password/

reset password › query Parameters

debug

string

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

reset password › Request Body

OdxV2ResetPassword

hash

string · minLength: 1 · required

new_password

string · minLength: 1 · maxLength: 256 · required

reset password › Responses

code

code

debug

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

messages

messages

title

title

result

emptyResult

POST/user/reset-password/

curl https://odkmedia.io/odx/api/v2/user/reset-password \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "hash": "hash",
  "new_password": "new_password"
}'

Example Request Body

{
  "hash": "hash",
  "new_password": "new_password"
}

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": {}
}

json

application/json

reset password email

POST

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

/user/reset-password/email/

send email to reset forgot password

reset password email › query Parameters

debug

string

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

reset password email › Headers

Service-Name

string · enum · required

Enum values:

odk

odc

odv

odl

Accept-Language

string · enum

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

Enum values:

zh-Hans

zh-Hant

zh-hans

zh-hant

Default: en

reset password email › Request Body

OdxV2ResetPasswordEmail

email

string · email · minLength: 1 · required

reset password email › Responses

code

code

debug

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

messages

messages

title

title

result

emptyResult

POST/user/reset-password/email/

curl https://odkmedia.io/odx/api/v2/user/reset-password/email \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Service-Name: <string>' \
  --data '{
  "email": "test@example.com"
}'

Example Request Body

{
  "email": "test@example.com"
}

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": {}
}

json

application/json

reset password email confirm

POST

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

/user/reset-password/email/confirm/

validate hash value to reset password

reset password email confirm › query Parameters

debug

string

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

reset password email confirm › Request Body

OdxV2EmailConfirm

hash

string · minLength: 1 · required

reset password email confirm › Responses

code

code

debug

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

messages

messages

title

title

result

emptyResult

POST/user/reset-password/email/confirm/

curl https://odkmedia.io/odx/api/v2/user/reset-password/email/confirm \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "hash": "hash"
}'

Example Request Body

{
  "hash": "hash"
}

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": {}
}