用户 REST API

可使用此 REST API 来管理用户。

获取所有用户

表 1. 获取所有用户
REST API 信息	值	描述
URI	/admin/resources/users
方法 (method)	GET
返回	200	返回所有用户的列表
	404	未找到用户列表
	500	Platform System Manager 在处理请求时迂到内部错误。

返回用户列表。

可使用可选参数来修改来自 REST API 调用的响应。有关更多信息，请参阅相关信息部分。

响应主体

[
   {
      "deployment_options": "F",
      "created_time_raw": 1465936201000,
      "bidi_national_calendar": null,
      "state": "available",
      "updated_time": "Fri 17 Jun 2016 20:52:16.181 UTC",
      "version": "2.2.2.0",
      "id": "/admin/resources/users/66056922-3a86-4e58-883f-229f2be969ca",
      "user_extras": [
         "/admin/resources/user_extras/5e525e4b-25ab-485c-9117-8ee0a245b240"
      ],
      "full_cloud_group": "T",
      "user_groups": [
         "/admin/resources/user_groups/cde0b993-6652-4e06-bdab-6f87ad5422a3"
      ],
      "name": "Default Admin",
      "bidi_text_direction": null,
      "is_internal": "F",
      "user_id": "admin",
      "current_message": null,
      "auth_mode": "internal",
      "isas_rn": 1,
      "label_text": "User",
      "label_key": "pure8500",
      "current_status": null,
      "updated_time_raw": 1466196736181,
      "email": null,
      "roles": [
         "/admin/resources/roles/7f02c942-deae-40fb-a006-1999f7f4621c",
         "/admin/resources/roles/7201879e-6e2f-440c-95c2-824c4f19a68c",
         "/admin/resources/roles/a7455b0c-7eb7-4177-93ee-812d1dc2b24e",
         "/admin/resources/roles/b412ed58-cc0d-4d1b-868e-a8b7b10a4e6b",
         "/admin/resources/roles/0e03aea0-b097-45d6-afa2-760d6a5efd60",
         "/admin/resources/roles/a44593ad-0d6b-4aae-94ae-3084979bcc03",
         "/admin/resources/roles/1d36fe64-c888-45b8-aaf8-fbb5f2bc0bf7",
         "/admin/resources/roles/710fb414-85cf-4b4e-bd24-874b955da4bc",
         "/admin/resources/roles/84578858-1bc1-4d1f-aad6-fba093a70aa6",
         "/admin/resources/roles/bd7493ee-3a63-4719-a857-759c2211bed6",
         "/admin/resources/roles/5599486b-b9e2-461f-a71a-fd1fcee07643",
         "/admin/resources/roles/bf61abbf-5b54-440f-961a-7f49fe1ab729",
         "/admin/resources/roles/374448ab-9311-4ce1-9f7a-16fc7fbd08bd",
         "/admin/resources/roles/4bd1bc4d-a77d-4751-955c-a9dcd353d568",
         "/admin/resources/roles/6554b306-79f7-4066-94bd-92a37599ec9b",
         "/admin/resources/roles/4d32967c-928b-44b0-a11e-0fa9d955ad13",
         "/admin/resources/roles/7074d8fe-2c9c-4a77-8106-ab47b63df165",
         "/admin/resources/roles/0995b098-cfa1-43d0-912f-b073902d24c8",
         "/admin/resources/roles/3a959d23-8d14-4d4f-b8e8-bc4e8e312dfd",
         "/admin/resources/roles/5c2b10b1-15f7-4b73-9652-e0b47323e362",
         "/admin/resources/roles/ee9ab2d3-91cb-41ac-b9d3-73d9b01f3351",
         "/admin/resources/roles/348020a3-e746-4f5b-8a21-74b663c49688",
         "/admin/resources/roles/e1c607dc-4ea1-4ea1-960e-357cafa02f69",
         "/admin/resources/roles/cfa9d8cb-1887-468c-8ed3-9645229cce66",
         "/admin/resources/roles/59bc5dca-2385-4aae-806c-a0c69268b22f",
         "/admin/resources/roles/d34d8e5e-d22d-4d91-a85c-2dd348028369",
         "/admin/resources/roles/d93ae97d-76a4-4865-97fe-28ab77a07440",
         "/admin/resources/roles/afda657e-c7f7-415f-b546-b17c703308e4",
         "/admin/resources/roles/e99c07b2-855c-4e9b-9c0f-4fb80afe0085",
         "/admin/resources/roles/712df94c-b9e3-4cbd-bab9-a36105035c39",
         "/admin/resources/roles/8e79ac40-ec4a-436b-a6be-b3516cfabcbf"
      ],
      "acls": [
         "/admin/resources/acls/9a897895-d876-47fc-8269-31d88761a3c6",
         "/admin/resources/acls/0ab4e34d-6e8c-4c45-a872-12496bfeb23e",
         "/admin/resources/acls/4e06cfa0-4019-46ec-868b-e9132c2b9392",
         "/admin/resources/acls/f9aa028e-d001-41b8-bb15-2e905766df80",
         "/admin/resources/acls/bd0b25cf-b000-4ab3-9bbe-fcfcecdd2980",
         "/admin/resources/acls/96aeae42-2ed5-48f8-89d5-55a7cfcf31fb",
         "/admin/resources/acls/8b598049-542d-4a61-9670-cfc76558ab1c",
         "/admin/resources/acls/b9922084-37c3-4b3f-b439-261617fe060e"
      ],
      "is_disabled": "F",
      "created_time": "Tue 14 Jun 2016 20:30:01.000 UTC"
   }
]

auth_mode: 用户的认证方式（ldap 或内部用户资源库）
created_time: 创建对象的时间
current_message: 用户的当前消息
current_status: 用户的当前状态
deployment_options: 标志，指示用户的部署功能作用域，范围从“仅限云”、“仅限环境概要文件”到“全部”。
电子邮件: 用户的电子邮件地址
id: 对象在系统中的唯一标识。
is_disabled: 标志，指示是否禁用该用户
is_internal: 标志，指示该用户是否为内部用户
label_key: 用于检索用户的标签的关键字
label_text: 缺省已翻译消息文本
名: 用户名
public_key: 用户的公用密钥
角色: 用户的角色
state: 对象的一般可用性。如果是“pending”，那么表示对象已创建，但尚未激活。如果是“available”，那么表示对象在系统中处于活动状态。
updated_time: 最近一次更新对象的时间
user_extras: 用户的可修改额外数据
user_id: 用户的标识。用户标识在系统中必须唯一

子代：

ACL

获取特定用户

表 2. 获取特定用户
REST API 信息	值	描述
URI	/admin/resources/users/{id}
方法 (method)	GET
返回	200	返回了用户。
	404	未找到用户
	500	Platform System Manager 在处理请求时迂到内部错误。

返回标识为 {id} 的单个用户。

可使用可选参数来修改来自 REST API 调用的响应。有关更多信息，请参阅相关信息部分。

创建用户

表 3. 创建用户
REST API 信息	值	描述
URI	/admin/resources/users/{id}
方法 (method)	POST
返回	201	已定义此用户，并且它包括在响应体中。新用户的 URL 包括在响应的 Location 头中。
	400	如果解析请求中的 JSON 数据时出现问题，那么将返回此代码
	403	如果请求者没有足够的许可权来定义新用户，那么将返回此代码
	500	如果 Cloud Pak System 在处理请求时迂到内部错误，那么将返回此代码。

可使用可选参数来修改来自 REST API 调用的响应。有关更多信息，请参阅相关信息部分。

请求主体

 {
"auth_mode": "internal",  
"name": "testNewE",  
"email": "testNewE@us.ibm.com", 
"user_id": "testNewE", 
"password": "mypassword"
}

响应主体

{
   "currentmessage": "RM02013",
   "currentmessage_text": "User has not logged in yet",
   "currentstatus": "RM01062",
   "currentstatus_text": "Inactive",
   "email": "testNewE@us.ibm.com",
   "fullname": "New User",
   "groups": [
      "/resources/groups/1"
   ],
   "id": 3,
   "user_extras": [
   ],   
   "patterns": [
   ],
   "user_id": "newuser",
   "virtualsystems": [
   ]
}

锁定和解锁用户

表 4. 锁定和解锁用户
REST API 信息	值	描述
URI	/admin/resources/users/{id}
方法 (method)	PUT
返回	202	已锁定或已解锁用户。
	400	提供了无效请求主体。
	403	请求者不具有锁定或解锁用户的足够许可权。
	404	找不到该用户。
	500	处理请求时发生内部错误。

可使用可选参数来修改来自 REST API 调用的响应。有关更多信息，请参阅相关信息部分。

请求主体

要锁定用户：

{"locked":"T"}

要解锁用户而不更改密码：

{"locked":"F"}

要解锁用户并更改密码：

{"locked":"F", "password":"newPW"}

响应主体

返回 user_extras 数据的内容：

{
"users": "/admin/resources/users/312c5985-767b-4262-aac2-d66b3da44b26",
"locked_time_raw": -1,
"failed_login_first_time_raw": 0,
"label_text": "Extra User Data",
"event_message": "User account is unlocked. user_extras data entry updated.",
"id": "/admin/resources/user_extras/054f70c4-cb4d-48aa-a09b-9521b1c9777e",
"failed_login_count": 0,
"pw_set_time_raw": 1394133857680,
"user_id": "testNewE"
}