AddIdpClusterAdmin
Suggest changes
PDFs
You can use the AddIpdClusterAdmin method to add a cluster administrator user authenticated by a third-party Identity Provider (IdP). IdP cluster admin accounts are configured based on SAML attribute-value information provided within the IdP's SAML assertion associated with the user. If a user successfully authenticates with the IdP and has SAML attribute statements within the SAML assertion matching multiple IdP cluster admin accounts, the user will have the combined access level of those matching IdP cluster admin accounts.
Parameters
This method has the following input parameters:
| Name | Description | Type | Default value | Required |
|---|---|---|---|---|
access |
Controls which methods this IdP 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 |
username |
A SAML attribute-value mapping to an IdP cluster admin (for example, email=test@example.com). This can be defined using a specific SAML subject using |
string |
None |
Yes |
Return values
This method has the following return value:
Name |
Description |
Type |
clusterAdminID |
Unique identifier for the newly created cluster admin. |
integer |
Request example
Requests for this method are similar to the following example:
{
"method": "AddIdpClusterAdmin",
"params": {
"username": "email=test@example.com",
"acceptEula": true,
"access": ["administrator"]
}
}
Response example
This method returns a response similar to the following example:
{
"result": {
"clusterAdminID": 13
}
}
New since version
12.0