ユーザーパスワードのリセット
説明
このAPIを使用すると、Catalystアプリケーションのユーザーのパスワードをリセットできます。このAPIが呼び出されると、パスワードリセットリンクを含むメールがユーザーのメールアドレスに送信されます。ユーザーはリンクをクリックすると、アプリケーションの新しいパスワードを設定して保存できます。
リクエスト詳細
リクエストURL
POST
{api-domain}/baas/v1/project/{project_id}/project-user/forgotpassword
copy
api-domain
URL
Catalyst APIにアクセスするためのDC固有ドメイン
project_id
Numerical
プロジェクトの一意のID
リクエストヘッダー
Content-Type: application/json
PROJECT_ID: {ZAID}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
注意: CatalystはこのAPIリクエストを認証しません。そのため、OAuthトークンを渡したり、スコープを指定したりする必要はありません。
リクエストJSONプロパティ
platform_type
string
mandatory
許容値: web、android、ios
最大サイズ: N/A
最大サイズ: N/A
redirect_url
string
optional
ユーザーがパスワードをリセットした後にリダイレクトされるURL
最大サイズ: 200
最大サイズ: 200
user_details
json
mandatory
ユーザーの詳細を含むJSON
first_name
String
ユーザーの名
必須: いいえ
最大サイズ: 100
必須: いいえ
最大サイズ: 100
last_name
String
ユーザーの姓
必須: いいえ
最大サイズ: 100
必須: いいえ
最大サイズ: 100
email_id
String
ユーザーのメールアドレス
必須: はい
最大サイズ: N/A
必須: はい
最大サイズ: N/A
レスポンス詳細
レスポンスには、パスワードリセット操作のステータスが含まれます。
リクエスト例
copy
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/forgotpassword
-H “Content-Type: application/json” \
-d ‘{
“user_details”:{
“email_id”:“p.boyle@zylker.com”
},
“platform_type”:“web”
}’
レスポンス例
copy
{
"status": "success",
"data": "Reset link sent to your p.boyle@zylker.com email address. Please check your email :)"
}
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit