Getting a list of users

Ops Center Analyzer REST API Reference Guide

Version

11.0.x

Audience

anonymous

Part Number

MK-99ANA003-18

You can obtain a list of users and user-related information, such as user IDs and permissions. If you use an external authorization server to perform user authentication, you have to manage users on an external authorization server.

Execution permission

User Management

Request line

GET baseURL/v1/objects/Users

Request body

Not applicable.

Response body

The structure of the response body and the object attributes is as follows:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	A list of UserInfo objects. For details, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions related to this query(API).

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	Page.
pageSize	integer	Size of page.
numPages	integer	Number of pages.
totalCount	integer	Number of objects.

UserInfo

{
        "instanceID":"...",
        "userId":"...",
        "analyticsPermissions":["...", ...],
        "userManagementPermissions":["...", ...],
        "fullName":"...",
        "description":"...",
        "email":"...",
        "customGuiProperties":[{
            "key":"...",
            "value":"..."
        },
        :
        ],
        "defaultGuiProperties":[{
            "key":"...",
            "value":"..."
        },
        :
        ]
}

UserInfo (Type: UserInfo)

Attribute	Type	Description
instanceID	string	Instance ID.
userId	string	User ID used for authentication.
analyticsPermissions	string[]	User permission for Ops Center Analyzer operations. "Admin" and "Modify" are set.
userManagementPermissions	string[]	User permission for manipulating user information. "Admin" can be set.
fullName	string	Name of the user (full name). Two consecutive dollar signs ($$) are converted into a single space.
description	string	Description.
email	string	Mail Address.
customGuiProperties	KeyValue[]	Acquires the properties used to customize the GUI (for example, the dashboard). The contents of the properties change with each version. Do not specify the properties in the body of the request because these properties are only used with the Ops Center Analyzer GUI.
defaultGuiProperties	KeyValue[]	Specifies the data that is acquired from the server in order to customize the Ops Center Analyzer GUI (for example, the dashboard). The contents of the properties change with the version.

customGuiProperties (Type: KeyValue)

Attribute	Type	Description
key	string	Key of a property
value	string	Value of a property

defaultGuiProperties (Type: KeyValue)

Attribute	Type	Description
key	string	Key of a property
value	string	Value of a property

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Users
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 20 Jul 2016 02:10:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : "USER_0",
    "userId" : "System",
    "analyticsPermissions" : [ "Admin", "Modify" ],
    "userManagementPermissions" : [ "Admin" ],
    "fullName" : "",
    "description" : "Built-in account",
    "email" : ""
  } ],
  "count" : 1
}