Only this pageAll pages
Powered by GitBook
1 of 51

Platform Console

Tf platform

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Settings

Create Tenant

Steps to create a tenant

Create a new tenant

  1. Log into the TF Platform Portal and choose your organization.

  2. Select Projects in the sidebar and select a project.

  3. Click + Create tenant.

  4. Enter the Tenant Display name and description.

  5. Click + Create tenant.

Note: Only users with organization admin or owner roles can create new projects. If an organization admin creates a project, they automatically become the admin of that project.

CORS

This article describes an overview of Cross-Origin Resource Sharing within the platform

What is CORS?

Cross-Origin Resource Sharing (CORS) is a mechanism that allows web applications to make requests to resources hosted on different domains.

The platform lets you configure CORS at the tenant level, enabling precise control over cross-origin access for improved security and flexibility.

Best Practices

  • Regularly review and update your CORS settings to align with security requirements.

  • Always use HTTPS in production for secure communication.

  • Avoid using the wildcard * in production; explicitly specify allowed origins.

Services

Modify organization

This article describes how to modify an organization in TF Platform.

Steps to Modify Your Organization:

  1. Sign In Log in to your TF Platform account.

  2. Access Organizations Select Organizations from the menu.

  3. Locate Your Organization

    • Find the organization you want to modify.

    • Click on the organization name to access its settings.

  4. Edit Organization Details Modify the necessary details such as:

    • Organization Name

    • Registration Number

    • Country & Address

  5. eKYC Re-verification Note that changes may require a new eKYC process to verify the updated information. Complete the eKYC to ensure compliance and security.

  6. Save Changes After updating the details and completing eKYC, ensure you save the changes.

Note: The Registration Number cannot be changed. You must register a new organization if you need a different registration number.

Administration

Create project

This article provides instructions for creating a project in the TF Platform.

Note: Only users with organization admin or owner roles can create new projects. If an organization admin creates a project, they automatically become the admin of that project.

Steps to Create a Project:

  1. Sign In Log into the TF Platform Portal and choose your organization.

  2. Access Projects Navigate to Projects from the sidebar.

  3. Create a New Project Click on the "Create a Project" option.

  4. Enter Project Details Fill in the project display name and description.

  5. Confirm Creation Click + Create project.

Remove Tenant

Enabling/disabling services

Overview

What is TF Platform?

TF Platform (The Future Platform) is a white-label Communications & Identity platform for developers. Its control plane allows organizations to create and manage tenants, configure identity and access policies, and operate secure communication services. TF Platform is fully API-driven and modular, enabling organizations to deploy and brand their own services with complete flexibility.


Identity & Access

  • Authentication Engine – authentication services.

  • Authorization Engine – access control and policy enforcement.

  • Accounting Engine – event logging and accountability.

  • Human Identity Hub – human identity management.


Security & Privacy

  • Consent & Privacy Hub – consent and privacy controls.

  • Audit Hub – auditing of platform events.


Integration & Communication

  • Communication Engine – messaging and communication services.

  • Integration Hub – connectors and system integrations.

Data regions

Data residency

When you create a tenant, you must select a geographic location for data residency. This determines where your data is processed and stored, ensuring compliance and performance. We currently support two data regions:

  • European Economic Area (EEA) – Netherlands

Certificates

This article provides an overview of the options for managing SSL Certificates for your domains.

When configuring a custom domain, Automatic Certificate Management is enabled by default. You can also opt for Self-Managed Certificates. If you disable the active self-managed certificate, the system will automatically revert to Automatic Certificate Management to maintain security.


Automatic Certificate Management

By default, SSL/TLS certificates are automatically issued, renewed, and deployed. This guarantees that your domains remain secure without any manual effort.


Modifying Allowed Origins

This article provides an overview of modifying cors

Configuring CORS

  1. Go to Projects: Access the "Projects" section within the platform.

  2. Select the Tenant: Choose the tenant you wish to configure.

  3. Access CORS Settings: Navigate to the CORS settings in the tenant's "Domains" section.

Modify project

This article describes how to modify a project in TF Platform.

Note: Only users with the project admin role can edit or delete projects. Refer to the User Permissions for role information.

Steps to Modify a Project:

TLS/SSL Support

This article provides an overview of supported TLS/SSL certificates.

When setting up a reverse proxy with self-managed certificates to connect to the TF Platform, it's crucial to ensure that you use a supported TLS version and cipher suite. The TLS handshake, which is the communication between the server and client, specifies the TLS version and cipher suite. Using an unsupported version could lead to failure.

Supported TLS 1.3 Cipher Suites

  • TLS_AES_128_GCM_SHA256

Renewing Self-Managed Certificates

Steps to Renew a Self-Managed Certificate

  1. Monitor Expiration Date

    • Regularly check the expiration date of your certificate in the

Remove custom domain

This article provides instructions for removing a custom domain in the TF Platform.

Removing a Custom Domain

Step 1: Remove the Domain

  • Select the custom domain you wish to remove.

Tenants

This article provides an overview about the concept of Tenants.

What is a Tenant?

A tenant on TF Platform is a logically isolated environment where you can manage your own data, applications, resources, and configurations.

Each project can have up to 10 tenants.


Machine Identity Hub – machine and service identity management.

  • Identity Self-Service Portal – subscriber-facing portal.

  • Deployed on Microsoft Azure

  • India – Mumbai

    • Deployed on Google Cloud Platform (GCP)

  • Compliance Note: Consult legal experts to ensure compliance with applicable regulations.


    Failover Support

    • Intra-Regional Failover – supported within each data region to ensure reliability and resilience, while keeping data inside the selected region.

    • Cross-Regional Failover – not supported. Data always remains within the selected region.


    Support

    For questions about data storage, contact us at [email protected] or review our privacy policy.

    Self-Managed Certificates

    Self-managed certificates are suitable for:

    • Origin Servers: Configuring SSL/TLS for secure communication between our service and your DNS provider.

    • Custom Certificates: Providing your own certificates to meet specific requirements.

    You are responsible for obtaining and renewing certificates from your chosen Certificate Authority (CA) and configuring your DNS provider accordingly.

    Allowed Origins: Specify up to 10 origins allowed to make cross-origin requests.

    Configuration Examples:

    • Subdomain Wildcard: https://*.example.com

    • Environments:

      • Production: https://myapp.com

      • Local Development: http://localhost:4200

    Using * as a wildcard is not recommended in production environments for security reasons.

    Sign In Log into the TF Platform Portal and choose your organization.

  • Access Projects Navigate to Projects from the sidebar.

  • Locate and Modify

    • Select View Project to access project settings and find the project ID.

    • Expand the menu next to the project and choose:

      • Edit the project to modify the project name or description.

      • Delete to remove the project.

  • TLS_AES_256_GCM_SHA384

  • TLS_CHACHA20_POLY1305_SHA256

  • To learn more, read Transport Layer Security (TLS) Parameters for the Internet Assigned Numbers Authority (IANA) list of registered parameters, including ciphers.

    Certificates
    section.
  • Obtain a New Certificate

    • Before the expiration date, request a new SSL certificate from your Certificate Authority (CA).

  • Upload the New Certificate

    • Follow the steps above to upload the new SSL certificate and private key.

  • Verify and Save

    • Ensure the new certificate is valid, then click Save to apply the changes.

  • Confirm Successful Update

    • Review the Certificates section to verify that the new certificate is active and that the expiration date has been updated.

  • Click Delete. A confirmation dialog will appear.

    Step 2: Confirm Deletion

    • Review the warning, fill in the confirmation prompt, then click Delete again to confirm and finalize the removal.

    Step 3: Update DNS Records

    • Access your DNS provider's console after the domain is removed from the platform.

    • Remove or unpoint the CNAME record linked to the deleted domain.

    Removing a custom domain will disrupt all associated services and features, rendering them inaccessible. Ensure you are prepared for this impact before proceeding with deletion.

    How Are Tenants Identified?

    Each tenant has its own domain. When end-users make requests to a configured domain, the platform routes them to the correct tenant environment. This setup ensures secure and independent operations for each tenant. For more information see Configure custom domain.

    Examples:

    • Default Domain: [subdomain].tfplatform.com

    • Custom Domain: yourdomain.com

    Users

    The users to which the organization will provide access through Public OAuth2 Clients.

    Applications

    The applications that the organization will provide access to through OAuth2 Clients.

    Organizations

    With TF Platform, you can manage Organizations that serve as top-level entities, allowing the creation and management of multiple projects. You can easily register an organization using your TF Platform account.

    Steps to Join an Organization
    1. Receive an Invitation An invitation to join an organization will be sent to you by the organization owner.

    2. Ensure You're Signed In Log in to your TF Platform account.

    3. Access the Invitation Click on the invitation link provided in your email or notification.

    4. Review Organization Details Check the organization name and details to ensure it’s the correct organization you wish to join.

    5. Accept the Invitation Follow any prompts to confirm your membership in the organization.

    6. Receive Confirmation Once your membership is confirmed, you will receive a notification that you’ve successfully joined the organization.

    Steps to register an Organization
    1. Log in to your TF Platform account.

    2. Select Organizations from the menu

    3. Register Your Organization

    Users can be members of multiple organizations if invited by the admin of other organizations. However, you can only register and own one organization for your TF Platform account.

    Delete organization

    This article describes how to delete an organization in TF Platform.

    Deleting an organization from the TF Platform permanently removes it, including all associated data such as projects, users, and settings. While this action is irreversible, you can recover the organization within 30 days.

    Key Considerations

    • Organizations can be recovered within 30 days post-deletion. After this timeframe, all data will be permanently lost.

    • Ensure you have the necessary administrative permissions to perform this action.

    • It is advisable to notify all organization members before deletion to ensure they are aware of the impending changes.

    • A confirmation prompt will appear to verify the deletion request and ensure that the action is intentional.

    Steps to Delete an Organization
    1. Log in to your TF Platform account.

    2. Navigate to Organizations from the main menu.

    3. Find the organization you wish to delete.

    Domains

    This article provides instructions for supported custom domains in the TF Platform.

    By default, your tenant will be assigned a platform subdomain ([subdomain].tfplatform.com).

    However, we recommend setting up your own domain for an improved user experience. A custom domain can enhance your brand identity, build trust, and provide a more personalized experience for your end users.

    Choose a subdomain

    Here are some examples of domains you can set in the Platform.

    Domain type
    Example
    Supported?

    Configure Self-Managed Certificates

    This article provides an overview of how to manage, upload, and renew SSL/TLS self-managed certificates.

    Steps to Add a Self-Managed Certificate

    1. Access the Certificates Section

      • Navigate to the Domains page.

      • Locate and select the Certificates section.

    2. Upload the Certificate

      • Click on the Upload Certificate option.

    3. Input Certificate and Key

      • Enter SSL Certificate and Private Key:

        • Ensure your SSL certificate file is in PEM format (typically a .crt or .pem file).

    4. Save the Certificate

      • Click the Save button to upload the certificate

    5. Review Certificate details

      • Common Name: A name for easy identification.

      • Issuer: The organization that issued the certificate.

      • Valid From: The start date of the certificate's validity.

    6. Activate the Certificate

      • After saving, ensure the certificate is activated by clicking the Activate button (if applicable) in the Certificates section. This step is essential for enabling secure connections using the newly uploaded certificate.

    Each tenant is limited to 5 certificates.

    Configure custom domain

    This article provides instructions for configuring a custom domain in the TF Platform.

    Steps to Configure a Custom Domain

    1. Inside the platform

    Delete project

    This article provides instructions for deleting a project in the TF Platform.

    Deleting a project from the TF Platform permanently removes it, including all associated data such as users and settings. While this action is mostly irreversible, you can recover the project within 30 days.

    Key Considerations

    • All tenants under the project must be deleted first to delete a project.

    Access

    You can grant TF Platform users access to TF Platform organizations. Assign to enforce permission levels for Atlas users.

    • Select Organizations from the menu.

    • Click Register Organization and fill in the following details:

      • Organization Name

      • Registration Number

      • Country & Address

    • Click Register. After this step, your organization will be registered in the system.

  • Click on the organization name to access its settings.

  • Look for the Delete option within the organization settings.

  • A confirmation prompt will appear. Review the warning and confirm that you want to delete the organization.

  • Once confirmed, the organization will be marked for deletion, and you will have 30 days to recover it if needed.

  • Ensure your private key file is in PEM format (usually a .key file).

  • Copy and Paste Contents:

    • Copy the contents of your SSL certificate and paste them into the Certificate field.

    • Copy the contents of your private key and paste them into the Private Key field.

  • Valid to: The certificate's expiration date.

  • Covered Domains: Domains secured by the certificate.

  • Thumbprint: A unique identifier for quick reference.

  • Navigate to Add New Domain.

  • In the dialog, enter the domain name.

  • And select your ACME Provider: Lets Encrypt or ZeroSSL

  • Click Save to generate the required CNAME record for DNS setup.

  • 2. Outside the platform

    • Log in to your DNS provider’s management console.

    • Add the generated CNAME record to your DNS zone.

    • Ensure the TXT value has the ACME generated value with right config.

    • Ensure the CNAME value points to the target subdomain.tfplatform.com.

    • Save the updated DNS configuration.

    3. Domain Verification

    • Return to the Domains page.

    • Click Verify to confirm the DNS changes.

    • When the domain is verified, a success message will indicate this. The status will update to “Verified” under the Domain tab.

    The verification process can take up to 5 minutes, and DNS changes may take up to 24 hours to fully propagate.


    DNS Configuration Tips and Troubleshooting

    DNS Configuration Tips

    • Ensure the CNAME or A record is accurately entered in your DNS settings.

    • Confirm that the domain points to the generated CNAME provided by the TF Platform.

    Verification Issues

    If verification fails, the platform will provide troubleshooting steps. Common issues include:

    • Propagation Delays: DNS changes may take time to propagate. Wait up to 5 minutes for verification and 48 hours for full propagation before retrying.

    • Incorrect DNS Settings: Double-check that the records were entered correctly.

    For persistent issues, consult your DNS provider’s documentation or our support team for further assistance. Following these steps will help ensure the successful configuration of your custom domain.

    Projects can be recovered within 30 days post-deletion. After this timeframe, all data will be permanently lost.

  • Ensure you have the necessary administrative permissions to perform this action.

    It is advisable to notify all project members before deletion to ensure they are aware of the impending changes.

  • A confirmation prompt will appear to verify the deletion request and ensure that the action is intentional.

  • Steps to Delete a Project:

    1. Sign In Log into the TF Platform Portal and choose your organization.

    2. Access Projects Navigate to Projects from the sidebar.

    3. Locate Your Project

      • Select View Project to access project settings and find the project ID.

      • Expand the menu next to the project.

    4. Select Delete Option Look for the Delete option within the project settings.

    5. Confirm Deletion A confirmation prompt will appear. Review the warning and confirm that you want to delete the project.

    6. Final Confirmation Once confirmed, the project will be marked for deletion, and you will have 30 days to recover it if needed.

    Apex domain

    example.com

    Only if DNS provider supports CNAME flattening

    www subdomain

    www.example.com

    ✅

    Custom subdomain

    platform.example.com

    portal.example.com anything.example.com

    ✅

    user roles

    Roles

    The roles will be a mapping between the APIs of the organization, projects, billing, tenants, services & the permission required in sets.

    Financial Reporter - Billing Read

    Alerts

    ITSM Ticketing integration

    TF Platform allows your ITSM system, such as ServiceNow or similar alternatives, to call our APIs to register support tickets directly. This enables your organization to manage incidents and requests within your existing ITSM workflows while keeping records synchronized in both systems.

    Support

    We provide two types of support:

    Project-Based Support

    • Implementation Support – Greenfield deployments, migrations from existing systems, and hybrid setups.

    • Migration Support – Data transfers, integrations, or platform consolidation, including planning, execution, and validation.

    • Improvement Support – System enhancements such as architecture optimizations, new integrations, feature enablement, and performance tuning.

    • Decommissioning Support – Offboarding activities including secure data export, data cleanup, account closure, and migrations to other systems.

    Project-Based Support is delivered under Professional Services agreements.

    Business-as-Usual Support

    • Operational Support – Ongoing assistance with platform use, including issue reporting, troubleshooting, under attack, and service requests via the available support channels.

    Business-as-Usual (BAU) Support is included in your subscription plan and governed by service level agreements (SLAs).

    Migration Support

    Groups

    Reverse Proxies

    Project-Based Support

    Implementation Support

    Implementation Help

    Need help with implementing the TF Platform? Our team of experts is available to assist you. Simply email [email protected] with the subject line "TF Platform Implementation Help." Please include details about your implementation challenges, and we'll provide guidance, best practices, and solutions to address your technical needs.

    Integrations

    Connections of third-party applications with TF Platform, which are templated or already pre- developed.

    Decommissioning Support

    Operational Support

    Depending on your support plan, you can reach us via phone, email, or in-platform ticketing. All requests are logged in our ITSM system for full traceability. We apply service level commitments to ensure timely response, prioritization, and resolution of incidents and requests.

    Cloudflare as Reverse Proxy

    This article provides a steps to configure Cloudflare as a reverse proxy for your application.

    Steps to Configure Cloudflare

    1. Sign Up for Cloudflare

      • Create a Cloudflare Account: If you don’t already have an account, sign up on Cloudflare's website.

      • Add Your Domain: Follow the prompts to add your domain to your account.

    2. Update DNS Settings

      • Verify Domain Ownership: Follow the instructions to verify ownership, typically by adding a TXT record at your domain registrar.

      • Change DNS Records:

        • Go to the DNS

    3. Configure SSL/TLS Settings

      • Set SSL/TLS Mode: Navigate to the SSL/TLS tab and choose an appropriate mode (e.g., Full or Full (strict)). If you have added the origin server certificate as a custom certificate in the platform, use Full (strict).

      • Enable Always Use HTTPS: Turn on the Always Use HTTPS option to ensure secure connections.

    4. Test Your Setup

      • Access Your Tenant: Ensure your tenant is accessible through the Cloudflare proxy. Verify that SSL/TLS functionality works and that requests are routing correctly to your origin server.

    Create a new billing account

    Steps to Create a Prepaid Billing Account

    1. Sign In: Log in to your account with your credentials.

    2. Select Organization: Choose the appropriate organization from the list if you belong to multiple.

    Billing

    This article provides an overview of topics and tasks related to managing your TF Platform Billing accounts.

    We provide subscriptions through the Microsoft Azure Marketplace and Google Cloud Marketplace. Our model combines metered billing with subscription commitments, ensuring flexibility and predictable coverage.


    Billing Models

    Disable a Billing account

    This article provides an overview to disable a billing account.

    Steps to Disable a Billing Account

    1. Sign In to Your Account: Log in to your account on the TF Platform.

    2. Select Your Organization:

    Access Provisioning and SSO

    TF Platform supports a SCIM interface for provisioning from IGA tools such as SailPoint, Microsoft Entra, or Okta. This enables centralized management of your organization’s console access.

    SCIM provisioning can be combined with Single Sign-On (SSO):

    • SSO – enabled with Just-in-Time (JIT) provisioning by default.

    SIEM Integration

    Coming soon

    You can integrate TF Platform with SIEM tools such as Microsoft Sentinel, Datadog, Splunk, QRadar, and LogRhythm to monitor security events in real time for your organization’s console access.


    How It Works

    1. Connect TF Platform to your SIEM using APIs or custom integrations.

    tab in your Cloudflare dashboard.
  • Add or modify DNS records to point to your origin server using the following settings:

    • Type: A or CNAME

    • Name: Your subdomain (e.g., platform or www)

    • Value: Your origin server’s IP address or hostname

    • Proxy Status: Set to Proxied (indicated by the orange cloud icon).

  • Access Billing Settings: Navigate to the settings menu and select Billing Accounts under Billing.

  • Choose Self-service (Prepaid): Select the Self-service (Prepaid) option, which is the default.

  • Link Payment Method via Stripe: Add a payment method through Stripe by following the on-screen prompts.

  • Provide Account Details: Fill in any additional required information, such as your billing address.

  • Enable Auto Top-up (Optional): Set up auto top-up by choosing a threshold balance and payment method for automatic replenishment.

  • Review Your Information: Check that all provided information is accurate.

  • Submit Your Request: Click the Create Account button to finalize your prepaid billing account setup.

  • Check for Confirmation: Look for a confirmation message or email verifying successful account creation.

  • Ensure that your payment method is valid and has sufficient funds to avoid any interruptions in service once your account is active. If interruptions do occur, you will have 30 days to recover your account and restore access to your services. If you encounter any issues during the setup process, please contact support for assistance.

    1. Metered Billing
    • Pay for actual usage (e.g., Monthly Active Users, token operations, data transfer, storage).

    • Consumption is tracked per project and invoiced through your marketplace account.

    2. Fixed Subscriptions

    • Choose monthly or annual subscriptions.

    • Pricing includes service-level agreements (SLAs) for guaranteed performance and support.

    • Annual subscriptions are discounted compared to monthly.


    Key Notes

    • Subscriptions include already purchased usage and SLA terms.

    • All invoicing and payments are handled through your chosen marketplace (Azure or Google).


    Next Steps

    For detailed pricing, plan comparisons, or to activate a subscription, please contact our Sales team.

    If you belong to multiple organizations, choose the appropriate organization from the list.
  • Navigate to Billing Settings: Go to the settings menu and select Billing Accounts under the Billing section.

  • Select Your Billing Account: Choose the billing account you wish to disable.

  • Initiate Closure: Look for the option to Disable Billing Account and follow the on-screen prompts.

  • Confirm Closure: Review the consequences of closing your account and confirm your decision.

  • Check for Confirmation: Ensure you receive a confirmation message or email verifying that your billing account has been successfully closed.

  • If you disable your active billing account, all services for linked projects will stop, and your data will be retained for 30 days. After this period, the data cannot be recovered.

  • SCIM + SSO – allows pre-provisioning of users and assignment of roles in the console before first login.

  • Stream events and logs into your SIEM.

  • The SIEM analyzes events for threats and anomalies.

  • Alerts and reports are generated for monitoring and compliance.

  • Tenant-level logs must be configured separately for each tenant.

    Delete a billing account

    TF Platform Billing accounts cannot be deleted. When you close your TF Platform Billing account, the account information is retained for reporting and auditing purposes.

    To prevent your TF Platform Billing account from accruing charges, you can either:

    • Disable the TF Platform account.

    • Unlink the billing account from associated projects.

    If you need to change the payment method linked to your TF Platform Billing account, you can manage your payment options in the Billing Accounts section.

    Event Feed

    The Platform Organization Event Feed displays select events for a given TF Platform organization, such as billing or organization events.

    Categories

    • Organization

    • Projects

    • Billing

    • Tenants

    • Domains

    Rate Limiting Policy

    This article provides an overview of the rate limiting policies within the platform to show how many requests a tenant can sustain.

    How Rate Limiting Works

    Each tenant is limited to 600 API requests per minute on all public-facing APIs. This limit maintains fair usage and system stability. Rate limits apply globally across all public APIs per tenant. If the limit is exceeded, the API responds with HTTP 429 – Too Many Requests.


    API Versioning Policy

    This article describes how we incorporate versioning of the services.

    API Versioning

    TF Platform uses header-based versioning. You specify the API version in the request header without altering the URL structure.

    If no version header is provided, the latest stable major version will be used by default.


    Event Log Example

    Rate limit details are recorded in the event log:


    Exceeding the Limit

    If the request limit is exceeded, the API responds:

    The event log shows the limit, remaining requests, and reset time.


    Best Practices

    • Retry Logic – If you receive an HTTP 429 response, use the reset time from the event log to determine when it is safe to retry requests.

    • Monitor Usage – Regularly review the event log to track request volumes and avoid recurring limit breaches.


    Request Higher API Rate Limits

    If your workloads require higher public API request capacity, please contact [email protected] to discuss an increase in rate limits.

    How to request:

    1. Have your Tenant ID ready.

    2. Email [email protected] with subject “API Rate Limit Increase”.

    3. Include your Tenant ID and desired requests per minute, expected peak/average volume, and timeline.

    Semantic Versioning

    TF Platform follows semantic versioning (semver) in the format {major}.{minor}.{patch}:

    • Major (X.0.0) – breaking changes, not backward-compatible.

    • Minor (X.Y.0) – backward-compatible new features.

    • Patch (X.Y.Z) – bug fixes and minor improvements.

    Examples: v1.2.0, v2.0.3, v3.1.1.


    API Request Example


    Best Practices

    • Always specify the full version (X.Y.Z) in production to avoid unexpected changes.

    • Test against new minor versions before upgrading.

    • Refer to the Service Level Agreement (SLA) for details on version support windows and deprecation notice periods.


    Version Tags

    All TF Platform open-source components use semantic versioning and are tagged in repositories with a v prefix (e.g., v2.3.1).

    {
      "x-ratelimit": 600,
      "x-ratelimit-remaining": 450,
      "x-ratelimit-reset": 1632425760
    }
    HTTP/1.1 429 Too Many Requests
    TF-API-Version: 1.0.0
    GET https://your-domain.com/api/resource
    Host: your-domain.com
    TF-API-Version: 1.2.3

    Projects

    Organizations can use projects to group access based on teams, use cases, or environments (like development, staging, and production). Each organization starts with one project and can create up to ten projects. Projects within the same organization can share billing accounts.

    Here are the essential characteristics of projects within TF Platform:

    • TF Platform service quotas remain at the organization level, and are not enforced per project.

    • An organization can have up to 10 projects.

    All tenants under the project must be deleted first to delete a project.