• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Keystone
  5. User Management
  6. Querying a User List

Querying a User List

Function Description

This interface is used to query a user list.

URI

  • URI format

    GET /v3/users

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    domain_id

    No

    String

    ID of the domain that a user belongs to.

    enabled

    No

    String

    Whether a user is enabled. true indicates that the user is enabled. false indicates that the user is disabled. The default value is true.

    name

    No

    String

    Username.

    password_expires_at

    No

    String

    Password expiration time. The format is password_expires_at=operator:timestamp.

    Example:

    password_expires_at=lt:2016-12-08T22:02:00Z
    • The value of operator can be lt, lte, gt, gte, eq, or neq.
      • lt: The expiration time is earlier than timestamp.
      • lte: The expiration time is earlier than or equal to timestamp.
      • gt: The expiration time is later than timestamp.
      • gte: The expiration time is equal to or later than timestamp.
      • eq: The expiration time is equal to timestamp.
      • neq: The expiration time is not equal to timestamp.
    • The timestamp format is YYYY-MM-DDTHH:mm:ssZ.

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Authenticated token with the Security Administrator permission.

  • Sample request
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://172.30.48.86:31943/v3/users

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    users

    Yes

    JSONArray

    User list.

    links

    Yes

    JSONObject

    Links of a user resource.

  • 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 account is enabled. The value can be true or false. The default value is true.

    id

    Yes

    String

    User ID.

    links

    Yes

    JSONObject

    User resource links.

    name

    Yes

    String

    Username

    password_expires_at

    Yes

    String

    UTC time when the password will expire. null indicates that the password will not expire.

    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.

    mobile

    No

    String

    Mobile number of the user.

    email

    No

    String

    Email address of the user.

    forceResetPwd

    No

    Boolean

    Indicates whether password reset is required at the next login.

    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.

  • Sample response
    {
        "users": [{
            "name": "username",
            "links": {
                "self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300xxx"
            },
            "description": "1234",
            "domain_id": "88b16b6440684467b8825d7xxx",
            "enabled": false,
            "id": "6d8b04e3bf99445b8f763009xxx",
            "default_project_id": "263fd9",
            "password_expires_at": "2016-12-07T00:00:00.000000Z",
            "pwd_status": true,
            "pwd_strength": "high",
            "mobile": "",
            "email": "",
            "forceResetPwd": false,
            "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

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

405

You are not allowed to use the method specified in the request.

413

The request entity is too large.

500

Failed to complete the request because of an internal service error.

503

Failed to complete the request because the service is unavailable.