Updating the registered information for a user group

Execution permission

You must be a system administrator or a security administrator.

Request line

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

Request message

Object ID of the user group

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

Attribute	Type	Description
id	string	(Required) Object ID of the user group

Query parameters

None.

Body

{
    "id": "baf760bc-c789-4cb9-a9cb-662b0b2e4be1",
    "name": "name",
    "description": "description"
}

Attribute	Type	Description
id	string	(Required) Object ID of the user group Specify the value of id acquired by using the request for getting information about a list of user groups.
name	string	(Optional) User group name Specify a character string that is no more than 255 characters. You can use the following characters: 0-9 A-Z a-z ! # $ & ' ( ) + - . = @ [ ] ^ _ ` { } ~ $ space character You cannot specify space character at the start or end.
description	string	(Optional) Description of the user group Specify a character string that is no more than 255 characters.

Response message

Body

None.

Coding example

curl -v -X PUT -H "Content-Type:application/json" -s "https://example.com:443/portal/security/v1/user-groups/baf760bc-c789-4cb9-a9cb-662b0b2e4be1" -d @./request.json  -H "Authorization:Bearer eyJhbxxx"