EMS ユーザー リソース

提供: Appmethod Topics
移動先: 案内検索

EMS 管理用 API への移動


EMS データベースには、アプリケーションの登録済みユーザーに関するデータが格納されています。登録されているユーザー リソースを使って、この情報にアクセスすることができます。

メモTEMSClientAPITBackendUsers、または、TBackendAuth コンポーネントを使用すると、サインアップ、ログイン、EMS ユーザー情報の取得、更新、EMS データベースからの削除を行うことができます。

ユーザー リソース エンドポイント

ユーザー リソースでは、次の EMS リソース エンドポイントを公開しています。

エンドポイント メソッド名 リソース サフィックス HTTP 要求の種類 用途

GetUsers

--

HTTP GET

ユーザー リソースからすべてのデータを取得すること。

GetUser

{id}

HTTP GET

ユーザーからすべてのデータを取得すること。
id は EMS データベースでの一意な EMS ユーザー識別子(UserID)。

GetFields

fields

HTTP GET

EMS ユーザーのすべてのフィールド名を取得(カスタム フィールドを含む)。

GetUserGroups

{id}/groups

HTTP GET

EMS ユーザーが属する EMS グループを取得するには
id は、EMS データベース内の一意の EMS ユーザー識別子(UserID)です。

SignupUser

--

HTTP POST

適切な EMS ユーザーで EMS サーバーに登録します。

LoginUser

--

HTTP POST

指定された EMS ユーザーで EMS サーバーにログインします。

AddUser

--

HTTP POST

EMS データベースに新規ユーザーを追加すること。

UpdateUser

{id}

HTTP PUT

ユーザー リソース内のユーザーを更新すること。
id は EMS データベースでの一意な EMS ユーザー識別子(UserID)。

DeleteUser

{id}

HTTP DELETE

リソースから項目を削除すること。
id は EMS データベースでの一意な EMS ユーザー識別子(UserID)。

メモ: _id は EMS データベースでの EMS ユーザー識別子(UserID)に相当します。

GetUsers エンドポイント

EMS ユーザー データのリストを返します。

正常終了した場合、EMS サーバーからの応答は全 EMS ユーザーのリストと各グループについての詳細を示します。

  • username
  • _id(UserID)
  • _meta(creator、created、updated の各フィールド)
  • カスタム フィールド(省略可能)

QueryUsers メソッド、TBackendUsers コンポーネントや TBackendQuery コンポーネント、ユーザー リソースを使用して、EMS ユーザーのリストを取得。

応答の例

次は応答の例です。

[
    {
        "username": "test",
        "_id": "24EDA495-90FC-4BC4-9626-C87783357948",
        "_meta": {
            "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
            "created": "2014-08-20T11:08:55.000Z"
        },
        "description": "Created by EMS setup.  Password is \"test\"."
    },
    {
        "username": "testuser",
        "_id": "AB4900CC-CD7A-4890-B20D-9A3E65B450C7",
        "_meta": {
            "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
            "created": "2014-08-20T11:08:55.000Z",
            "updated": "2014-08-20T11:08:59.000Z"
        }
    }
]

GetUser エンドポイント

id で識別された)特定の EMS ユーザーのデータを返します。

要求には、次のフィールドを指定する必要があります。

  • _id(UserID)

正常終了した場合、EMS サーバーからの応答は EMS ユーザーと以下の詳細を示します。

  • username
  • _id(UserID)
  • _meta(creator、created、updated の各フィールド)
  • カスタム フィールド(省略可能)

RetrieveUser メソッド、TBackendUsers コンポーネントや TBackendQuery コンポーネント、特定のユーザーを使用して、そのデータを取得。

応答の例

ユーザー "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4"を指定した場合の要求に対する応答の例を次に示します。

{
    "username": "test",
    "_id": "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4",
    "_meta": {
        "creator": "82C6E6C0-A4BC-44B8-9434-A07DCE364CD4",
        "created": "2014-08-20T09:51:10.000Z"
    },
    "description": "Created by EMS setup.  Password is \"test\"."
}

GetFields エンドポイント

EMS ユーザーのすべてのフィールド名を取得します(すべてのカスタム フィールドを含む)。

正常終了した場合、EMS サーバーからの応答は EMS ユーザーと(少なくても)次の詳細を示します:

  • username
  • _id(UserID)
  • _meta(creator、created、updated の各フィールド)
  • カスタム フィールド(省略可能)

RetrieveUsersFields メソッドを使用すると、すべてのフィールド名を取得することができます。

応答の例

次は応答の例です。

[  
   {  
      "name":"username"
   },
   {  
      "name":"_id"
   },
   {  
      "name":"_meta",
      "fields":[  
         {  
            "name":"creator"
         },
         {  
            "name":"created"
         },
         { 
"name":"updated"
}
      ]
   },
   { 
"name":"description",
"custom":true
}
]

GetUserGroups エンドポイント

EMS ユーザー(id で識別される)が属する EMS グループを取得します。

要求には、次のフィールドを指定する必要があります。

  • _id(UserID)

正常終了した場合、EMS サーバーからの応答は、EMS ユーザーが属する EMS グループ名のリストを提供します。

RetrieveUserGroups メソッドを使用すると、ユーザーが属する EMS グループのリストを取得できます。

応答の例

ユーザー "AB5D4B63-79F9-40A4-A34D-4D2D26ECF170" に対するリクエストへのレスポンス例です。

[  
   "testgroup",
   "Admins"
]

SignupUser エンドポイント

適切な EMS ユーザーで EMS サーバーに登録します。

要求には、次のフィールドを指定する必要があります。

  • username
  • password

TEMSClientAPISignupUser メソッドや、TBackendAuth コンポーネントの Signup メソッドを使用すると、EMS サーバーにおいて、新しい EMS ユーザーをサインアップできます。

LoginUser エンドポイント

指定された EMS ユーザーで EMS サーバーにログインします。

要求には、次のフィールドを指定する必要があります。

  • username
  • password

TEMSClientAPILoginUser メソッドや、TBackendAuth コンポーネントの Login メソッドを使用すると、EMS サーバーにおいて、既存の EMS ユーザーでログインできます。

AddUser エンドポイント

EMS データベースに新規の EMS ユーザーを追加します。

要求には、次のフィールドを指定する必要があります。

  • username
  • password

TBackendUsers コンポーネントの AddUser メソッドや CreateUserAPI メソッドを使用すると、新たに EMS ユーザーを追加することができます。

UpdateUser エンドポイント

EMS データベースに格納されている、(id で識別される)特定の EMS ユーザーの情報を更新します。

要求には、次のフィールドを指定する必要があります。

  • _id(UserID)
  • username
  • 更新するカスタム フィールド

TBackendAuth コンポーネントの UpdateUser メソッドや UpdateUserDetails メソッドを使用すると、既存の EMS ユーザーのカスタム フィールドを更新できます。

DeleteUser エンドポイント

指定された id の EMS ユーザーを削除します。

要求には、次のフィールドを指定する必要があります。

  • _id(UserID)
  • username

TBackendUsers コンポーネントの DeleteUser メソッドや DeleteUser メソッドを使用すると、EMS ユーザーを削除できます。

EMS ユーザーのフィールド

EMS 要求および応答におけるユーザー リソースには、次のフィールドの任意の組み合わせが含まれる可能性があります。

項目 説明
"username"
"testuser"

EMS データベースでの EMS ユーザー名。

"_id"
"AB4900CC-CD7A-4890-B20D-9A3E65B450C7"

EMS データベースでの EMS ユーザーの一意識別子(UserID)

"meta"
{
      "creator": "24EDA495-90FC-4BC4-9626-C87783357948",
      "created": "2014-08-20T11:08:55.000Z",
      "updated": "2014-08-20T11:08:59.000Z"
}
  • creator: EMS データベースでの EMS ユーザー作成オブジェクト。
  • created: EMS ユーザーの作成日時。
  • updated: EMS ユーザーの更新日時。

カスタム フィールド

"myCustomField": "My Custom Field description"

格納されている EMS ユーザーの追加情報。

関連項目