2.12.1 Acquisition of user information

Function

Acquires information about users that execute API functions.

Execution permissions

Admin role, Develop role, Modify role, Submit role

API version

v1

Request format

GET http://host:port/Automation/version/user

Status code

For details about the status codes that can be returned as the response to a request, see the relevant topic in 2.2.17 Status code.

Response schema

The following shows the structure of the response body for a request.

{  
  "userName" : "user-name",
  "accessPermission" : [ ... ],
  "fullName" : "full-name",
  "description" : "description",
  "email" : "email",
  "resourceGroup" : [ {
    "instanceId" : "instance-id",
    "name" : "resource-group-name",
    "description" : "description",
    "accessPermission" : [ ... ]
  } ]
} 

Usage example

In the following example, the API acquires information about the execution user.

Request header:

GET /Automation/v1/user HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 07:17:47 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 31fd21f2412025969969b479f296b5be20b267_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-store, no-transform
Transfer-Encoding: chunked
Content-Type: application/json

Response body:

{
  "userName" : "System",
  "accessPermission" : [ "User Management" ],
  "fullName" : "",
  "description" : "Built-in account",
  "email" : "",
  "resourceGroup" : [ {
    "instanceID" : "Automation_RG_ALL",
    "name" : "All Service Groups",
    "description" : "default service groups which contains all services",
    "accessPermission" : [ "View", "Execute", "Develop", "Modify", "Admin" ]
  } ]
}