POST Client Auth 解説

本API利用開始時にお渡しするID、パスワードを使い認証することにより、各API利用時に必要なトークンを取得します

概要

リクエストされたテナントID、認証ID、認証パスを基に認証を行うAPI。
テナントID、認証ID、認証パスを用いてCognitoにアクセスし、認証を行いトークンを取得する。
認証が成功した場合、取得したトークンをレスポンスコード「200」として返す。
認証に失敗した場合はレスポンスコード「401」を返す。

エンドポイント

https://0qpyv9zruk.execute-api.ap-northeast-1.amazonaws.com/POSTClientAuth

メソッド

POST

接続先

Cognito

リクエストヘッダー

フィールド名値
Content-Typeapplication/json

リクエストデータ

JSON Key型必須値の説明
tenantIdString○[WHERE]DBカラム：tenants.tenantId
authenticationIdString○[WHERE]DBカラム：tenants.authenticationId
authenticationPassString○[WHERE]DBカラム：tenants.authenticationPass

レスポンスデータ

JSON Key型必須
tokenIdString○

処理結果ステータス

ステータスメッセージ
200OK
401Unauthorized
500INTERNAL SERVER ERROR

動作例

bodyにJSON形式で tenantId、authenticationId、authenticationPass をつけてPOSTします。
事業所が認証され、JSON形式で tokenId が返ってきます。

事業所認証

認証に失敗した場合、エラーが返ってきます。

認証失敗

補足事項

Q:POSTClientAuthで取得したtokenの有効時間は何分になりますでしょうか。
A:1時間となります。

＞ 戻る