1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. getAuthenticationPolicy
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

oci.Identity.getAuthenticationPolicy

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi

    This data source provides details about a specific Authentication Policy resource in Oracle Cloud Infrastructure Identity service.

    Gets the authentication policy for the given tenancy. You must specify your tenant’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment).

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testAuthenticationPolicy = Oci.Identity.GetAuthenticationPolicy.Invoke(new()
        {
            CompartmentId = @var.Tenancy_ocid,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Identity.GetAuthenticationPolicy(ctx, &identity.GetAuthenticationPolicyArgs{
    			CompartmentId: _var.Tenancy_ocid,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Identity.IdentityFunctions;
    import com.pulumi.oci.Identity.inputs.GetAuthenticationPolicyArgs;
    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 testAuthenticationPolicy = IdentityFunctions.getAuthenticationPolicy(GetAuthenticationPolicyArgs.builder()
                .compartmentId(var_.tenancy_ocid())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_oci as oci
    
    test_authentication_policy = oci.Identity.get_authentication_policy(compartment_id=var["tenancy_ocid"])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAuthenticationPolicy = oci.Identity.getAuthenticationPolicy({
        compartmentId: _var.tenancy_ocid,
    });
    
    variables:
      testAuthenticationPolicy:
        fn::invoke:
          Function: oci:Identity:getAuthenticationPolicy
          Arguments:
            compartmentId: ${var.tenancy_ocid}
    

    Using getAuthenticationPolicy

    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 getAuthenticationPolicy(args: GetAuthenticationPolicyArgs, opts?: InvokeOptions): Promise<GetAuthenticationPolicyResult>
    function getAuthenticationPolicyOutput(args: GetAuthenticationPolicyOutputArgs, opts?: InvokeOptions): Output<GetAuthenticationPolicyResult>
    def get_authentication_policy(compartment_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetAuthenticationPolicyResult
    def get_authentication_policy_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetAuthenticationPolicyResult]
    func GetAuthenticationPolicy(ctx *Context, args *GetAuthenticationPolicyArgs, opts ...InvokeOption) (*GetAuthenticationPolicyResult, error)
    func GetAuthenticationPolicyOutput(ctx *Context, args *GetAuthenticationPolicyOutputArgs, opts ...InvokeOption) GetAuthenticationPolicyResultOutput

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

    public static class GetAuthenticationPolicy 
    {
        public static Task<GetAuthenticationPolicyResult> InvokeAsync(GetAuthenticationPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthenticationPolicyResult> Invoke(GetAuthenticationPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthenticationPolicyResult> getAuthenticationPolicy(GetAuthenticationPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Identity/getAuthenticationPolicy:getAuthenticationPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment.
    CompartmentId string
    The OCID of the compartment.
    compartmentId String
    The OCID of the compartment.
    compartmentId string
    The OCID of the compartment.
    compartment_id str
    The OCID of the compartment.
    compartmentId String
    The OCID of the compartment.

    getAuthenticationPolicy Result

    The following output properties are available:

    CompartmentId string
    Compartment OCID.
    Id string
    NetworkPolicies List<GetAuthenticationPolicyNetworkPolicy>
    Network policy, Consists of a list of Network Source ids.
    PasswordPolicies List<GetAuthenticationPolicyPasswordPolicy>
    Password policy, currently set for the given compartment.
    CompartmentId string
    Compartment OCID.
    Id string
    NetworkPolicies []GetAuthenticationPolicyNetworkPolicy
    Network policy, Consists of a list of Network Source ids.
    PasswordPolicies []GetAuthenticationPolicyPasswordPolicy
    Password policy, currently set for the given compartment.
    compartmentId String
    Compartment OCID.
    id String
    networkPolicies List<GetAuthenticationPolicyNetworkPolicy>
    Network policy, Consists of a list of Network Source ids.
    passwordPolicies List<GetAuthenticationPolicyPasswordPolicy>
    Password policy, currently set for the given compartment.
    compartmentId string
    Compartment OCID.
    id string
    networkPolicies GetAuthenticationPolicyNetworkPolicy[]
    Network policy, Consists of a list of Network Source ids.
    passwordPolicies GetAuthenticationPolicyPasswordPolicy[]
    Password policy, currently set for the given compartment.
    compartment_id str
    Compartment OCID.
    id str
    network_policies GetAuthenticationPolicyNetworkPolicy]
    Network policy, Consists of a list of Network Source ids.
    password_policies GetAuthenticationPolicyPasswordPolicy]
    Password policy, currently set for the given compartment.
    compartmentId String
    Compartment OCID.
    id String
    networkPolicies List<Property Map>
    Network policy, Consists of a list of Network Source ids.
    passwordPolicies List<Property Map>
    Password policy, currently set for the given compartment.

    Supporting Types

    GetAuthenticationPolicyNetworkPolicy

    NetworkSourceIds List<string>
    Network Source ids
    NetworkSourceIds []string
    Network Source ids
    networkSourceIds List<String>
    Network Source ids
    networkSourceIds string[]
    Network Source ids
    network_source_ids Sequence[str]
    Network Source ids
    networkSourceIds List<String>
    Network Source ids

    GetAuthenticationPolicyPasswordPolicy

    IsLowercaseCharactersRequired bool
    At least one lower case character required.
    IsNumericCharactersRequired bool
    At least one numeric character required.
    IsSpecialCharactersRequired bool
    At least one special character required.
    IsUppercaseCharactersRequired bool
    At least one uppercase character required.
    IsUsernameContainmentAllowed bool
    User name is allowed to be part of the password.
    MinimumPasswordLength int
    Minimum password length required.
    IsLowercaseCharactersRequired bool
    At least one lower case character required.
    IsNumericCharactersRequired bool
    At least one numeric character required.
    IsSpecialCharactersRequired bool
    At least one special character required.
    IsUppercaseCharactersRequired bool
    At least one uppercase character required.
    IsUsernameContainmentAllowed bool
    User name is allowed to be part of the password.
    MinimumPasswordLength int
    Minimum password length required.
    isLowercaseCharactersRequired Boolean
    At least one lower case character required.
    isNumericCharactersRequired Boolean
    At least one numeric character required.
    isSpecialCharactersRequired Boolean
    At least one special character required.
    isUppercaseCharactersRequired Boolean
    At least one uppercase character required.
    isUsernameContainmentAllowed Boolean
    User name is allowed to be part of the password.
    minimumPasswordLength Integer
    Minimum password length required.
    isLowercaseCharactersRequired boolean
    At least one lower case character required.
    isNumericCharactersRequired boolean
    At least one numeric character required.
    isSpecialCharactersRequired boolean
    At least one special character required.
    isUppercaseCharactersRequired boolean
    At least one uppercase character required.
    isUsernameContainmentAllowed boolean
    User name is allowed to be part of the password.
    minimumPasswordLength number
    Minimum password length required.
    is_lowercase_characters_required bool
    At least one lower case character required.
    is_numeric_characters_required bool
    At least one numeric character required.
    is_special_characters_required bool
    At least one special character required.
    is_uppercase_characters_required bool
    At least one uppercase character required.
    is_username_containment_allowed bool
    User name is allowed to be part of the password.
    minimum_password_length int
    Minimum password length required.
    isLowercaseCharactersRequired Boolean
    At least one lower case character required.
    isNumericCharactersRequired Boolean
    At least one numeric character required.
    isSpecialCharactersRequired Boolean
    At least one special character required.
    isUppercaseCharactersRequired Boolean
    At least one uppercase character required.
    isUsernameContainmentAllowed Boolean
    User name is allowed to be part of the password.
    minimumPasswordLength Number
    Minimum password length required.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.24.0 published on Thursday, Feb 22, 2024 by Pulumi