Querying User Details

Function

This API is used to query detailed information about a specified user.

URI

• URI format

  GET /v3/users/{user_id}

• URI parameters

  Parameter	Mandatory	Type	Description
  user_id	Yes	String	User ID.

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Authenticated token with Security Administrator permissions or a user token.

• Example request

  curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/users/43cbe5e77aaf4665bbb962062dc1fxxx
  

Response Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  user	Yes	JSON object	User details.

• Description for the user format

  Parameter	Mandatory	Type	Description
  description	Yes	String	Description for a user.
  domain_id	Yes	String	ID of the tenant that the user belongs to.
  enabled	Yes	Boolean	Indicates whether the user is enabled. The value can be true or false. The default value is true.
  id	Yes	String	ID of a user.
  links	Yes	JSON object	Links of a user resource.
  name	Yes	String	Username.
  password_expires_at	Yes	String	UTC time when the password will expire. null indicates that the password has unlimited validity.
  pwd_status	No	Boolean	Password status. true means that the password needs to be changed, and false means that the password is normal.
  pwd_strength	No	String	Password strength. The value can be high, mid, or low.
  default_project_id	No	String	ID of the project that is displayed by default when the user logs in to the console.
  last_project_id	No	String	ID of the project that the user lastly accessed before exiting the system.

• Example response

  {
      "users": [{
          "name": "username",
          "links": {
              "self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300xxx"
          },
          "description": "1234",
          "domain_id": "88b16b6440684467b8825d7xxx",
          "enabled": false,
          "id": "6d8b04e3bf99445b8f763009xxx",
          "password_expires_at": "2016-12-07T00:00:00.000000Z",
          "pwd_status": true,
          "pwd_strength": "high",
          "last_project_id": ""
      }],
      "links": {
          "self": "https://sample.domain.com/v3/users?domain_id=88b16b6440684467b882xxx154d8&enabled=false",
          "previous": null,
          "next": null
      }
  }
  

Status Codes

Status Code	Description
200	The request is successful.
400	The server failed to process the request.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
405	The method specified in the request is not allowed for the requested resource.
413	The request entity is too large.
500	Internal server error.
503	Service unavailable.

last updated: 2024-11-08 14:24 UTC - commit: 2d5e2c1f97c685df3090da66769505f099a4c992