Managing configurations
Overview
This REST API is administerDeveloper Portal settings such as SAML, LDAP, OAuth, user account settings, email notification templates and so on.
List of resources
GET /configurations/smtp
Retrieves the SMTP email server configuration.
PUT /configurations/smtp
Updates the SMTP email server configuration with the given details.
DELETE /configurations/smtp
Deletes the SMTP email server configuration.
GET /configurations/password_policy
Retrieves the password policy settings.
PUT /configurations/password_policy
Updates the SMTP password policy settings with the given details.
DELETE /configurations/password_policy
Resets the password policy settings to default.
GET /configurations/saml
Retrieves the SAML settings.
PUT /configurations/saml
Updates the SAML settings with the given details.
DELETE /configurations/saml
Resets the SAML settings to default.
GET /configurations/mfa
Retrieves the multi-factor authentication settings.
PUT /configurations/mfa
Updates the multi-factor authentication settings with the given details.
DELETE /configurations/mfa
Resets the multi-factor authentication settings to default.
GET /configurations/oauth/{id}
Retrieves the specified OAuth provider configuration.
GET /configurations/oauth
Retrieves the OAuth configuration settings.
PUT /configurations/oauth
Updates the OAuth configuration settings with the given details.
DELETE /configurations/oauth
Resets the OAuth configuration settings to default.
GET /configurations/ldap_connection/{id}
Retrieves the specified LDAP configuration settings.
PUT /configurations/ldap_connection
Updates the LDAP configuration settings with the given details.
DELETE /configurations/ldap_connection
Deletes the LDAP configuration settings.
GET /configurations/ldap_settings
Retrieves the LDAP configuration settings.
PUT /configurations/ldap_settings
Updates the LDAP configuration settings with the given details.
DELETE /configurations/ldap_settings
Deletes the LDAP configuration settings.
POST /configurations
Creates a configuration payload with the given details.
GET /configurations/{category}
Retrieves the configurations payload for the specified category.
POST /configurations/{category}
Updates the specified configurations payload with the given details.
DELETE /configurations/{category}
Deletes the specified configurations payload.
GET /configurations/email-templates
Retrieves the list email notifications templates.
GET /configurations/email-templates/{templateId}
Retrieves the specified email notifications template.
PUT /configurations/email-templates/{templateId}
Updates the specified email notifications template with the given details.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/configurations/smtp' \
--header 'Authorization: Basic basic_auth'
The configurations.yaml file is located at SAGInstallDir\DeveloperPortal\developers\openapis.