Modify a SAML IdP configuration.
See Also| Argument | Required | Description |
|---|---|---|
| entityid | yes | The entityid is used to globally identify an IdP or SP instance. |
|
idpname |
yes |
The idpname is used by netsweeper to identify an IdP instance. |
| comment | no | Enter an optional comment. |
|
idpfirsturl |
no |
The default SAML sign-in process starts from the Netsweeper WebAdmin. However, this option changes the sign-in process to start from IdP First URL. This URL must be provided by the IdP administrator. |
| format | The format of the output for the API: text, json or xml. The default is text. | |
|
callback |
|
This only works with Direct APIs. This is a JavaScript function that should be called after the API is completed. This function will be called with the response of the API. Please note: It can only be used when requesting this API via AJAX request. More Information can be found here. |
Example:
servername/webadmin/api/samlidp_EDIT.php?idpname=VALUE&entityid=VALUE
Output:
OK: Successfully modified the samlauth IDP
ERROR: Failed to modify the samlauth IDP with error: The IDP does not exist.