AddClusterAdmin
Suggest changes
PDFs
You can use the AddClusterAdmin method to add a new cluster admin account. A cluster admin can manage the cluster via the API and management tools. Cluster admins are completely separate and unrelated to standard tenant accounts.
Each cluster admin can be restricted to a subset of the API. You should use multiple cluster admin accounts for different users and applications. As a best practice, give each cluster admin the minimal permissions necessary; this reduces the potential impact of credential compromise.
Parameters
This method has the following input parameters:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
access |
Controls which methods the cluster admin can use. |
string array |
None |
Yes |
acceptEula |
Accept the End User License Agreement. Set to true to add a cluster administrator account to the system. If omitted or set to false, the method call fails. |
boolean |
None |
Yes |
attributes |
List of name/value pairs in JSON object format. |
JSON object |
None |
No |
password |
Password used to authenticate this cluster admin. |
string |
None |
Yes |
username |
Unique username for this cluster admin. Must be between 1 and 1024 characters in length. |
string |
None |
Yes |
Return value
This method has the following return value:
Name |
Description |
Type |
clusterAdminID |
ClusterAdminID for the newly created cluster admin. |
integer |
Request example
Requests for this method are similar to the following example:
{
"method": "AddClusterAdmin",
"params": {
"username": "joeadmin",
"password": "68!5Aru268)$",
"attributes": {},
"acceptEula": true,
"access": ["volumes", "reporting", "read"]
},
"id": 1
}
Response example
This method returns a response similar to the following example:
{
"id":1,
"result" : {
"clusterAdminID": 2
}
}
New since version
9.6