1. Packages
  2. Okta Provider
  3. API Docs
  4. getApiServiceIntegration
Okta v6.2.0 published on Thursday, Dec 11, 2025 by Pulumi
okta logo
Okta v6.2.0 published on Thursday, Dec 11, 2025 by Pulumi

    Retrieves an API Service Integration instance by id

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getApiServiceIntegration({
        id: "<api_service_integration_id>",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_api_service_integration(id="<api_service_integration_id>")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.LookupApiServiceIntegration(ctx, &okta.LookupApiServiceIntegrationArgs{
    			Id: "<api_service_integration_id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Okta.GetApiServiceIntegration.Invoke(new()
        {
            Id = "<api_service_integration_id>",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetApiServiceIntegrationArgs;
    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 test = OktaFunctions.getApiServiceIntegration(GetApiServiceIntegrationArgs.builder()
                .id("<api_service_integration_id>")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: okta:getApiServiceIntegration
          arguments:
            id: <api_service_integration_id>
    

    Required

    • id (String) The id of the API Service Integration instance.

    Read-Only

    • config_guide_url (String) The URL to the API service integration configuration guide.
    • created (String) The created timestamp of the API Service Integration instance.
    • created_at (String) Timestamp when the API Service Integration instance was created.
    • granted_scopes (List of String) The list of Okta management scopes granted to the API Service Integration instance.(see below for nested schema).
    • name (String) The name of the API service integration that corresponds with the type property. This is the full name of the API service integration listed in the Okta Integration Network (OIN) catalog.
    • type (String) The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name. For example, my_api_log_integration.

    Using getApiServiceIntegration

    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 getApiServiceIntegration(args: GetApiServiceIntegrationArgs, opts?: InvokeOptions): Promise<GetApiServiceIntegrationResult>
    function getApiServiceIntegrationOutput(args: GetApiServiceIntegrationOutputArgs, opts?: InvokeOptions): Output<GetApiServiceIntegrationResult>
    def get_api_service_integration(granted_scopes: Optional[Sequence[GetApiServiceIntegrationGrantedScope]] = None,
                                    id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetApiServiceIntegrationResult
    def get_api_service_integration_output(granted_scopes: Optional[pulumi.Input[Sequence[pulumi.Input[GetApiServiceIntegrationGrantedScopeArgs]]]] = None,
                                    id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetApiServiceIntegrationResult]
    func LookupApiServiceIntegration(ctx *Context, args *LookupApiServiceIntegrationArgs, opts ...InvokeOption) (*LookupApiServiceIntegrationResult, error)
    func LookupApiServiceIntegrationOutput(ctx *Context, args *LookupApiServiceIntegrationOutputArgs, opts ...InvokeOption) LookupApiServiceIntegrationResultOutput

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

    public static class GetApiServiceIntegration 
    {
        public static Task<GetApiServiceIntegrationResult> InvokeAsync(GetApiServiceIntegrationArgs args, InvokeOptions? opts = null)
        public static Output<GetApiServiceIntegrationResult> Invoke(GetApiServiceIntegrationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiServiceIntegrationResult> getApiServiceIntegration(GetApiServiceIntegrationArgs args, InvokeOptions options)
    public static Output<GetApiServiceIntegrationResult> getApiServiceIntegration(GetApiServiceIntegrationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getApiServiceIntegration:getApiServiceIntegration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getApiServiceIntegration Result

    The following output properties are available:

    Supporting Types

    GetApiServiceIntegrationGrantedScope

    Scope string
    The scope of the API service integration granted.
    Scope string
    The scope of the API service integration granted.
    scope String
    The scope of the API service integration granted.
    scope string
    The scope of the API service integration granted.
    scope str
    The scope of the API service integration granted.
    scope String
    The scope of the API service integration granted.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v6.2.0 published on Thursday, Dec 11, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate