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
OneAccess
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
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 User Details

Function

This API is used to query details about an IAM Identity Center user based on the user ID.

URI

GET /v1/identity-stores/{identity_store_id}/users/{user_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of the identity source

Minimum length: 12

Maximum length: 12

user_id

Yes

String

Globally unique ID of an IAM Identity Center user in the identity source

Minimum length: 1

Maximum length: 64

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Maximum length: 2048

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

addresses

Array of objects

Address list of a user

Array length: 1-1

display_name

String

Display name of a user

Minimum length: 1

Maximum length: 1024

emails

Array of objects

Email address list of a user

Array length: 1-1

external_id

String

Identifier assigned by an external identity source to a resource

external_ids

Array of objects

External ID list of a user

Array length: 1-10

identity_store_id

String

Globally unique ID of the identity source

Minimum length: 1

Maximum length: 36

locale

String

Geographical area or location of a user

Minimum length: 1

Maximum length: 1024

name

Object

Name of a user

nickname

String

Nickname of a user

Minimum length: 1

Maximum length: 1024

phone_numbers

Array of objects

Phone number list of a user

Array length: 1-1

preferred_language

String

User's preferred language

Minimum length: 1

Maximum length: 1024

profile_url

String

URL associated with a user

Minimum length: 1

Maximum length: 1024

timezone

String

User time zone

Minimum length: 1

Maximum length: 1024

title

String

User title

Minimum length: 1

Maximum length: 1024

user_id

String

Globally unique ID of an IAM Identity Center user in the identity source

Minimum length: 1

Maximum length: 47

user_name

String

Username, which uniquely identifies a user

Minimum length: 2

Maximum length: 128

user_type

String

User type

Minimum length: 1

Maximum length: 1024

created_at

Long

Timestamp when a user is created

created_by

String

Creator

updated_at

Long

Timestamp when a user is updated

updated_by

String

Updater

email_verified

Boolean

Whether the user's primary email address is verified

enabled

Boolean

Whether a user is enabled

enterprise

Object

Object that contains the user's work-related information

Table 4 addresses

Parameter

Type

Description

country

String

Country or region

Minimum length: 1

Maximum length: 1024

formatted

String

Formatted address to be displayed

Minimum length: 1

Maximum length: 1024

locality

String

Location

Minimum length: 1

Maximum length: 1024

postal_code

String

Postal code

Minimum length: 1

Maximum length: 1024

primary

Boolean

Whether the address is the user's primary address

region

String

Region

Minimum length: 1

Maximum length: 1024

street_address

String

Street

Minimum length: 1

Maximum length: 1024

type

String

Address type

Minimum length: 1

Maximum length: 1024

Table 5 emails

Parameter

Type

Description

primary

Boolean

Whether the value is the user's primary email address

type

String

Email address type

Minimum length: 1

Maximum length: 1024

value

String

Email address

Minimum length: 1

Maximum length: 1024

verification_status

String

Verification status of an email address

Enumerated value:

  • NOT_VERIFIED
  • VERIFIED
Table 6 external_ids

Parameter

Type

Description

id

String

ID issued by an external identity provider

Minimum length: 1

Maximum length: 256

issuer

String

Issuer of the external ID

Minimum length: 1

Maximum length: 100

Table 7 name

Parameter

Type

Description

family_name

String

Family name of a user

Minimum length: 1

Maximum length: 1024

formatted

String

Formatted name to be displayed

Minimum length: 1

Maximum length: 1024

given_name

String

Given name of a user

Minimum length: 1

Maximum length: 1024

honorific_prefix

String

Prefix of a user name

Minimum length: 1

Maximum length: 1024

honorific_suffix

String

Suffix of a user name

Minimum length: 1

Maximum length: 1024

middle_name

String

Middle name of a user

Minimum length: 1

Maximum length: 1024

Table 8 phone_numbers

Parameter

Type

Description

primary

Boolean

Whether the value is the user's primary phone number

type

String

Phone number type

Minimum length: 1

Maximum length: 1024

value

String

Phone number

Minimum length: 1

Maximum length: 1024

Table 9 enterprise

Parameter

Type

Description

cost_center

String

Cost center

Minimum length: 1

Maximum length: 1024

department

String

Department

Minimum length: 1

Maximum length: 1024

division

String

Division

Minimum length: 1

Maximum length: 1024

employee_number

String

Employee ID

Minimum length: 1

Maximum length: 1024

manager

Object

Manager

organization

String

Organization

Minimum length: 1

Maximum length: 1024

Table 10 manager

Parameter

Type

Description

value

String

Manager

Minimum length: 1

Maximum length: 1024

Status code: 400

Table 11 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Status code: 403

Table 12 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Status code: 404

Table 13 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error message

request_id

String

Request ID

encoded_authorization_message

String

Authentication information

Example Request

Querying details about an IAM Identity Center user based on the user ID

GET https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id}

Example Response

Status code: 200

Successful

{
  "addresses" : null,
  "display_name" : "User display name",
  "emails" : [ {
    "primary" : true,
    "type" : "Work",
    "value" : "email@example.com"
  } ],
  "external_ids" : null,
  "identity_store_id" : "d-a00aaaa33f",
  "locale" : null,
  "name" : {
    "family_name" : "Family name",
    "formatted" : null,
    "given_name" : "Given name",
    "honorific_prefix" : null,
    "honorific_suffix" : null,
    "middle_name" : null
  },
  "nickname" : null,
  "phone_numbers" : null,
  "preferred_language" : null,
  "profile_url" : null,
  "timezone" : null,
  "title" : null,
  "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
  "user_name" : "User name u1",
  "user_type" : null,
  "created_at" : 1687184129925,
  "created_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
  "updated_at" : 1687184129926,
  "updated_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
  "email_verified" : true,
  "enabled" : true
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

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