Wei, Hongmin bdc1f338a2 IAM API 0816 Version

Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>

2024-10-17 13:19:12 +00:00

23 KiB

Raw Blame History

Querying User Details (Recommended)

Function

This API can be used by the administrator to query the details about a specified user or used by a user to query their details.

URI

GET /v3.0/OS-USER/users/{user_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
user_id	Yes	String	User ID.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	A token with Security Administrator permissions is required if the administrator is requesting to query the details about a specified user. If an IAM user is requesting to query their details, the user token (no special permission requirements) of the user is required.

Response Parameters

**Table 3** Parameters in the response body
Parameter	Type	Description
user	Object	IAM user information.

**Table 4** user
Parameter	Type	Description
enabled	Boolean	Enabling status of the user. true (default value) indicates that the user is enabled. false indicates that the user is disabled.
id	String	User ID.
domain_id	String	ID of the account which the user belongs to.
name	String	Username.
links	Object	User resource link information.
xuser_id	String	ID of the user in the external system.
xuser_type	String	Type of the user in the external system.
areacode	String	Country code.
email	String	Email address.
phone	String	Mobile number.
pwd_status	Boolean	Password status. true means that the password needs to be changed, and false means that the password is normal.
update_time	String	Time when the user was last updated.
create_time	String	Time when the user was created.
last_login_time	String	Last login time of the user.
pwd_strength	String	Password strength. The value can be Low, Middle, High, or None.
is_domain_owner	Boolean	Indicates whether the user is the account administrator.
description	String	Description about the user.

**Table 5** user.links
Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link.
next	String	Next resource link.

Example Request

GET https://sample.domain.com/v3.0/OS-USER/users/{user_id}

Example Response

Status code: 200

The request is successful.

{
  "user" : {
    "pwd_strength" : "Strong",
    "create_time" : "2020-07-08 02:19:03.0",
    "last_login_time" : null,
    "areacode" : "",
    "enabled" : true,
    "domain_id" : "086ba757f90089cf0fe5c000dbe7f...",
    "xuser_id" : "",
    "pwd_status" : false,
    "update_time" : null,
    "phone" : "-",
    "name" : "autotest1",
    "links" : {
      "next" : null,
      "previous" : null,
      "self" : "https://sample.domain.com/v3.0/OS-USER/users/093f75808b8089ba1f6dc000c7cac..."
    },
    "id" : "093f75808b8089ba1f6dc000c7cac...",
    "xuser_type" : "",
    "email" : "",
  }
}

Status Codes

Status Code	Description
200	The request is successful.
403	Access denied.
404	The requested resource cannot be found.
405	The method specified in the request is not allowed for the requested resource.
500	Internal server error.

Parent topic: User Management

23 KiB Raw Blame History