Configurations
This REST API is administer Developer 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/metadata
Retrieves SAML Service provider metadata that can be used to configure Identity provider.
- 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/lcm
Retrieves the lifecycle model of the specified asset (API or package).
- 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.
- POST /configurations/readonly
Allows you to enable or disable the read-only mode of the application.
- GET /configurations/cors_settings
Retrieves the CORS Origin settings configuration.
- POST /configurations/cors_settings
Allows you to create the CORS Origins setting configuration.
- PUT /configurations/cors_settings
Allows you to update the CORS Origins setting configuration.
- GET
/configurations/system_locale
Retrieves the default language that is currently configured.
- POST
/configurations/system_locale
Specifies the given language as the default language.
- POST /configurations/smtp/test
Allows you to verify the SMTP connection by sending a sample mail to the signed in user.
- POST /configurations/controlplaneagent/test
Allows you to verify the Federated API Management connections.
- GET /configurations/payment_gateway
Retrieves the payment gateway settings configuration.
- POST /configurations/payment_gateway
Allows you perform the payment gateway settings configuration.
- GET /configurations/consumer_visibility
Retrieves the consumer visibility settings configuration.
- POST /configurations/consumer_visibility
Allows you perform the consumer visibility settings configuration.
- PUT /configurations/consumer_visibility
Allows you update the consumer visibility settings configuration.
Sample cURL Command
curl --location --request GET 'developer_portal_rest_base/configurations/smtp' \
--header 'Authorization: Basic basic_auth'