Table of contents
Official Content
  • This documentation is valid for:

When you create or edit a Private Integration, three tabs are shown: Security Scheme, Integration Parameters, and Tool Parameters.

The Security Scheme tab opens by default and defines how the Integration authenticates against the external service.

SecuritySchemaTab_2026-01

This tab is divided into two sections:

  1. Integration Detail
  2. Authentication Type

1. Integration Detail

In this section, you identify the Integration and its basic behavior.

  • Integration Name

    Internal name of the Integration in the Project. Use a clear, stable name because it is used in other parts of The Lab when you reference this Integration.

  • Description (optional)

    Short text that explains what the Integration does. It helps other users understand when they should use it.

  • Authentication Level

    Determines the scope at which credentials are provided:

    • Project: A single credential is configured once for the entire Project. Any Agent that uses this Integration shares that credential.
    • User: Each user must provide their own credential. The Integration runs with the identity or account of the user who configured it.

    This level works together with the Credentials you configure in the Credentials tab.

2. Authentication Type

In this section, you define which security scheme the Integration uses with the external service.

  • None: The Integration does not need authentication. Use this when the external API is public or already handled by another layer.

  • API Key: The Integration uses an API key stored as a Credential. You manage this value in the Credentials tab instead of as a Secret parameter.

  • OAuth: The Integration uses an OAuth 2.0 authorization flow. You must configure the required endpoints and parameters, such as Authorization URL, Token URL, and optionally Refresh URL and Scopes, according to the provider’s specification.

    You also define the Client ID and Secret associated with the registered application in the external service. Supporting values such as client_id or client_secret can be stored as Secret parameters in the Integration configuration to keep them protected.

    The access tokens obtained during the authorization process are stored as Credentials. These tokens are managed at Project level and are later used by the Tools that belong to the Integration to authenticate requests securely.

Availability

Since version 2026-01.

Last update: December 2025 | © GeneXus. All rights reserved. GeneXus Powered by Globant