Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
Software Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying Users in a User Group

Updated on 2022-08-16 GMT+08:00

Function

This API is used to query users in a user group.

URI

  • URI format

    GET /v3/groups/{group_id}/users

  • URI parameters

    Parameter

    Mandatory

    Type

    Description

    group_id

    Yes

    String

    ID of a user group.

  • Query parameters

    Parameter

    Mandatory

    Type

    Description

    domain_id

    No

    String

    ID of the domain to which a user group belongs.

    name

    No

    String

    Name of a user. The maximum length is 64 characters.

    enabled

    No

    String

    Whether a user is enabled. The value can be true or false. true indicates the user is enabled and false indicates the user is not enabled.

    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 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 the Security Administrator permission.

  • 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/groups/00007111583e457389b0d4252643181b/users

Response Parameters

  • Parameters in the response body

    Parameter

    Mandatory

    Type

    Description

    links

    Yes

    JSON object

    User resource link of a user group.

    users

    Yes

    JSONArray

    List of users in a user group.

  • 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

    User ID.

    links

    Yes

    JSON object

    User resource link.

    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.

    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.

    email

    No

    String

    User email address.

  • Example response
    {
        "users": [{
            "name": "username",
            "links": {
                "self": "https://sample.domain.com/v3/users/6d8b04e3bf99445b8f76300xxx"
            },
            "description": "1234",
            "domain_id": "88b16b6440684467b8825d7xxx",
            "enabled": false,
            "id": "6d8b04e3bf99445b8f763009xxx",
            "email" : ""
            "default_project_id": "263fd9",
            "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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback