1. Packages
  2. Okta Provider
  3. API Docs
  4. getAppSignonPolicy
Okta v4.11.1 published on Monday, Oct 7, 2024 by Pulumi

okta.getAppSignonPolicy

Explore with Pulumi AI

okta logo
Okta v4.11.1 published on Monday, Oct 7, 2024 by Pulumi

    Get a sign-on policy for the application.

    WARNING: This feature is only available as a part of the Identity Engine. Contact support for further information.

    Inside the product a sign-on policy is referenced as an authentication policy, in the public API the policy is of type ACCESS_POLICY.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.getAppSignonPolicy({
        appId: "app_id",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_app_signon_policy(app_id="app_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.LookupAppSignonPolicy(ctx, &okta.LookupAppSignonPolicyArgs{
    			AppId: "app_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 example = Okta.GetAppSignonPolicy.Invoke(new()
        {
            AppId = "app_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.GetAppSignonPolicyArgs;
    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 example = OktaFunctions.getAppSignonPolicy(GetAppSignonPolicyArgs.builder()
                .appId("app_id")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: okta:getAppSignonPolicy
          Arguments:
            appId: app_id
    

    Using getAppSignonPolicy

    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 getAppSignonPolicy(args: GetAppSignonPolicyArgs, opts?: InvokeOptions): Promise<GetAppSignonPolicyResult>
    function getAppSignonPolicyOutput(args: GetAppSignonPolicyOutputArgs, opts?: InvokeOptions): Output<GetAppSignonPolicyResult>
    def get_app_signon_policy(app_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAppSignonPolicyResult
    def get_app_signon_policy_output(app_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAppSignonPolicyResult]
    func LookupAppSignonPolicy(ctx *Context, args *LookupAppSignonPolicyArgs, opts ...InvokeOption) (*LookupAppSignonPolicyResult, error)
    func LookupAppSignonPolicyOutput(ctx *Context, args *LookupAppSignonPolicyOutputArgs, opts ...InvokeOption) LookupAppSignonPolicyResultOutput

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

    public static class GetAppSignonPolicy 
    {
        public static Task<GetAppSignonPolicyResult> InvokeAsync(GetAppSignonPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetAppSignonPolicyResult> Invoke(GetAppSignonPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppSignonPolicyResult> getAppSignonPolicy(GetAppSignonPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:index/getAppSignonPolicy:getAppSignonPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AppId string
    App ID
    AppId string
    App ID
    appId String
    App ID
    appId string
    App ID
    app_id str
    App ID
    appId String
    App ID

    getAppSignonPolicy Result

    The following output properties are available:

    AppId string
    App ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Policy name
    AppId string
    App ID
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Policy name
    appId String
    App ID
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Policy name
    appId string
    App ID
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Policy name
    app_id str
    App ID
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Policy name
    appId String
    App ID
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Policy name

    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 v4.11.1 published on Monday, Oct 7, 2024 by Pulumi