1. Packages
  2. Okta Provider
  3. API Docs
  4. getPushGroups
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
okta logo
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi

    Gets a list of Push Group mappings for an Application in Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    export = async () => {
        const sample = await okta.getPushGroups({
            appId: "<okta_app_id>",
        });
        return {
            sample: sample.mappings,
        };
    }
    
    import pulumi
    import pulumi_okta as okta
    
    sample = okta.get_push_groups(app_id="<okta_app_id>")
    pulumi.export("sample", sample.mappings)
    
    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 {
    		sample, err := okta.GetPushGroups(ctx, &okta.GetPushGroupsArgs{
    			AppId: "<okta_app_id>",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("sample", sample.Mappings)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var sample = Okta.GetPushGroups.Invoke(new()
        {
            AppId = "<okta_app_id>",
        });
    
        return new Dictionary<string, object?>
        {
            ["sample"] = sample.Apply(getPushGroupsResult => getPushGroupsResult.Mappings),
        };
    });
    
    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.GetPushGroupsArgs;
    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 sample = OktaFunctions.getPushGroups(GetPushGroupsArgs.builder()
                .appId("<okta_app_id>")
                .build());
    
            ctx.export("sample", sample.mappings());
        }
    }
    
    variables:
      sample:
        fn::invoke:
          function: okta:getPushGroups
          arguments:
            appId: <okta_app_id>
    outputs:
      sample: ${sample.mappings}
    

    Using getPushGroups

    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 getPushGroups(args: GetPushGroupsArgs, opts?: InvokeOptions): Promise<GetPushGroupsResult>
    function getPushGroupsOutput(args: GetPushGroupsOutputArgs, opts?: InvokeOptions): Output<GetPushGroupsResult>
    def get_push_groups(app_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPushGroupsResult
    def get_push_groups_output(app_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPushGroupsResult]
    func GetPushGroups(ctx *Context, args *GetPushGroupsArgs, opts ...InvokeOption) (*GetPushGroupsResult, error)
    func GetPushGroupsOutput(ctx *Context, args *GetPushGroupsOutputArgs, opts ...InvokeOption) GetPushGroupsResultOutput

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

    public static class GetPushGroups 
    {
        public static Task<GetPushGroupsResult> InvokeAsync(GetPushGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetPushGroupsResult> Invoke(GetPushGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPushGroupsResult> getPushGroups(GetPushGroupsArgs args, InvokeOptions options)
    public static Output<GetPushGroupsResult> getPushGroups(GetPushGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getPushGroups:getPushGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AppId string
    The ID of the Okta Application.
    AppId string
    The ID of the Okta Application.
    appId String
    The ID of the Okta Application.
    appId string
    The ID of the Okta Application.
    app_id str
    The ID of the Okta Application.
    appId String
    The ID of the Okta Application.

    getPushGroups Result

    The following output properties are available:

    AppId string
    The ID of the Okta Application.
    Id string
    Mappings List<GetPushGroupsMapping>
    List of Push Group mappings for the Application.
    AppId string
    The ID of the Okta Application.
    Id string
    Mappings []GetPushGroupsMapping
    List of Push Group mappings for the Application.
    appId String
    The ID of the Okta Application.
    id String
    mappings List<GetPushGroupsMapping>
    List of Push Group mappings for the Application.
    appId string
    The ID of the Okta Application.
    id string
    mappings GetPushGroupsMapping[]
    List of Push Group mappings for the Application.
    app_id str
    The ID of the Okta Application.
    id str
    mappings Sequence[GetPushGroupsMapping]
    List of Push Group mappings for the Application.
    appId String
    The ID of the Okta Application.
    id String
    mappings List<Property Map>
    List of Push Group mappings for the Application.

    Supporting Types

    GetPushGroupsMapping

    AppId string
    Id string
    SourceGroupId string
    Status string
    AppId string
    Id string
    SourceGroupId string
    Status string
    appId String
    id String
    sourceGroupId String
    status String
    appId string
    id string
    sourceGroupId string
    status string
    appId String
    id String
    sourceGroupId String
    status 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
      Try Pulumi Cloud free. Your team will thank you.