Updating the registered information for a user

Ops Center Common Services REST API Reference Guide

Version
10.7.x
File Size
577 KB
Audience
anonymous
Part Number
MK-99OPS003-03
The following request updates the registered information for a user.

The registration information of an identity provider user cannot be updated.

Execution permission

You must be a system administrator or a security administrator.

Request line

PUT base-URL/security/v1/users/object-ID-of-the-user

Request message

Object ID of the user

Specify the value of id acquired by using the request for getting information about a list of users.

Attribute

Type

Description

id

string

(Required) Object ID of the user

Query parameters
None.
Body
{
    "id": "8b39869a-a778-4a08-a2ff-bf967946e836",
    "username": "user_1",
    "firstName": "1",
    "lastName": "user",
    "email": "user_1@email.com",
    "description": "description user_1",
    "enabled": true
}

Attribute

Type

Description

id

string

(Required) Object ID of the user

Specify the value of id acquired by using the request for getting information about a list of users.

username

string

(Required) Username

Specify the username that corresponds to the object ID of the user. You cannot change the username.

firstName

string

(Optional) First name of the user

Specify a character string that is no more than 64 characters.

lastName

string

(Optional) Last name of the user

Specify a character string that is no more than 64 characters.

email

string

(Optional) Email address

Specify a character string that is no more than 254 characters.

description

string

(Optional) Description of the user account

Specify a character string that is no more than 128 characters.

enabled

boolean

(Optional) Whether to enable the user account

  • true: Enables the user account.
  • false: Disables the user account.

Response message

Body
None.

Coding example

curl -v -X PUT -H "Content-Type:application/json" -s "https://example.com:443/portal/security/v1/users/8b39869a-a778-4a08-a2ff-bf967946e836" -d @./request.json  -H "Authorization:Bearer eyJhbxxx"
Tip: Because this request uses SSL communication, you must either run the curl command with the root certificate of the Common Services server certificate specified for the --cacert option, or run the command with the -k option specified. (The -k option runs the command by ignoring SSL errors.)