1. Packages
  2. Okta Provider
  3. API Docs
  4. getCampaign
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.getCampaign

okta logo
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Get the campaign belonging to an Okta organization.

    Example Usage

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

const test = okta.getCampaign({
    id: "<campaign id>",
});

    import pulumi
import pulumi_okta as okta

test = okta.get_campaign(id="<campaign 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.LookupCampaign(ctx, &okta.LookupCampaignArgs{
			Id: pulumi.StringRef("<campaign 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.GetCampaign.Invoke(new()
    {
        Id = "<campaign 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.GetCampaignArgs;
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.getCampaign(GetCampaignArgs.builder()
            .id("<campaign id>")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: okta:getCampaign
      arguments:
        id: <campaign id>

    Using getCampaign

    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 getCampaign(args: GetCampaignArgs, opts?: InvokeOptions): Promise<GetCampaignResult>
function getCampaignOutput(args: GetCampaignOutputArgs, opts?: InvokeOptions): Output<GetCampaignResult>
    def get_campaign(campaign_type: Optional[str] = None,
                 description: Optional[str] = None,
                 id: Optional[str] = None,
                 notification_settings: Optional[GetCampaignNotificationSettings] = None,
                 principal_scope_settings: Optional[GetCampaignPrincipalScopeSettings] = None,
                 remediation_settings: Optional[GetCampaignRemediationSettings] = None,
                 resource_settings: Optional[GetCampaignResourceSettings] = None,
                 reviewer_settings: Optional[GetCampaignReviewerSettings] = None,
                 schedule_settings: Optional[GetCampaignScheduleSettings] = None,
                 opts: Optional[InvokeOptions] = None) -> GetCampaignResult
def get_campaign_output(campaign_type: Optional[pulumi.Input[str]] = None,
                 description: Optional[pulumi.Input[str]] = None,
                 id: Optional[pulumi.Input[str]] = None,
                 notification_settings: Optional[pulumi.Input[GetCampaignNotificationSettingsArgs]] = None,
                 principal_scope_settings: Optional[pulumi.Input[GetCampaignPrincipalScopeSettingsArgs]] = None,
                 remediation_settings: Optional[pulumi.Input[GetCampaignRemediationSettingsArgs]] = None,
                 resource_settings: Optional[pulumi.Input[GetCampaignResourceSettingsArgs]] = None,
                 reviewer_settings: Optional[pulumi.Input[GetCampaignReviewerSettingsArgs]] = None,
                 schedule_settings: Optional[pulumi.Input[GetCampaignScheduleSettingsArgs]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetCampaignResult]
    func LookupCampaign(ctx *Context, args *LookupCampaignArgs, opts ...InvokeOption) (*LookupCampaignResult, error)
func LookupCampaignOutput(ctx *Context, args *LookupCampaignOutputArgs, opts ...InvokeOption) LookupCampaignResultOutput

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

    public static class GetCampaign 
{
    public static Task<GetCampaignResult> InvokeAsync(GetCampaignArgs args, InvokeOptions? opts = null)
    public static Output<GetCampaignResult> Invoke(GetCampaignInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCampaignResult> getCampaign(GetCampaignArgs args, InvokeOptions options)
public static Output<GetCampaignResult> getCampaign(GetCampaignArgs args, InvokeOptions options)

    fn::invoke:
  function: okta:index/getCampaign:getCampaign
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getCampaign Result

    The following output properties are available:

    Supporting Types

    GetCampaignNotificationSettings

    GetCampaignPrincipalScopeSettings

    GetCampaignPrincipalScopeSettingsPredefinedInactiveUsersScope

    inactiveDays Integer

    GetCampaignRemediationSettings

    AccessApproved string
    Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
    AccessRevoked string
    Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
    NoResponse string
    Specifies the action if the reviewer doesn't respond to the request.
    AutoRemediationSettings GetCampaignRemediationSettingsAutoRemediationSettings
    AccessApproved string
    Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
    AccessRevoked string
    Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
    NoResponse string
    Specifies the action if the reviewer doesn't respond to the request.
    AutoRemediationSettings GetCampaignRemediationSettingsAutoRemediationSettings
    accessApproved String
    Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
    accessRevoked String
    Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
    noResponse String
    Specifies the action if the reviewer doesn't respond to the request.
    autoRemediationSettings GetCampaignRemediationSettingsAutoRemediationSettings
    accessApproved string
    Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
    accessRevoked string
    Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
    noResponse string
    Specifies the action if the reviewer doesn't respond to the request.
    autoRemediationSettings GetCampaignRemediationSettingsAutoRemediationSettings
    access_approved str
    Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
    access_revoked str
    Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
    no_response str
    Specifies the action if the reviewer doesn't respond to the request.
    auto_remediation_settings GetCampaignRemediationSettingsAutoRemediationSettings
    accessApproved String
    Specifies the action by default if the reviewer approves access. NO_ACTION indicates there is no remediation action and the user retains access.
    accessRevoked String
    Specifies the action if the reviewer revokes access. NO_ACTION indicates the user retains the same access. DENY indicates the user will have their access revoked as long as they are not assigned to a group through Group Rules.
    noResponse String
    Specifies the action if the reviewer doesn't respond to the request.
    autoRemediationSettings Property Map

    GetCampaignRemediationSettingsAutoRemediationSettings

    IncludeAllIndirectAssignments bool
    When a group is selected to be automatically remediated.
    IncludeOnlies List<GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly>
    An array of resources to be automatically remediated.
    IncludeAllIndirectAssignments bool
    When a group is selected to be automatically remediated.
    IncludeOnlies []GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly
    An array of resources to be automatically remediated.
    includeAllIndirectAssignments Boolean
    When a group is selected to be automatically remediated.
    includeOnlies List<GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly>
    An array of resources to be automatically remediated.
    includeAllIndirectAssignments boolean
    When a group is selected to be automatically remediated.
    includeOnlies GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly[]
    An array of resources to be automatically remediated.
    include_all_indirect_assignments bool
    When a group is selected to be automatically remediated.
    include_onlies Sequence[GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly]
    An array of resources to be automatically remediated.
    includeAllIndirectAssignments Boolean
    When a group is selected to be automatically remediated.
    includeOnlies List<Property Map>
    An array of resources to be automatically remediated.

    GetCampaignRemediationSettingsAutoRemediationSettingsIncludeOnly

    ResourceId string
    The resource ID of the target resource When type = GROUP, it will point to the group ID.
    ResourceType string
    The type of the resource to be automatically remediated. Only GROUP is supported.
    ResourceId string
    The resource ID of the target resource When type = GROUP, it will point to the group ID.
    ResourceType string
    The type of the resource to be automatically remediated. Only GROUP is supported.
    resourceId String
    The resource ID of the target resource When type = GROUP, it will point to the group ID.
    resourceType String
    The type of the resource to be automatically remediated. Only GROUP is supported.
    resourceId string
    The resource ID of the target resource When type = GROUP, it will point to the group ID.
    resourceType string
    The type of the resource to be automatically remediated. Only GROUP is supported.
    resource_id str
    The resource ID of the target resource When type = GROUP, it will point to the group ID.
    resource_type str
    The type of the resource to be automatically remediated. Only GROUP is supported.
    resourceId String
    The resource ID of the target resource When type = GROUP, it will point to the group ID.
    resourceType String
    The type of the resource to be automatically remediated. Only GROUP is supported.

    GetCampaignResourceSettings

    IncludeAdminRoles bool
    Include admin roles.
    IncludeEntitlements bool
    Include entitlements for this application.
    IndividuallyAssignedAppsOnly bool
    Only include individually assigned groups.
    IndividuallyAssignedGroupsOnly bool
    Only include individually assigned groups.
    OnlyIncludeOutOfPolicyEntitlements bool
    Only include out-of-policy entitlements.
    Type string
    The type of Okta resource.
    ExcludedResources List<GetCampaignResourceSettingsExcludedResource>
    An array of resources that are excluded from the review.
    TargetResources List<GetCampaignResourceSettingsTargetResource>
    Represents a resource that will be part of Access certifications.
    IncludeAdminRoles bool
    Include admin roles.
    IncludeEntitlements bool
    Include entitlements for this application.
    IndividuallyAssignedAppsOnly bool
    Only include individually assigned groups.
    IndividuallyAssignedGroupsOnly bool
    Only include individually assigned groups.
    OnlyIncludeOutOfPolicyEntitlements bool
    Only include out-of-policy entitlements.
    Type string
    The type of Okta resource.
    ExcludedResources []GetCampaignResourceSettingsExcludedResource
    An array of resources that are excluded from the review.
    TargetResources []GetCampaignResourceSettingsTargetResource
    Represents a resource that will be part of Access certifications.
    includeAdminRoles Boolean
    Include admin roles.
    includeEntitlements Boolean
    Include entitlements for this application.
    individuallyAssignedAppsOnly Boolean
    Only include individually assigned groups.
    individuallyAssignedGroupsOnly Boolean
    Only include individually assigned groups.
    onlyIncludeOutOfPolicyEntitlements Boolean
    Only include out-of-policy entitlements.
    type String
    The type of Okta resource.
    excludedResources List<GetCampaignResourceSettingsExcludedResource>
    An array of resources that are excluded from the review.
    targetResources List<GetCampaignResourceSettingsTargetResource>
    Represents a resource that will be part of Access certifications.
    includeAdminRoles boolean
    Include admin roles.
    includeEntitlements boolean
    Include entitlements for this application.
    individuallyAssignedAppsOnly boolean
    Only include individually assigned groups.
    individuallyAssignedGroupsOnly boolean
    Only include individually assigned groups.
    onlyIncludeOutOfPolicyEntitlements boolean
    Only include out-of-policy entitlements.
    type string
    The type of Okta resource.
    excludedResources GetCampaignResourceSettingsExcludedResource[]
    An array of resources that are excluded from the review.
    targetResources GetCampaignResourceSettingsTargetResource[]
    Represents a resource that will be part of Access certifications.
    include_admin_roles bool
    Include admin roles.
    include_entitlements bool
    Include entitlements for this application.
    individually_assigned_apps_only bool
    Only include individually assigned groups.
    individually_assigned_groups_only bool
    Only include individually assigned groups.
    only_include_out_of_policy_entitlements bool
    Only include out-of-policy entitlements.
    type str
    The type of Okta resource.
    excluded_resources Sequence[GetCampaignResourceSettingsExcludedResource]
    An array of resources that are excluded from the review.
    target_resources Sequence[GetCampaignResourceSettingsTargetResource]
    Represents a resource that will be part of Access certifications.
    includeAdminRoles Boolean
    Include admin roles.
    includeEntitlements Boolean
    Include entitlements for this application.
    individuallyAssignedAppsOnly Boolean
    Only include individually assigned groups.
    individuallyAssignedGroupsOnly Boolean
    Only include individually assigned groups.
    onlyIncludeOutOfPolicyEntitlements Boolean
    Only include out-of-policy entitlements.
    type String
    The type of Okta resource.
    excludedResources List<Property Map>
    An array of resources that are excluded from the review.
    targetResources List<Property Map>
    Represents a resource that will be part of Access certifications.

    GetCampaignResourceSettingsExcludedResource

    ResourceId string
    Okta specific resource ID.
    ResourceType string
    The type of Okta resource.
    ResourceId string
    Okta specific resource ID.
    ResourceType string
    The type of Okta resource.
    resourceId String
    Okta specific resource ID.
    resourceType String
    The type of Okta resource.
    resourceId string
    Okta specific resource ID.
    resourceType string
    The type of Okta resource.
    resource_id str
    Okta specific resource ID.
    resource_type str
    The type of Okta resource.
    resourceId String
    Okta specific resource ID.
    resourceType String
    The type of Okta resource.

    GetCampaignResourceSettingsTargetResource

    IncludeAllEntitlementsAndBundles bool
    Include all entitlements and entitlement bundles for this application.
    ResourceId string
    The resource ID that is being reviewed.
    ResourceType string
    The type of Okta resource.
    EntitlementBundles List<GetCampaignResourceSettingsTargetResourceEntitlementBundle>
    An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
    Entitlements List<GetCampaignResourceSettingsTargetResourceEntitlement>
    IncludeAllEntitlementsAndBundles bool
    Include all entitlements and entitlement bundles for this application.
    ResourceId string
    The resource ID that is being reviewed.
    ResourceType string
    The type of Okta resource.
    EntitlementBundles []GetCampaignResourceSettingsTargetResourceEntitlementBundle
    An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
    Entitlements []GetCampaignResourceSettingsTargetResourceEntitlement
    includeAllEntitlementsAndBundles Boolean
    Include all entitlements and entitlement bundles for this application.
    resourceId String
    The resource ID that is being reviewed.
    resourceType String
    The type of Okta resource.
    entitlementBundles List<GetCampaignResourceSettingsTargetResourceEntitlementBundle>
    An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
    entitlements List<GetCampaignResourceSettingsTargetResourceEntitlement>
    includeAllEntitlementsAndBundles boolean
    Include all entitlements and entitlement bundles for this application.
    resourceId string
    The resource ID that is being reviewed.
    resourceType string
    The type of Okta resource.
    entitlementBundles GetCampaignResourceSettingsTargetResourceEntitlementBundle[]
    An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
    entitlements GetCampaignResourceSettingsTargetResourceEntitlement[]
    include_all_entitlements_and_bundles bool
    Include all entitlements and entitlement bundles for this application.
    resource_id str
    The resource ID that is being reviewed.
    resource_type str
    The type of Okta resource.
    entitlement_bundles Sequence[GetCampaignResourceSettingsTargetResourceEntitlementBundle]
    An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
    entitlements Sequence[GetCampaignResourceSettingsTargetResourceEntitlement]
    includeAllEntitlementsAndBundles Boolean
    Include all entitlements and entitlement bundles for this application.
    resourceId String
    The resource ID that is being reviewed.
    resourceType String
    The type of Okta resource.
    entitlementBundles List<Property Map>
    An array of entitlement bundles associated with resourceId that should be chosen as target when creating reviews.
    entitlements List<Property Map>

    GetCampaignResourceSettingsTargetResourceEntitlement

    Id string
    The ID of this resource.
    IncludeAllValues bool
    Whether to include all values for this entitlement.
    Values List<GetCampaignResourceSettingsTargetResourceEntitlementValue>
    Entitlement value ids
    Id string
    The ID of this resource.
    IncludeAllValues bool
    Whether to include all values for this entitlement.
    Values []GetCampaignResourceSettingsTargetResourceEntitlementValue
    Entitlement value ids
    id String
    The ID of this resource.
    includeAllValues Boolean
    Whether to include all values for this entitlement.
    values List<GetCampaignResourceSettingsTargetResourceEntitlementValue>
    Entitlement value ids
    id string
    The ID of this resource.
    includeAllValues boolean
    Whether to include all values for this entitlement.
    values GetCampaignResourceSettingsTargetResourceEntitlementValue[]
    Entitlement value ids
    id str
    The ID of this resource.
    include_all_values bool
    Whether to include all values for this entitlement.
    values Sequence[GetCampaignResourceSettingsTargetResourceEntitlementValue]
    Entitlement value ids
    id String
    The ID of this resource.
    includeAllValues Boolean
    Whether to include all values for this entitlement.
    values List<Property Map>
    Entitlement value ids

    GetCampaignResourceSettingsTargetResourceEntitlementBundle

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    id String
    The ID of this resource.

    GetCampaignResourceSettingsTargetResourceEntitlementValue

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    id String
    The ID of this resource.

    GetCampaignReviewerSettings

    GetCampaignReviewerSettingsReviewerLevel

    GetCampaignReviewerSettingsReviewerLevelStartReview

    OnDay int
    When string
    OnDay int
    When string
    onDay Integer
    when String
    onDay number
    when string
    on_day int
    when str
    onDay Number
    when String

    GetCampaignScheduleSettings

    GetCampaignScheduleSettingsRecurrence

    Ends string
    Interval string
    RepeatOnType string
    Ends string
    Interval string
    RepeatOnType string
    ends String
    interval String
    repeatOnType String
    ends string
    interval string
    repeatOnType string
    ends String
    interval String
    repeatOnType String

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v6.3.1
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta
      Try Pulumi Cloud free. Your team will thank you.