Getting information about a specific user

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets information about the specified user.

Execution permission

Security Administrator (View Only)

Request line

GET base-URL/v1/objects/users/object-ID

Request message

Object ID

Specify the userObjectId value obtained by getting information about the user.

Attribute

Type

Description

userObjectId

string

(Required) Object ID of the user ID

The name is case sensitive.

Query parameters

None.

Body

None.

Response message

Body
{
  "userObjectId": "devUser",
  "userId": "devUser",
  "authentication": "local",
  "userGroupNames": [
    "Audit Log Administrator (View Only) User Group",
    "Storage Administrator (View & Modify) User Group"
  ],
  "isBuiltIn": false,
  "isAccountStatus": true
}

Attribute

Type

Description

userObjectId

string

Object ID of the user ID

If the user ID contains a reserved character defined in RFC 3986, the encoded character string is output.

userId

string

User ID

userGroupNames

string[]

User group name

isBuiltIn

boolean

Whether the user account is built-in

  • true: Indicates a built-in user account

  • false: Indicates that the account is created by the user

isAccountStatus

boolean

Status of the user account
  • true: The user account is valid

  • false: The user account is invalid

authentication

string

Set authentication

  • local: Authorized by the storage system

  • external: Authorized by the external authentication server

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/users/devUser