機能概要
UniBaaSから現在ログインしているユーザーの情報を取得します。
機能詳細
UniBaaSから現在ログインしているユーザーの情報を取得します。すべてを取得することと、どの情報かを指定して取得することができます。
すべてを取得した場合、ディクショナリー型 と ディクショナリー(ロジック)などを参考にして必要な情報を取得してください。
「すべて取得」時ディクショナリーに格納されている情報(JSON形式)
Unifinity Player version 3.X.X
{
"token_type": "Bearer",
"access_token": "5Gk_UbsjXdkWunAN",
"expires_in": 3600,
"user": {
"id": 1,
"name": "山田太郎",
"email": "test@example.com",
"login_user_id": "",
"platforms": [
{
"uuid": "A2A3C4F9-06E2-44D7-A624-4151835E62CD",
"device_token": "devicetoken12345",
"name": "Android 8.0",
"player_version": "2.2.3",
"login_at": "2017-07-21T17:32:28Z",
"login_at_unixtime": 1546916972,
"created_at": "2017-07-21T17:32:28Z",
"created_at_unixtime": 1546916972
}
],
"groups": [
{
"name": "企業グループA",
"note": "",
"id": 1,
"user_count": 100
}
],
"json": {
"data": "example"
}
},
"partner": {
"name": "(株)山田商事",
"license_type": "device",
"id": 1,
"item": "企業項目内容",
"json": {
"data": "example"
}
}
}
「すべて取得」時ディクショナリーに格納されている情報(JSON形式)
Unifinity Player version 4.0.0以降
{
"token_type": "Bearer",
"access_token": "5Gk_UbsjXdkWunAN",
"expires_in": 3600,
"user": {
"id": 0,
"name": "山田太郎",
"email": "test@example.com",
"login_user_id": "",
"role": 268435456,
"platforms": [
{
"uuid": "A2A3C4F9-06E2-44D7-A624-4151835E62CD",
"device_token": "devicetoken12345",
"name": "Android 8.0",
"player_version": "2.2.3",
"login_at": "2017-07-21T17:32:28Z",
"login_at_unixtime": 1546916972,
"created_at": "2017-07-21T17:32:28Z",
"created_at_unixtime": 1546916972
}
],
"groups": [
{
"name": "企業グループA",
"note": "",
"id": 1,
"setting": "",
"role": 268435456,
"user_count": 100,
}
],
"json": {
"data": "example"
}
},
"partner": {
"name": "(株)山田商事",
"contract_rank": "standard",
"license_type": "device",
"id": 1,
"item": "企業項目内容",
"license_count": 200,
"license_expired_on": "2021-12-31T00:00:00Z",
"license_expired_on_unixtime": 1619740800,
"license_remaining": 0,
"unit_id": 0,
"unit_name": "",
"json": {
"data": "example"
}
}
}
【注意】バージョンによる差異
Unifinity Application Playerのバージョンによって細部が異なります。
【注意】Ver.4.2.0以降のUnifinity Studioから利用する場合
プロパティーの[環境設定]タブの「デバッグ実行前にUniBaaS認証する」にチェックを付けてください。
【注意】既知の不具合情報
条件によってはログインユーザーの情報を取得できない場合があります。詳細は既知の不具合情報をご覧ください。
【参考】JSONの内容
| token_type | アクセストークンの種類を示します。通常はBearerです。 |
| access_token | アクセストークンです。HTTP通信の Authorization ヘッダーにセットします。Bearer [アクセストークン] |
| expires_in | トークンが有効である寿命です。単位は秒です。 |
| user | ログインしたユーザーに関するデータのセットです。 |
| user.id | ユーザーの数値でのID番号です。 |
| user.name | ユーザーの名前です。 |
| user.email | ユーザーのメールアドレスです。ログインIDで識別されるユーザーの場合は空であることもあります。 |
| user.login_user_id | ユーザーのログインユーザーIDです。emailで識別されるユーザーの場合は空であることもあります。 |
| user.role | ユーザーの権限を示します。0=ユーザー, 268435456=管理者 を意味しています。 |
| user.platforms | ユーザーが使っているデバイスのリストです。 |
| user.platforms.device_token | デバイス単位でのトークンを示します。一部のUniBaaS API呼び出しの際に必要です。 |
| user.platforms.player_version | Unifinity Application Playerのバージョンを示します。 |
| user.platforms.login_at | 端末での最終ログイン時刻です。 |
| user.platforms.login_at_unixtime | 端末での最終ログイン時刻をUNIXタイムで表したものです。 |
| user.platforms.created_at | 登録された時刻情報です。 |
| user.platforms.created_at_unixtime | 登録された時刻情報をUNIXタイムで表したものです。 |
| user.groups | ユーザーが所属するグループのリストです。 |
| user.groups.name | グループ名です。 |
| user.groups.note | グループの注意書きです。 |
| user.groups.id | グループの数値で表したID番号です。UniBaaSの一部APIで使用します。 |
| user.groups.role |
グループの権限を示します。0=ユーザー, 268435456=管理者 を意味しています。 |
| user.groups.user_count | 所属ユーザー数です。 |
| user.json | ユーザーの固有の情報をJSON形式で格納しています。 |
| partner | ユーザーが所属する企業情報の情報セットです。 |
| partner.name | 企業名です。 |
| partner.contract_rank | 契約種別を示します。 ※Unifinity 4.0以降で使用可能です。 |
| partner.license_type | 契約がユーザー単位かデバイス単位かを示します。 |
| partner.id | 企業の数値で表したID番号です。一部のUniBaaS APIで使用します。 |
| partner.item | 主に契約に関しての履歴です。 |
| partner.license_count | 契約ライセンス数です。 |
| partner.license_expired_on | 契約期限です。 |
| partner.license_expired_on_unixtime | 契約期限をUNIXタイムで表した数値です。 |
| partner.license_remaining | 残りのライセンス数を示します。 |
| partner.unit_id | 契約を発行した販売代理店のID番号を示します。 ※Unifinity 4.0以降で使用可能です。 |
| partner.unit_name | 契約を発行した販売代理店の名前を示します。 ※Unifinity 4.0以降で使用可能です。 |
| partner.json | 企業の固有の設定をJSON形式で示します。 |
例えば得られた情報からemailを取得したい場合は以下を参考にしてください。
配列となっている要素は繰り返し処理Foreachを利用することで取得ができます。
以下を参考にしてください。
パラメーター
- 引数
-
ユーザー情報 すべての情報 ユーザー名 ユーザーID 企業名 パートナーID メールアドレス アクセストークン