Integration Guides › Web Service API Reference Guide › Valid Web API Objects › user Object › info Method (user Object)

info Method (user Object)

Description

Retrieve information for a user

Syntax

/api/v1/user/info?user=user&vdc=controller-name 

Arguments

user

Username

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve information for a user named test@CA.com.

GET http://192.168.123.200/api/v1/user/info?user=test@CA.com&vdc=mygrid 

Sample Output

XML:

<user> 
   <id>test@CA.com</id> 
   <comment></comment> 
   <realname></realname> 
</user>

JSON:

{ 
   "user" : { 
      "realname" : "", 
      "comment" : "", 
      "id" : "test@CA.com" 
   } 
} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (user). - Argument user=username missing in the request.

404.1

unknown@CA.NOSPAM.com does not exist. - Invalid user specified in the request.