• Native OpenStack API

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

Querying a User List

Function Description

This interface is used to query a user list. This interface applies only to domain names in the Global zone.

URI

  • URI format

    GET /v3/users

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    domain_id

    No

    String

    ID of the domain where a user is located.

    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

    User name.

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

    List of user objects.

    links

    Yes

    JSONObject

    Link to a resource.

  • Description for the user format

    Parameter

    Mandatory

    Type

    Description

    enabled

    Yes

    Boolean

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

    id

    Yes

    String

    User ID.

    domain_id

    Yes

    String

    ID of the domain where a user is located.

    name

    Yes

    String

    User name.

    links

    Yes

    JSONObject

    Links to a user resource.

    default_project_id

    No

    String

    Default project ID of a user.

    password_expires_at

    Yes

    Strng

    Coordinated Universal Time (UTC) that the password expires. null indicates that the password will not expire.

  • Sample response
    {
        "users": [{
            "name": "james1234",
            "links": {
                "self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300903e5bf32"
            },
            "description": "james1234",
            "domain_id": "88b16b6440684467b8825d7d96e154d8",
            "enabled": false,
            "id": "6d8b04e3bf99445b8f76300903e5bf32",
            "default_project_id": "263fd9",
            "password_expires_at": "2016-12-07T00:00:00.000000Z"
        }],
        "links": {
            "self": "https://sample.domain.com/v3/users?domain_id=88b16b6440684467b8825d7d96e154d8&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.