認証リクエスト
ユーザー情報の照会や更新を行うには、まず認証トークンを発行する必要があります。
発行されたトークンは1分間有効で、その後のすべてのリクエストのHTTPヘッダーにX-Access-Token
を含める必要があります。
このトークンにより、ユーザーアカウントの安全性を維持し、長期セッションなしで安全に認証を行うことができます。
このAPIはパーソナルプラン以上でご利用いただけます。
POST
/api/user/v1/auth
{
"eml": "your@gmail.com"
}
Request Parameters
- emlstring
- メールアドレス。
ビジネスプラン以上で、組織内に追加されたユーザー情報を照会または変更する際に指定します。
パーソナルおよびプレミアムプランでは、この値は無視されます。
{
"code": 0,
"message": "",
"result": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
Response Parameters
- codeinteger
- 応答コード: 0 = 成功、それ以外の値 = エラー
- messagestring
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- resultstring
- ユーザー情報の照会および更新を行う際は、HTTPヘッダーの
X-Access-Token
項目に追加する必要があります。
トークンは1分間有効で、有効期限後は再発行(本APIの再呼び出し)が必要です。