Administration

Overview

This section explains the options available to configure the Developer Portal settings. They include:

How do I configure SMTP settings to send emails?

Developer Portal sends notifications over emails to its users as part of various functionalities such as user registration, application request, and so on. To enable Developer Portal to send email notifications, you have to register your SMTP server and set the sender’s email address.

This use case starts when you want to configure SMTP settings and ends when you have completed the configuration.

To configure SMTP settings

  1. Click the menu options icon from the title bar and click Administration.

  2. Click SMTP.

  3. Provide the following details:

    Field Description
    Host name Host name or IP address of the SMTP server.
    Port Port number used by the SMTP server.
    Sender address Email address that must appear as sender address for all emails. This must be a valid email address.
  4. Turn Use SSL on to enable SSL.

  5. If you enable the SSL mode, perform the following:

    • Select a value from the SSL mode field that specifies the method to use for a secured connection.

      Options available are:

      • STARTTLS. Transforms a connection that was initially untrusted into an encrypted connection without requiring a specific port to secure communication.
      • SSL. Establishes a trusted connection with a dedicated port.

    • In the Connection timeout field, provide the duration, in milliseconds, after which the attempt to connect to the SMTP server is cancelled.

  6. Turn Use authentication on to use authentication to the SMTP server. Provide the username and password used for authentication in the corresponding fields.

  7. Click Save.
    Your changes are saved.

How do I configure password policy?

Password policy determines the conditions to be imposed on passwords specified by users.

This use case starts when you want to configure a password policy and ends when you have completed the configuration.

To configure password policy

  1. Click the menu options icon from the title bar and click Administration.

  2. Click Password policy from the left pane.

  3. In the General tab, provide the required values in the following fields:

    If the password specified by a user does not satisfy the requirements specified in this section, the password will not be accepted.

    Fields Description
    Minimum length Select the minimum length of the password.
    Maximum length Select the maximum length of the password.
    Minimum number of lowercase letters Select the minimum number of lowercase characters that must be provided.
    Allow special characters Select whether special characters are allowed.
    Minimum number of special characters Select the minimum number of special characters that must be provided.
    Special characters Provide the special characters that are allowed.
    Allow uppercase letters Select whether uppercase characters are allowed.
    Minimum number of uppercase letters Select the minimum number of uppercase characters that must be provided.
    Allow numbers Select whether numbers are allowed.
    Minimum number of numbers Select the minimum number of digits that must be provided.
    Allow commonly used password Select whether commonly used passwords can be provided.
    Common password (s) Provide the list of common passwords that must not be allowed.
    Allow sequential characters Select whether sequential characters are allowed.
    Minimum sequential characters Select the minimum number of sequential characters that must be provided.
    Allow repetitive characters Select whether redundant characters are allowed.
    Minimum repetitive characters Select the minimum number of repetitive characters that must be provided.
    Allow context-related password Select whether context-related passwords are allowed.
    Minimum context-related characters Select the minimum number of context-related characters that must be provided.
  4. In the Advanced tab, enable the following based on your requirements:

    Field Description
    Force change before first login Turn on to enforce the password change during their first sign in.
    Force change after reset Turn on to enforce the password change when user reset the password and new password was shared to user over email.
    Force different password Turn on to enforce user for a different password if the user provides a password that was already in use.
    Activate reset confirmation Turn on to send a confirmation email for password reset. If turned on, a link to reset password is sent. Else, the reset password is sent.
    Activate password expiry Turn on to specify the number of days after which a password expires.
    In the Password lifetime (in days) field, specify the number of days a password is valid.
  5. Click Save.
    Your configurations are saved.

The set of password rules enabled here enhances the user account security by mandating users to employ strong passwords and use them properly.

Security Settings

You can configure the following security settings:

How do I configure user session settings?

You can configure the user session settings from the Users page of the Administration section.

This use case begins when you want to configure user session settings and ends when you have saved the configuration.

To configure user session settings

  1. Click the menu options icon from the title bar and click Administration.

  2. Select Users.

  3. Turn Email address required on to specify that the entry of users’ email address is mandatory during sign up and sign in.

  4. Turn Validate email address on to specify that the email address is entered by users must be validated.

    The email address validation is performed by sending an email to the registered email address.

  5. Specify required values in the following fields:

    Field Description
    Maximum length of login name Provide the maximum number of characters allowed for user login name.
    Maximum image size (in bytes) Provide the maximum size of user image that can be uploaded.
    Initial session duration (in minutes) Provide the duration, in minutes, of the initial session of users.
    Maximum session duration (in minutes) Provide the maximum duration of user sessions.
  6. Select the Default group name from the list.

    New users are assigned to the selected group by default.

How do I configure email notification templates?

Developer Portal sends email notifications to users on various events such as email verification during sign up, OTP email to users, or application approval notification and so on. The default email templates are used for such notifications. You can edit these notification messages if required.

This use case starts when you want to edit an email template and ends when you have completed the edit.

To configure email notification templates

  1. Click the menu options icon from the title bar and click Administration.

  2. Click Email templates from the left pane.

  3. Click the edit icon next to a template.

  4. Make the required changes in the subject and body of the email notification.

  5. Use predefined variables to formulate messages in a meaningful way.

    To view the available variables, type $. The list of available variables appears.

    Click the required option to insert it in the email template.

  6. Click Save.

    Your changes are saved.

The email notification templates are used for sending email notifications.

How do I configure webhooks to notify events to an external system?

Webhooks are used by applications to provide real-time information to other applications.

You can create webhooks in Developer Portal to notify the specified events to an external application URL. For example, an API is published, or an application is shared. For the list of events that you can notify, see List of events.

This use case starts when you want to configure a webhook and ends when you have configured one.

To configure webhooks

  1. Click the menu options icon from the title bar and click Administration.

  2. Click Webhooks from the left pane.

  3. Provide the URL of the destination system to which the notification has to be sent.

  4. From the Type list, select the type of destination that you want to send notification:

    • System. To notify an external system endpoint.
    • Provider. To notify a provider endpoint.

  5. Select one of the following from the Security field:

    • Basic. Select this option if the destination requires basic authentication, and provide the corresponding user name and password.
    • None. Select this option if the destination requires no authentication.

  6. Select the required event type.

    You can select more than one event type.

  7. Click Save.

    Your changes are saved.

The webhook is added. Notifications for the selected events are triggered and sent to the specified endpoint.

List of events

The following table lists the events for which you can create webbooks:

Events Description
API publish Triggered when an API is published to the system.
API republish Triggered when an API is republished to the system.
API unpublish Triggered when an API is unpublished from the system.
Application granted Triggered when application access is granted to a user.
Application publish Triggered when an application is published.
Application request approval Triggered when an application request is approved.
Application request approval pending Triggered when an application request is pending for approval.
Application request rejected Triggered when an application request is rejected.
Application revoked Triggered when application access is revoked for a user.
Application scope change Triggered when APIs are added or removed from an application.
Application unpublish Triggered when an application is unpublished.
Comment create Triggered when a new comment is posted for a topic.
Comment delete Triggered when a comment is deleted.
Comment update Triggered when a comment is updated.
Community create Triggered when a community is created.
Community delete Triggered when a community is deleted.
Community membership change Triggered when a community membership is changed when a new member is added or when an existing member is removed.
Community scope change Triggered when a community scope is modified.
Cron execution Triggered when a cron execution is complete.
Email notification Triggered when an email notification is sent.
External verification Triggered when the external approval option is enabled as a part of user or application onboarding strategy.
Flag topic or comment Triggered when a topic or comment is flagged.
Gateway application creation Triggered when a request to create an application is made to the gateway.
Gateway application scope decrease Triggered when a request to decrease the scope of an application is made to the gateway.
Gateway application scope increase Triggered when a request to increase the scope of an application is made to the gateway.
Gateway application update Triggered when a request to update an application is made to the gateway.
Invoke Try API option Triggered when an API is invoked from the Try API page.
Package publish Triggered when a package is published.
Package republish Triggered when a package is republished.
Package unpublish Triggered when a package is unpublished.
Plan publish Triggered when a plan is published.
Plan republish Triggered when a plan is republished.
Portal application creation Triggered when a request is made to create an application.
Portal application deletion Triggered when a request is made to delete an application.
Portal application scope decrease Triggered when a request is made to decrease the scope of an application.
Portal application scope increase Triggered when a request is made to increase the scope of an application.
Portal application update Triggered when a request is made to update an application.
Provider publish Triggered when a provider is published.
Provider republish Triggered when a provider is republished.
Provider scope change Triggered when adding or removing APIs from a provider.
Provider unpublish Triggered when a provider is unpublished.
System backup event Triggered when a backup file is created.
Team delete Triggered when a team is deleted.
Team expansion Triggered when new members are added to a team.
Team shrink Triggered when a user is removed from the team.
Topic create Triggered when a new topic is posted in a stream.
Topic delete Triggered when a topic is deleted from a stream.
Topic update Triggered when a topic is updated in a stream.
User request delete Triggered when a user request is to be deleted.
User request retry Triggered when an existing application request is retried.
User signup Triggered when a user signs up.

How do I configure webhooks to notify user sign up and application requests to an external approval system?

Webhooks can be used to send the user sign up requests or new application registration requests to an external approval systems.

This use case starts when you want to configure an external approval onboarding strategy and ends when you have completed the configuration.

To configure webhooks

  1. Click the menu options icon from the title bar and click Administration.

  2. Click Webhooks from the left pane.

  3. Provide the external approval system endpoint URL in the field.

  4. Select System from the Type list.

  5. Provide the required Security preference. Available options are:

    • Basic. Indicates the basic credentials are required. Provide your user name and password.
    • None. Indicates that no authentication is required.

  6. Select EXTERNAL_VERIFICATION from the Event type list.

  7. Click Save.

    Your changes are saved.

The webhook is added. Notifications for the selected events are triggered and sent to the specified endpoint.

Next steps:

  • When there is a user sign up request or an application request, an notification is sent to the configured URL with a payload.
  • {
    "created": "2021-09-03T04:44+0000",
    "documentType": "EVENTS",
    "parameters": {
    "details": {
    "email": "u1@sag.com"
    },
    "source": "ExternalVerificationExecutor",
    "link_id": "link_id"  },
    "type": "EXTERNAL_VERIFICATION_EVENT"
    }
    	

  • The external system processes the new user or application request, and approves or reject the request. The external system must specify the link_id value received through the payload and approve or reject the requests using the following REST resources:

    • PUT /rest/v1/approvals/request/external/{id}/approve. Approves the specified external approval request.
    • PUT /rest/v1/approvals/request/external/{id}/reject. Rejects the specified external approval request.
  • How do I specify the Developer Portal URL for reference from external systems?

    The Load balancer URL field allows you to provide the Developer Portal URL. The URL provided in this field is used in the emails sent from Developer Portal. Users who receive those emails can click the link to access Developer Portal.

    The Load Balancer URL should be configured to receive email notifications with proper resolvable URL.

    This use case starts when you want to modify the Developer Portal URL and ends when you have saved the configuration.

    To specify the Developer Portal URL

    1. Click the menu options icon from the title bar and click Administration.

    2. Click General from the left pane.

    3. In the Load balancer URL field, specify the Developer Portal URL with the corresponding system name or IP address.

    4. Click Save.

      Your configurations are saved.

    The specified URL is provided to external systems for directing from anywhere to Developer Portal.

    How do I update the Developer Portal license?

    This use case explains the steps to upload a license file if you are using an outdated one.

    This use case starts when you want to update your existing license and end when you have successfully uploaded the same.

    To update the license file

    1. Click the menu options icon from the title bar and click Administration.

    2. Click Licenses from the left pane.

    3. Click Browse file and select the required license file.

    4. Click Save.

      Your license is updated.

    How do I configure the default group and community for a new?

    This use case starts when you want to specify the group and community that must be assigned to a new user by default and ends when you have completed the configuration.

    To specify the default group and community

    1. Click the menu options icon from the title bar and click Administration.

    2. Click Onboarding strategy.

    3. Select the default community from the Default community for onboarding users list.

      You can select more than one community.

    4. Click Save.

      Your changes are saved.

    5. Click Users

    6. Select the default group from the Default group name from the list.

    7. Click Save.

      Your changes are saved. New users are assigned to the default team and community.