ユーザー詳細

GEThttps://manabeat.com/{site_id}/mana_apis/user_show/{user_id}

指定したユーザーの詳細情報を取得します。

パスパラメータ

site_idstringrequired

サイトID

user_idstringrequired

ユーザーID

レスポンスボディ

idinteger

ユーザーID

*facestring

顔情報認証状況

loginstring

ログインID

last_namestring

姓

first_namestring

名

last_name_kanastring

姓（カナ）

first_name_kanastring

名（カナ）

emailstring

メールアドレス

email2string

メールアドレス（サブ）

valid_start_datestring

有効開始日

valid_end_datestring

有効終了日

rolestring

権限名

groups[{group_code: string, name: string}]

グループ（グループコード, グループ名）

properties[string]

属性名

invalid_flagboolean

無効

temporary_user_flagboolean

仮登録

languagestring

使用言語

notestring

備考

*saml_idps[string]

SAML認証用ユーザーID

creatorstring

登録者

created_atstring

登録日時

updaterstring

更新者

updated_atstring

更新日時

* オプション利用中のみ

エラーレスポンス

400URLに誤りがあります。

リクエストURL、パスパラメータを確認してください。

403認証に失敗しました。

APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。

403許可されていないIPからのリクエストです。

IPアドレス制限によってリクエストが制限されています。

404ユーザーが存在しません。

取得するユーザーが存在しません。ユーザーIDを確認してください。

429リクエスト制限中です。

1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。

500予期せぬエラーが発生しました。

システム内部でエラーが発生しました。時間をおいて再度お試しください。

503システムメンテナンス中です。

現在システム全体のメンテナンス中です。終了までお待ちください。

レスポンスボディ例

{
  "id": 123456789,
  "face": "approved",
  "login": "example001",
  "last_name": "学習",
  "first_name": "太郎",
  "last_name_kana": "ガクシュウ",
  "first_name_kana": "タロウ",
  "email": "api1@example.com",
  "email2": "api2@example.com",
  "valid_start_date": "2024-09-01",
  "valid_end_date": "2027-08-31",
  "role": "受講者（student）",
  "groups": [
    {
      "group_code": "english",
      "name": "英語専攻"
    }
  ],
  "properties": [
    "生徒",
    "1年生"
  ],
  "invalid_flag": null,
  "temporary_user_flag": true,
  "language": "英語 (English)",
  "note": "備考欄",
  "saml_idps": [
    "SAMLUSERID001"
  ],
  "creator": "管理者 user001",
  "created_at": "2024-07-23 00:00:00",
  "updater": "管理者 user002",
  "updated_at": "2024-07-24 12:12:12"
}