Add a new SAML IdP configuration.
See Also| Argument | Required | Description |
|---|---|---|
| idpname | yes | The idpname is used by netsweeper to identify an IdP instance. |
|
idpmetadata |
yes |
The idpmetadata is the data (in XML format) used to identify the IdP. This data includes the entityid, Cryptographic keys, and Protocol endpoint. The IdP meta data must be provided by the IdP administrator. |
| idpmetafile | no | The idpmetafile is a file that contains the above XML data. |
|
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 |
no |
The format of the output for the API: text, json or xml. The default is text. |
| callback | no |
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_add.php?idpname=VALUE&idpmetadata=VALUE
Output:
OK:
idpname=>test1
entityid=>https://samltest.id/saml/idp
ERROR: No IDP metadata for a new SAML Auth IDP