top of page

Create a SDK client

To create a new client ID and secret to be used as part of SDK calls in the RelFast portal, follow the step-by-step instructions below. Please make sure that you have the necessary permissions ("Read Application" and "Environment Specific Read Configuration Value") to perform this operation.

Instructions:

  1. Open your web browser and go to the portal: https://relfast.convolute.ai

  2. Log in to the portal using your credentials to access your account.

  3. After logging in, find and click on the "Applications" tab in the left navigation bar. This will take you to the section where you can manage your applications.

  4. Use the search option to find the specific application for which you want to create a new client ID and secret. Once you find the application, click on the "SDK/API client access" button associated with that application.

  5. After clicking on the "SDK/API client access" button, you will be prompted to select the environment for which you want to create the client ID and secret. Select the desired environment from the drop-down list.

  6. Click on the "Add" button to initiate the process of creating the client ID and secret for the selected application and environment type.

  7. Since this operation involves security, an additional confirmation box will appear. Click "Yes" to proceed with the creation of the credentials.

  8. The client ID and secret will be created for the concerned application and environment type using the client credential grant flow (Client Credentials Flow) in the SDK.

  9. In the "Environments" dropdown, you will only see the environment types that you have access to. This ensures that you can only create client IDs and secrets for environments that you are allowed to access.

  10. The secret for the client ID cannot be retrieved again from the RelFast application. If you lose the secret for the given ID, it is recommended to create a new client ID. Additionally, it is advised to disable unused clients for security purposes.

  11. Copy and store the secret in a safe and secure manner. It is recommended to consume this secret as an environment variable from within the container where your application is hosted. Avoid storing this secret in application configuration files for security reasons.

By following these instructions, you can create a new client ID and secret that can be used as part of SDK calls for the specific application and environment type in the RelFast portal. Remember to handle these credentials with utmost care and ensure they are stored securely to maintain the security of your application.

Recent Posts

See All

Project

In the context of the example(Insurance company), a "project" in Relfast refers to a logical grouping of related applications within an...

Environment

In Relfast, an environment is a logical partition that serves as a container for managing different configurations, feature flags, or...

Application

In the context of the example(Insurance company) provided, an "application" in Relfast refers to a logical grouping of related...

bottom of page