Changing the user information used in searches of the external authentication server set for a storage system

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

If the DN (Distinguished Name) or password of a user used in searches of the external authentication server (LDAP server) set for a storage system is changed on the LDAP server side, change the settings on the storage system side.

For a list of storage systems that support this API, see Overview of the initial settings of a storage system.

Note:
  • To specify the initial settings for linkage with the external authentication server, use the maintenance utility or Hitachi Device Manager - Storage Navigator.
  • If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Security Administrator (View & Modify)

Request line

PATCH base-URL/v1/objects/external-authentication-server-settings/instance

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query information

None.

Body
{
  "ldap" : {
    "searchUserDN":"CN=search_user,DC=example,DC=com",
    "searchUserPassword":"search_password"
  }
}

Attribute

Type

Description

ldap

object

(Required) Setting when an LDAP server is used for the external authentication server

  • searchUserDN (string)

    (Optional) DN of the user used for searches

    Specify a name consisting of 1 to 255 characters.

    You can use the following characters:

    • Alphanumeric characters
    • The following symbols:

      ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

    • Spaces
  • searchUserPassword (string)

    (Required) Password of the user used for searches

    Specify a name consisting of 1 to 256 characters.

    You can use the following characters:

    • Alphanumeric characters
    • The following symbols:

      ! # $ % & ' ( ) * + - . = @ \ ^ _ |

Response message

Body

A job object is returned. See the description for the job object. affectedResources is not displayed for this API request. To check whether a change has been applied, as a user authenticated by the external authentication server, run the API request for generating a session and confirm that authentication is successful.

Action template

None.

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/external-authentication-server-settings/instance