Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getAgentKnowledgeBase
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.GenerativeAi.getAgentKnowledgeBase

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Knowledge Base resource in Oracle Cloud Infrastructure Generative Ai Agent service.

    GetKnowledgeBase

    Gets information about a knowledge base.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testKnowledgeBase = oci.GenerativeAi.getAgentKnowledgeBase({
    knowledgeBaseId: testKnowledgeBaseOciGenerativeAiAgentKnowledgeBase.id,
});

    import pulumi
import pulumi_oci as oci

test_knowledge_base = oci.GenerativeAi.get_agent_knowledge_base(knowledge_base_id=test_knowledge_base_oci_generative_ai_agent_knowledge_base["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.GetAgentKnowledgeBase(ctx, &generativeai.GetAgentKnowledgeBaseArgs{
			KnowledgeBaseId: testKnowledgeBaseOciGenerativeAiAgentKnowledgeBase.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testKnowledgeBase = Oci.GenerativeAi.GetAgentKnowledgeBase.Invoke(new()
    {
        KnowledgeBaseId = testKnowledgeBaseOciGenerativeAiAgentKnowledgeBase.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetAgentKnowledgeBaseArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testKnowledgeBase = GenerativeAiFunctions.getAgentKnowledgeBase(GetAgentKnowledgeBaseArgs.builder()
            .knowledgeBaseId(testKnowledgeBaseOciGenerativeAiAgentKnowledgeBase.id())
            .build());

    }
}

    variables:
  testKnowledgeBase:
    fn::invoke:
      function: oci:GenerativeAi:getAgentKnowledgeBase
      arguments:
        knowledgeBaseId: ${testKnowledgeBaseOciGenerativeAiAgentKnowledgeBase.id}

    Using getAgentKnowledgeBase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAgentKnowledgeBase(args: GetAgentKnowledgeBaseArgs, opts?: InvokeOptions): Promise<GetAgentKnowledgeBaseResult>
function getAgentKnowledgeBaseOutput(args: GetAgentKnowledgeBaseOutputArgs, opts?: InvokeOptions): Output<GetAgentKnowledgeBaseResult>
    def get_agent_knowledge_base(knowledge_base_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAgentKnowledgeBaseResult
def get_agent_knowledge_base_output(knowledge_base_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAgentKnowledgeBaseResult]
    func LookupAgentKnowledgeBase(ctx *Context, args *LookupAgentKnowledgeBaseArgs, opts ...InvokeOption) (*LookupAgentKnowledgeBaseResult, error)
func LookupAgentKnowledgeBaseOutput(ctx *Context, args *LookupAgentKnowledgeBaseOutputArgs, opts ...InvokeOption) LookupAgentKnowledgeBaseResultOutput

    > Note: This function is named LookupAgentKnowledgeBase in the Go SDK.

    public static class GetAgentKnowledgeBase 
{
    public static Task<GetAgentKnowledgeBaseResult> InvokeAsync(GetAgentKnowledgeBaseArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentKnowledgeBaseResult> Invoke(GetAgentKnowledgeBaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentKnowledgeBaseResult> getAgentKnowledgeBase(GetAgentKnowledgeBaseArgs args, InvokeOptions options)
public static Output<GetAgentKnowledgeBaseResult> getAgentKnowledgeBase(GetAgentKnowledgeBaseArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GenerativeAi/getAgentKnowledgeBase:getAgentKnowledgeBase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KnowledgeBaseId string
    The OCID of the knowledge base.
    KnowledgeBaseId string
    The OCID of the knowledge base.
    knowledgeBaseId String
    The OCID of the knowledge base.
    knowledgeBaseId string
    The OCID of the knowledge base.
    knowledge_base_id str
    The OCID of the knowledge base.
    knowledgeBaseId String
    The OCID of the knowledge base.

    getAgentKnowledgeBase Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A description of the knowledge base.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the knowledge base.
    IndexConfigs List<GetAgentKnowledgeBaseIndexConfig>
    IndexConfig
    KnowledgeBaseId string
    LifecycleDetails string
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the knowledge base.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the compartment.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    A description of the knowledge base.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the knowledge base.
    IndexConfigs []GetAgentKnowledgeBaseIndexConfig
    IndexConfig
    KnowledgeBaseId string
    LifecycleDetails string
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    State string
    The current state of the knowledge base.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A description of the knowledge base.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the knowledge base.
    indexConfigs List<GetAgentKnowledgeBaseIndexConfig>
    IndexConfig
    knowledgeBaseId String
    lifecycleDetails String
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the knowledge base.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the compartment.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    A description of the knowledge base.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the knowledge base.
    indexConfigs GetAgentKnowledgeBaseIndexConfig[]
    IndexConfig
    knowledgeBaseId string
    lifecycleDetails string
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state string
    The current state of the knowledge base.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the compartment.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    A description of the knowledge base.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the knowledge base.
    index_configs Sequence[GetAgentKnowledgeBaseIndexConfig]
    IndexConfig
    knowledge_base_id str
    lifecycle_details str
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state str
    The current state of the knowledge base.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the compartment.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    A description of the knowledge base.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the knowledge base.
    indexConfigs List<Property Map>
    IndexConfig
    knowledgeBaseId String
    lifecycleDetails String
    A message that describes the current state of the knowledge base in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
    state String
    The current state of the knowledge base.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the knowledge base was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the knowledge base was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    GetAgentKnowledgeBaseIndexConfig

    ClusterId string
    The OCID of the OpenSearch Cluster.
    DatabaseConnections List<GetAgentKnowledgeBaseIndexConfigDatabaseConnection>
    DatabaseConnection
    DatabaseFunctions List<GetAgentKnowledgeBaseIndexConfigDatabaseFunction>
    Array of Database functions to be used.
    IndexConfigType string
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    Indexes List<GetAgentKnowledgeBaseIndexConfigIndex>
    Index configuration for open search.
    SecretDetails List<GetAgentKnowledgeBaseIndexConfigSecretDetail>
    SecretDetail
    ShouldEnableHybridSearch bool
    Whether to enable Hybrid search in service managed OpenSearch.
    ClusterId string
    The OCID of the OpenSearch Cluster.
    DatabaseConnections []GetAgentKnowledgeBaseIndexConfigDatabaseConnection
    DatabaseConnection
    DatabaseFunctions []GetAgentKnowledgeBaseIndexConfigDatabaseFunction
    Array of Database functions to be used.
    IndexConfigType string
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    Indexes []GetAgentKnowledgeBaseIndexConfigIndex
    Index configuration for open search.
    SecretDetails []GetAgentKnowledgeBaseIndexConfigSecretDetail
    SecretDetail
    ShouldEnableHybridSearch bool
    Whether to enable Hybrid search in service managed OpenSearch.
    clusterId String
    The OCID of the OpenSearch Cluster.
    databaseConnections List<GetAgentKnowledgeBaseIndexConfigDatabaseConnection>
    DatabaseConnection
    databaseFunctions List<GetAgentKnowledgeBaseIndexConfigDatabaseFunction>
    Array of Database functions to be used.
    indexConfigType String
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes List<GetAgentKnowledgeBaseIndexConfigIndex>
    Index configuration for open search.
    secretDetails List<GetAgentKnowledgeBaseIndexConfigSecretDetail>
    SecretDetail
    shouldEnableHybridSearch Boolean
    Whether to enable Hybrid search in service managed OpenSearch.
    clusterId string
    The OCID of the OpenSearch Cluster.
    databaseConnections GetAgentKnowledgeBaseIndexConfigDatabaseConnection[]
    DatabaseConnection
    databaseFunctions GetAgentKnowledgeBaseIndexConfigDatabaseFunction[]
    Array of Database functions to be used.
    indexConfigType string
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes GetAgentKnowledgeBaseIndexConfigIndex[]
    Index configuration for open search.
    secretDetails GetAgentKnowledgeBaseIndexConfigSecretDetail[]
    SecretDetail
    shouldEnableHybridSearch boolean
    Whether to enable Hybrid search in service managed OpenSearch.
    cluster_id str
    The OCID of the OpenSearch Cluster.
    database_connections Sequence[GetAgentKnowledgeBaseIndexConfigDatabaseConnection]
    DatabaseConnection
    database_functions Sequence[GetAgentKnowledgeBaseIndexConfigDatabaseFunction]
    Array of Database functions to be used.
    index_config_type str
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes Sequence[GetAgentKnowledgeBaseIndexConfigIndex]
    Index configuration for open search.
    secret_details Sequence[GetAgentKnowledgeBaseIndexConfigSecretDetail]
    SecretDetail
    should_enable_hybrid_search bool
    Whether to enable Hybrid search in service managed OpenSearch.
    clusterId String
    The OCID of the OpenSearch Cluster.
    databaseConnections List<Property Map>
    DatabaseConnection
    databaseFunctions List<Property Map>
    Array of Database functions to be used.
    indexConfigType String
    The type of index. The allowed values are:

    • DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer.
    • OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster.
    • OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.
    indexes List<Property Map>
    Index configuration for open search.
    secretDetails List<Property Map>
    SecretDetail
    shouldEnableHybridSearch Boolean
    Whether to enable Hybrid search in service managed OpenSearch.

    GetAgentKnowledgeBaseIndexConfigDatabaseConnection

    ConnectionId string
    The OCID of the Database Tools Connection.
    ConnectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    ConnectionId string
    The OCID of the Database Tools Connection.
    ConnectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId String
    The OCID of the Database Tools Connection.
    connectionType String
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId string
    The OCID of the Database Tools Connection.
    connectionType string
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connection_id str
    The OCID of the Database Tools Connection.
    connection_type str
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.
    connectionId String
    The OCID of the Database Tools Connection.
    connectionType String
    The type of Database connection. The allowed values are:

    • DATABASE_TOOL_CONNECTION: This allows the service to connect to a vector store via a Database Tools Connection.

    GetAgentKnowledgeBaseIndexConfigDatabaseFunction

    Name string
    The index name in opensearch.
    Name string
    The index name in opensearch.
    name String
    The index name in opensearch.
    name string
    The index name in opensearch.
    name str
    The index name in opensearch.
    name String
    The index name in opensearch.

    GetAgentKnowledgeBaseIndexConfigIndex

    Name string
    The index name in opensearch.
    Schemas List<GetAgentKnowledgeBaseIndexConfigIndexSchema>
    IndexSchema
    Name string
    The index name in opensearch.
    Schemas []GetAgentKnowledgeBaseIndexConfigIndexSchema
    IndexSchema
    name String
    The index name in opensearch.
    schemas List<GetAgentKnowledgeBaseIndexConfigIndexSchema>
    IndexSchema
    name string
    The index name in opensearch.
    schemas GetAgentKnowledgeBaseIndexConfigIndexSchema[]
    IndexSchema
    name str
    The index name in opensearch.
    schemas Sequence[GetAgentKnowledgeBaseIndexConfigIndexSchema]
    IndexSchema
    name String
    The index name in opensearch.
    schemas List<Property Map>
    IndexSchema

    GetAgentKnowledgeBaseIndexConfigIndexSchema

    BodyKey string
    Body key name.
    EmbeddingBodyKey string
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    TitleKey string
    Title key that stores the Title of a document, if available.
    UrlKey string
    URL key that stores the URL of a document, if available.
    BodyKey string
    Body key name.
    EmbeddingBodyKey string
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    TitleKey string
    Title key that stores the Title of a document, if available.
    UrlKey string
    URL key that stores the URL of a document, if available.
    bodyKey String
    Body key name.
    embeddingBodyKey String
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    titleKey String
    Title key that stores the Title of a document, if available.
    urlKey String
    URL key that stores the URL of a document, if available.
    bodyKey string
    Body key name.
    embeddingBodyKey string
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    titleKey string
    Title key that stores the Title of a document, if available.
    urlKey string
    URL key that stores the URL of a document, if available.
    body_key str
    Body key name.
    embedding_body_key str
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    title_key str
    Title key that stores the Title of a document, if available.
    url_key str
    URL key that stores the URL of a document, if available.
    bodyKey String
    Body key name.
    embeddingBodyKey String
    Field within customer managed Oracle Cloud Infrastructure OpenSearch document containing the vector embedding for queries.
    titleKey String
    Title key that stores the Title of a document, if available.
    urlKey String
    URL key that stores the URL of a document, if available.

    GetAgentKnowledgeBaseIndexConfigSecretDetail

    ClientId string
    The IDCS Connect clientId.
    IdcsUrl string
    The URL represent authentication url of the IDCS.
    ScopeUrl string
    Fully qualified scope url
    Type string
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    VaultSecretId string
    The OCID of the secret for basic authentication.
    ClientId string
    The IDCS Connect clientId.
    IdcsUrl string
    The URL represent authentication url of the IDCS.
    ScopeUrl string
    Fully qualified scope url
    Type string
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    VaultSecretId string
    The OCID of the secret for basic authentication.
    clientId String
    The IDCS Connect clientId.
    idcsUrl String
    The URL represent authentication url of the IDCS.
    scopeUrl String
    Fully qualified scope url
    type String
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vaultSecretId String
    The OCID of the secret for basic authentication.
    clientId string
    The IDCS Connect clientId.
    idcsUrl string
    The URL represent authentication url of the IDCS.
    scopeUrl string
    Fully qualified scope url
    type string
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vaultSecretId string
    The OCID of the secret for basic authentication.
    client_id str
    The IDCS Connect clientId.
    idcs_url str
    The URL represent authentication url of the IDCS.
    scope_url str
    Fully qualified scope url
    type str
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vault_secret_id str
    The OCID of the secret for basic authentication.
    clientId String
    The IDCS Connect clientId.
    idcsUrl String
    The URL represent authentication url of the IDCS.
    scopeUrl String
    Fully qualified scope url
    type String
    The type of OpenID. The allowed values are:

    • IDCS_SECRET: The OpenID configuration used is OpenSearch is IDCS.
    • BASIC_AUTH_SECRET: Basic authentication use for OpenSearch
    vaultSecretId String
    The OCID of the secret for basic authentication.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci