POST User Auth 解説

ユーザー認証および登録をおこないます。

概要

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

エンドポイント

https://sll9y2956i.execute-api.ap-northeast-1.amazonaws.com/POSTUserAuth

メソッド

POST

接続先

Cognito

リクエストヘッダー

フィールド名
Content-Typeapplication/json

リクエストデータ

JSON Key必須値の説明
tenantIdString[WHERE]DBカラム:users.tenantId
authenticationIdString[WHERE]DBカラム:users.authenticationId
authenticationPassString[WHERE]DBカラム:users.authenticationPass
createBool新規登録時にはtrue

レスポンスデータ

JSON Key必須値の説明
userIdString[SELECT]DBカラム:users.userId
userTokenIdString

処理結果ステータス

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

動作例

bodyにJSON形式で tenantId、authenticationId、authenticationPass、create、をPOSTします。
create が true の場合は、ユーザーが新規作成され、JSON形式で tokenId が返ってきます。

新規ユーザー作成

create が false の場合は、ユーザーが認証され、JSON形式で tokenId が返ってきます。

ユーザー認証

新規作成、ユーザー認証に失敗した場合はエラーコードが返ってきます。

認証失敗

概要

Q: 「POST User Auth」で登録したユーザーの一覧を確認する方法はありますか?
A: 一覧を確認する方法はありません。 必要な場合、別途ご依頼いただくことになります。
(実装可能か確認中)

Q: ユーザーパスワードを更新する方法はありますか?
A: パスワードを更新する方法はありません。(実装可能か確認中)

Q: 登録したユーザーを削除する方法はありますか?
A: ユーザーを削除する方法はありません。必要な場合、別途ご依頼いただくことになります。
(実装可能か確認中)

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

戻る