ユーザー情報の取得、登録、更新、削除が行えます。

共通

認証

ユーザ認証が完了している必要があります。
ユーザーの登録、更新、削除は以下の権限を持つユーザーである必要があります。

  • SuperAdmin
  • Admin

URL

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users

Userオブジェクト

"user":{
  "userId":"",
  "account":"",
  "firstName":"",
  "lastName":"",
  "password":"",
  "groupRoleMap":[{
			"group": {
				"description": "",
				"groupId": 2,
				"groupName": "test",
			},
			"role": {
				"roleId": 4
				"roleName": "Manager"
			}
    }]
}

ユーザー情報の取得（userIdを指定した１件取得）

ユーザー情報を返却します。

URL

  • GET

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users/{userId}?token=XXX

なし

Request parameters

Name Data Format Description
Token string (Required) user token
userId string (Required) ユーザーID

Request example

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users/5?token=XXX

Response example

{
   "status":"OK",
   "errCode":0,
   "description":null,
   "user":{
      "userId":5,
      "account":"tanaka",
      "firstName":"和也",
      "lastName":"田中",
      "groupRoleMap":[
         {
            "group":{
               "groupId":1,
               "groupName":"開発グループ",
               "description":""
            },
            "role":{
               "roleId":5,
               "roleName":"User",
            }
         }
      ]
   }
}

Response properties

Name Data Format Description
errCode int Response error code: 0, 105, 110, 120, 121
status String (Required) API result status value.
description String (Optional) Detail error
user ユーザー情報 取得されたユーザー情報
UserInfo parameters
Name Data Format Description
userId long ユーザーID
account String アカウント名
firstName String 氏名（名）
lastName String 氏名（姓）
groupRoleMap Object ユーザーが所属するグループと、ロール

ユーザー情報の取得（復数件取得）

ユーザー一覧を返却します。

URL

  • GET

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users?token=XXX&groupId={グループID}&account={アカウント名}&firstName={氏名（名）}&lastName={氏名（姓）}}

Header

なし

Request parameters

Name Data Format Description
Token string (Required) user token
groupId string (Optional) 指定したグループIDのグループに所属するユーザーを取得します
account string (Optional) 指定したアカウント名のユーザーを取得します
firstName string (Optional) 指定した氏名（名）のユーザーを取得します
lastName string (Optional) 指定した氏名（姓）のユーザーを取得します
  • groupId、account、firstName、lastNameを組み合わせて使用した場合にはすべての条件（AND条件）を満たすユーザーを取得します。
  • account、firstName、lastNameは%を使用することで部分一致で検索することができます。例えば、アップ%を指定するとアップから始まる条件で前方一致検索することができます。

Request example

  • すべての条件を指定する場合
http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users?token=XXXaccount=tana%25&fistName=%25和%25&lastName=田%25&groupId=1
  • 検索条件を指定しない場合
http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users

条件を指定しない場合、テナントに所属するすべてのユーザーを取得します。

Response example

{
   "status":"OK",
   "errCode":0,
   "description":null,
   "users":[
      {
         "userId":5,
         "account":"tanaka",
         "firstName":"和也",
         "lastName":"田中",
         "groupRoleMap":[
            {
               "group":{
                  "groupId":1,
                  "groupName":"開発グループ",
                  "description":"",
               },
               "role":{
                  "roleId":5,
                  "roleName":"User",
               }
            }
         ]
      }
   ]
}

Response properties

Name Data Format Description
errCode int Response error code: 0, 105, 110, 120, 121
status String (Required) API result status value.
description String (Optional) Detail error
users ユーザー情報の配列 取得されたユーザー情報のリスト
UserInfo parameters
Name Data Format Description
userId long ユーザーID
account String アカウント名
firstName String 氏名（名）
lastName String 氏名（姓）
groupRoleMap Object ユーザーが所属するグループと、ロール

ユーザー情報の登録

ユーザを新規追加します。

URL

  • POSTメソッド

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users

Header

  • Content-Type: application/json
  • apppot-token: token
Name Data Format Description
apppot-token String (Required) Login APIの結果得られたユーザートークン

Request parameters

Name Data Format Description
Token string (Required) user token
account string (Required) user account
firstName string (Required) user firstName
lastName string (Required) user lastName
password string (Required) user password
groupId string (Required) ユーザーを所属させるグループのID
roleName string (Required) ユーザーの該当グループでのロール名

Request example

{
 "token":"2911dc6f9fd54e06bd46e919f01d65c3",
 "account":"test003",
 "firstName":"test",
 "lastName":"003",
 "password":"test003",
 "groupRoleMap":[{
		 "group": {
			 "groupId": 2,
		 },
		 "role": {
			 "roleName": "Manager"
		 }
	 }]
}

Response example

{
 "errCode":0,
 "status":"OK",
 "description":null,
 "user":
 {
  "userId":13,
  "account":"test003",
  "firstName":"test",
  "lastName":"003",
	"groupRoleMap":[{
			"group": {
				"description": "",
				"groupId": 2,
				"groupName": "test",
			},
			"role": {
				"roleId": 4
				"roleName": "Manager"
			}
		}]
 }
}

Response properties

Name Data Format Description
errCode int Response error code: 0, 105, 110, 120, 121
status String (Required) API result status value.
description String (Optional) Detail error
user UserInfo (Optional) List users info if request paramters are valid.
UserInfo parameters
Name Data Format Description
userId long Value of [User].userId column in table
account String Value of [User].email column in table
firstName String User’s first name
lastName String User’s last name
roleName String User’s role

ユーザー情報の更新

指定したユーザIDの情報を更新します。

URL

  • PUT

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users/{userId}

Header

  • Content-Type: application/json
  • apppot-token: token
Name Data Format Description
apppot-token String (Required) Login APIの結果得られたユーザートークン

Request parameters

Name Data Format Description
Token string (Required) user token
firstName string (Required) user firstName
lastName string (Required) user lastName
password string (Required) user password
groupId string (Required) ユーザーを所属させるグループのID
roleName string (Required) ユーザーの該当グループでのロール名

Request example

{
 "token":"2911dc6f9fd54e06bd46e919f01d65c3",
 "firstName":"TEST",
 "lastName":"00003",
 "password":"test00003",
 "groupRoleMap":[{
		 "group": {
			 "groupId": 2,
		 },
		 "role": {
			 "roleName": "Manager"
		 }
	 }]
}

Response example

{
 "errCode":0,
 "status":"OK",
 "description":null,
 "user":
 {
  "userId":3,
  "account":"testaduser01",
  "firstName":"TEST",
  "lastName":"00003",
	"groupRoleMap":[{
			"group": {
				"description": "",
				"groupId": 2,
				"groupName": "test",
			},
			"role": {
				"roleId": 4
				"roleName": "Manager"
			}
		}]
 }
}

Response properties

Name Data Format Description
errCode int Response error code: 0, 105, 110, 120, 121
status String (Required) API result status value.
description String (Optional) Detail error
user UserInfo (Optional) List users info if request paramters are valid.
UserInfo parameters
Name Data Format Description
userId long Value of [User].userId column in table
account String Value of [User].email column in table
firstName String User’s first name
lastName String User’s last name
role String User’s role

ユーザー情報の削除

指定したユーザIDの情報を論理削除します。

URL

  • DELETEメソッド

http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/users/{userId}?token=XXX

Header

なし

Request parameters

Name Data Format Description
Token string (Required) user token

Response example

{
 "errCode":0,
 "status":"OK",
 "description":null
}

Response properties

Name Data Format Description
errCode int Response error code: 0, 105, 110, 120, 121
status String (Required) API result status value.
description String (Optional) Detail error