1. Packages
  2. Okta Provider
  3. API Docs
  4. ApiServiceIntegration
Okta v6.2.0 published on Thursday, Dec 11, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.ApiServiceIntegration

okta logo
Okta v6.2.0 published on Thursday, Dec 11, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    —

    page_title: “Resource:<span pulumi-lang-nodejs=” okta.ApiServiceIntegration"" pulumi-lang-dotnet=" okta.ApiServiceIntegration"" pulumi-lang-go=" ApiServiceIntegration"" pulumi-lang-python=" ApiServiceIntegration"" pulumi-lang-yaml=" okta.ApiServiceIntegration"" pulumi-lang-java=" okta.ApiServiceIntegration""> okta.ApiServiceIntegration" description: |-

    Resource:<span pulumi-lang-nodejs=" okta.ApiServiceIntegration

    " pulumi-lang-dotnet=" okta.ApiServiceIntegration " pulumi-lang-go=" ApiServiceIntegration " pulumi-lang-python=" ApiServiceIntegration " pulumi-lang-yaml=" okta.ApiServiceIntegration " pulumi-lang-java=" okta.ApiServiceIntegration “> okta.ApiServiceIntegration

    This API provides operations to manage API service integration instances in your org.

    Example Usage

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

const example = new okta.ApiServiceIntegration("example", {
    type: "anzennaapiservice",
    grantedScopes: [
        {
            scope: "okta.users.read",
        },
        {
            scope: "okta.groups.read",
        },
        {
            scope: "okta.logs.read",
        },
    ],
});

    import pulumi
import pulumi_okta as okta

example = okta.ApiServiceIntegration("example",
    type="anzennaapiservice",
    granted_scopes=[
        {
            "scope": "okta.users.read",
        },
        {
            "scope": "okta.groups.read",
        },
        {
            "scope": "okta.logs.read",
        },
    ])

    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.NewApiServiceIntegration(ctx, "example", &okta.ApiServiceIntegrationArgs{
			Type: pulumi.String("anzennaapiservice"),
			GrantedScopes: okta.ApiServiceIntegrationGrantedScopeArray{
				&okta.ApiServiceIntegrationGrantedScopeArgs{
					Scope: pulumi.String("okta.users.read"),
				},
				&okta.ApiServiceIntegrationGrantedScopeArgs{
					Scope: pulumi.String("okta.groups.read"),
				},
				&okta.ApiServiceIntegrationGrantedScopeArgs{
					Scope: pulumi.String("okta.logs.read"),
				},
			},
		})
		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 example = new Okta.ApiServiceIntegration("example", new()
    {
        Type = "anzennaapiservice",
        GrantedScopes = new[]
        {
            new Okta.Inputs.ApiServiceIntegrationGrantedScopeArgs
            {
                Scope = "okta.users.read",
            },
            new Okta.Inputs.ApiServiceIntegrationGrantedScopeArgs
            {
                Scope = "okta.groups.read",
            },
            new Okta.Inputs.ApiServiceIntegrationGrantedScopeArgs
            {
                Scope = "okta.logs.read",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.ApiServiceIntegration;
import com.pulumi.okta.ApiServiceIntegrationArgs;
import com.pulumi.okta.inputs.ApiServiceIntegrationGrantedScopeArgs;
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) {
        var example = new ApiServiceIntegration("example", ApiServiceIntegrationArgs.builder()
            .type("anzennaapiservice")
            .grantedScopes(            
                ApiServiceIntegrationGrantedScopeArgs.builder()
                    .scope("okta.users.read")
                    .build(),
                ApiServiceIntegrationGrantedScopeArgs.builder()
                    .scope("okta.groups.read")
                    .build(),
                ApiServiceIntegrationGrantedScopeArgs.builder()
                    .scope("okta.logs.read")
                    .build())
            .build());

    }
}

    resources:
  example:
    type: okta:ApiServiceIntegration
    properties:
      type: anzennaapiservice
      grantedScopes:
        - scope: okta.users.read
        - scope: okta.groups.read
        - scope: okta.logs.read

    Create ApiServiceIntegration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiServiceIntegration(name: string, args: ApiServiceIntegrationArgs, opts?: CustomResourceOptions);
    @overload
def ApiServiceIntegration(resource_name: str,
                          args: ApiServiceIntegrationArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ApiServiceIntegration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          type: Optional[str] = None,
                          granted_scopes: Optional[Sequence[ApiServiceIntegrationGrantedScopeArgs]] = None)
    func NewApiServiceIntegration(ctx *Context, name string, args ApiServiceIntegrationArgs, opts ...ResourceOption) (*ApiServiceIntegration, error)
    public ApiServiceIntegration(string name, ApiServiceIntegrationArgs args, CustomResourceOptions? opts = null)
    public ApiServiceIntegration(String name, ApiServiceIntegrationArgs args)
public ApiServiceIntegration(String name, ApiServiceIntegrationArgs args, CustomResourceOptions options)

    type: okta:ApiServiceIntegration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiServiceIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiServiceIntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiServiceIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiServiceIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiServiceIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiServiceIntegrationResource = new Okta.ApiServiceIntegration("apiServiceIntegrationResource", new()
{
    Type = "string",
    GrantedScopes = new[]
    {
        new Okta.Inputs.ApiServiceIntegrationGrantedScopeArgs
        {
            Scope = "string",
        },
    },
});

    example, err := okta.NewApiServiceIntegration(ctx, "apiServiceIntegrationResource", &okta.ApiServiceIntegrationArgs{
	Type: pulumi.String("string"),
	GrantedScopes: okta.ApiServiceIntegrationGrantedScopeArray{
		&okta.ApiServiceIntegrationGrantedScopeArgs{
			Scope: pulumi.String("string"),
		},
	},
})

    var apiServiceIntegrationResource = new ApiServiceIntegration("apiServiceIntegrationResource", ApiServiceIntegrationArgs.builder()
    .type("string")
    .grantedScopes(ApiServiceIntegrationGrantedScopeArgs.builder()
        .scope("string")
        .build())
    .build());

    api_service_integration_resource = okta.ApiServiceIntegration("apiServiceIntegrationResource",
    type="string",
    granted_scopes=[{
        "scope": "string",
    }])

    const apiServiceIntegrationResource = new okta.ApiServiceIntegration("apiServiceIntegrationResource", {
    type: "string",
    grantedScopes: [{
        scope: "string",
    }],
});

    type: okta:ApiServiceIntegration
properties:
    grantedScopes:
        - scope: string
    type: string

    ApiServiceIntegration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiServiceIntegration resource accepts the following input properties:

    Type string
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    GrantedScopes List<ApiServiceIntegrationGrantedScope>
    The list of Okta management scopes granted to the API Service Integration instance.
    Type string
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    GrantedScopes []ApiServiceIntegrationGrantedScopeArgs
    The list of Okta management scopes granted to the API Service Integration instance.
    type String
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    grantedScopes List<ApiServiceIntegrationGrantedScope>
    The list of Okta management scopes granted to the API Service Integration instance.
    type string
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    grantedScopes ApiServiceIntegrationGrantedScope[]
    The list of Okta management scopes granted to the API Service Integration instance.
    type str
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    granted_scopes Sequence[ApiServiceIntegrationGrantedScopeArgs]
    The list of Okta management scopes granted to the API Service Integration instance.
    type String
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    grantedScopes List<Property Map>
    The list of Okta management scopes granted to the API Service Integration instance.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiServiceIntegration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the API service integration that corresponds with the type property.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the API service integration that corresponds with the type property.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the API service integration that corresponds with the type property.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the API service integration that corresponds with the type property.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the API service integration that corresponds with the type property.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the API service integration that corresponds with the type property.

    Look up Existing ApiServiceIntegration Resource

    Get an existing ApiServiceIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiServiceIntegrationState, opts?: CustomResourceOptions): ApiServiceIntegration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        granted_scopes: Optional[Sequence[ApiServiceIntegrationGrantedScopeArgs]] = None,
        name: Optional[str] = None,
        type: Optional[str] = None) -> ApiServiceIntegration
    func GetApiServiceIntegration(ctx *Context, name string, id IDInput, state *ApiServiceIntegrationState, opts ...ResourceOption) (*ApiServiceIntegration, error)
    public static ApiServiceIntegration Get(string name, Input<string> id, ApiServiceIntegrationState? state, CustomResourceOptions? opts = null)
    public static ApiServiceIntegration get(String name, Output<String> id, ApiServiceIntegrationState state, CustomResourceOptions options)
    resources:  _:    type: okta:ApiServiceIntegration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    GrantedScopes List<ApiServiceIntegrationGrantedScope>
    The list of Okta management scopes granted to the API Service Integration instance.
    Name string
    The name of the API service integration that corresponds with the type property.
    Type string
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    GrantedScopes []ApiServiceIntegrationGrantedScopeArgs
    The list of Okta management scopes granted to the API Service Integration instance.
    Name string
    The name of the API service integration that corresponds with the type property.
    Type string
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    grantedScopes List<ApiServiceIntegrationGrantedScope>
    The list of Okta management scopes granted to the API Service Integration instance.
    name String
    The name of the API service integration that corresponds with the type property.
    type String
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    grantedScopes ApiServiceIntegrationGrantedScope[]
    The list of Okta management scopes granted to the API Service Integration instance.
    name string
    The name of the API service integration that corresponds with the type property.
    type string
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    granted_scopes Sequence[ApiServiceIntegrationGrantedScopeArgs]
    The list of Okta management scopes granted to the API Service Integration instance.
    name str
    The name of the API service integration that corresponds with the type property.
    type str
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.
    grantedScopes List<Property Map>
    The list of Okta management scopes granted to the API Service Integration instance.
    name String
    The name of the API service integration that corresponds with the type property.
    type String
    The type of the API service integration. This string is an underscore-concatenated, lowercased API service integration name.

    Supporting Types

    ApiServiceIntegrationGrantedScope, ApiServiceIntegrationGrantedScopeArgs

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

    Import

    $ pulumi import okta:index/apiServiceIntegration:ApiServiceIntegration example <api_service_integration_id>

    To learn more about importing existing cloud resources, see Importing resources.

    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
    Schema (JSON)
    pulumi/pulumi-okta
      Meet Neo: Your AI Platform Teammate