ModifyClusterAdmin
You can use the ModifyClusterAdmin
method to change the settings for a cluster admin, LDAP cluster admin, or third-party Identity Provider (IdP) cluster admin. You cannot change access for the administrator cluster admin account.
Parameters
This method has the following input parameters:
Name | Description | Type | Default value | Required |
---|---|---|---|---|
access |
Controls which methods this cluster admin can use. |
string array |
None |
No |
attributes |
List of name-value pairs in JSON object format. |
JSON object |
None |
No |
clusterAdminID |
ClusterAdminID for the cluster admin, LDAP cluster admin, or IdP cluster admin to modify. |
integer |
None |
Yes |
password |
Password used to authenticate this cluster admin. This parameter does not apply to an LDAP or IdP cluster admin. |
string |
None |
No |
Return values
This method has no return values.
Request example
Requests for this method are similar to the following example:
{ "method": "ModifyClusterAdmin", "params": { "clusterAdminID" : 2, "password" : "7925Brc429a" }, "id" : 1 }
Response example
This method returns a response similar to the following example:
{ "id" : 1 "result" : { } }
New since version
9.6