Docs Packages
  1. Packages
  2. Harbor
  3. API Docs
  4. ConfigAuth
Harbor v3.10.8 published on Wednesday, Feb 14, 2024 by Pulumiverse
pulumiverse/pulumi-harbor

harbor.ConfigAuth

Explore with Pulumi AI

harbor logo
Harbor v3.10.8 published on Wednesday, Feb 14, 2024 by Pulumiverse
pulumiverse/pulumi-harbor

    Create ConfigAuth Resource

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

    Constructor syntax

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

@overload
def ConfigAuth(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               auth_mode: Optional[str] = None,
               ldap_base_dn: Optional[str] = None,
               ldap_filter: Optional[str] = None,
               ldap_group_admin_dn: Optional[str] = None,
               ldap_group_base_dn: Optional[str] = None,
               ldap_group_filter: Optional[str] = None,
               ldap_group_gid: Optional[str] = None,
               ldap_group_membership: Optional[str] = None,
               ldap_group_scope: Optional[str] = None,
               ldap_group_uid: Optional[str] = None,
               ldap_scope: Optional[str] = None,
               ldap_search_dn: Optional[str] = None,
               ldap_search_password: Optional[str] = None,
               ldap_uid: Optional[str] = None,
               ldap_url: Optional[str] = None,
               ldap_verify_cert: Optional[bool] = None,
               oidc_admin_group: Optional[str] = None,
               oidc_auto_onboard: Optional[bool] = None,
               oidc_client_id: Optional[str] = None,
               oidc_client_secret: Optional[str] = None,
               oidc_endpoint: Optional[str] = None,
               oidc_group_filter: Optional[str] = None,
               oidc_groups_claim: Optional[str] = None,
               oidc_name: Optional[str] = None,
               oidc_scope: Optional[str] = None,
               oidc_user_claim: Optional[str] = None,
               oidc_verify_cert: Optional[bool] = None,
               primary_auth_mode: Optional[bool] = None)
    func NewConfigAuth(ctx *Context, name string, args ConfigAuthArgs, opts ...ResourceOption) (*ConfigAuth, error)
    public ConfigAuth(string name, ConfigAuthArgs args, CustomResourceOptions? opts = null)
    public ConfigAuth(String name, ConfigAuthArgs args)
public ConfigAuth(String name, ConfigAuthArgs args, CustomResourceOptions options)

    type: harbor:ConfigAuth
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 ConfigAuthArgs
    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 ConfigAuthArgs
    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 ConfigAuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigAuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigAuthArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var configAuthResource = new Harbor.ConfigAuth("configAuthResource", new()
{
    AuthMode = "string",
    LdapBaseDn = "string",
    LdapFilter = "string",
    LdapGroupAdminDn = "string",
    LdapGroupBaseDn = "string",
    LdapGroupFilter = "string",
    LdapGroupGid = "string",
    LdapGroupMembership = "string",
    LdapGroupScope = "string",
    LdapGroupUid = "string",
    LdapScope = "string",
    LdapSearchDn = "string",
    LdapSearchPassword = "string",
    LdapUid = "string",
    LdapUrl = "string",
    LdapVerifyCert = false,
    OidcAdminGroup = "string",
    OidcAutoOnboard = false,
    OidcClientId = "string",
    OidcClientSecret = "string",
    OidcEndpoint = "string",
    OidcGroupFilter = "string",
    OidcGroupsClaim = "string",
    OidcName = "string",
    OidcScope = "string",
    OidcUserClaim = "string",
    OidcVerifyCert = false,
    PrimaryAuthMode = false,
});

    example, err := harbor.NewConfigAuth(ctx, "configAuthResource", &harbor.ConfigAuthArgs{
	AuthMode:            pulumi.String("string"),
	LdapBaseDn:          pulumi.String("string"),
	LdapFilter:          pulumi.String("string"),
	LdapGroupAdminDn:    pulumi.String("string"),
	LdapGroupBaseDn:     pulumi.String("string"),
	LdapGroupFilter:     pulumi.String("string"),
	LdapGroupGid:        pulumi.String("string"),
	LdapGroupMembership: pulumi.String("string"),
	LdapGroupScope:      pulumi.String("string"),
	LdapGroupUid:        pulumi.String("string"),
	LdapScope:           pulumi.String("string"),
	LdapSearchDn:        pulumi.String("string"),
	LdapSearchPassword:  pulumi.String("string"),
	LdapUid:             pulumi.String("string"),
	LdapUrl:             pulumi.String("string"),
	LdapVerifyCert:      pulumi.Bool(false),
	OidcAdminGroup:      pulumi.String("string"),
	OidcAutoOnboard:     pulumi.Bool(false),
	OidcClientId:        pulumi.String("string"),
	OidcClientSecret:    pulumi.String("string"),
	OidcEndpoint:        pulumi.String("string"),
	OidcGroupFilter:     pulumi.String("string"),
	OidcGroupsClaim:     pulumi.String("string"),
	OidcName:            pulumi.String("string"),
	OidcScope:           pulumi.String("string"),
	OidcUserClaim:       pulumi.String("string"),
	OidcVerifyCert:      pulumi.Bool(false),
	PrimaryAuthMode:     pulumi.Bool(false),
})

    var configAuthResource = new ConfigAuth("configAuthResource", ConfigAuthArgs.builder()        
    .authMode("string")
    .ldapBaseDn("string")
    .ldapFilter("string")
    .ldapGroupAdminDn("string")
    .ldapGroupBaseDn("string")
    .ldapGroupFilter("string")
    .ldapGroupGid("string")
    .ldapGroupMembership("string")
    .ldapGroupScope("string")
    .ldapGroupUid("string")
    .ldapScope("string")
    .ldapSearchDn("string")
    .ldapSearchPassword("string")
    .ldapUid("string")
    .ldapUrl("string")
    .ldapVerifyCert(false)
    .oidcAdminGroup("string")
    .oidcAutoOnboard(false)
    .oidcClientId("string")
    .oidcClientSecret("string")
    .oidcEndpoint("string")
    .oidcGroupFilter("string")
    .oidcGroupsClaim("string")
    .oidcName("string")
    .oidcScope("string")
    .oidcUserClaim("string")
    .oidcVerifyCert(false)
    .primaryAuthMode(false)
    .build());

    config_auth_resource = harbor.ConfigAuth("configAuthResource",
    auth_mode="string",
    ldap_base_dn="string",
    ldap_filter="string",
    ldap_group_admin_dn="string",
    ldap_group_base_dn="string",
    ldap_group_filter="string",
    ldap_group_gid="string",
    ldap_group_membership="string",
    ldap_group_scope="string",
    ldap_group_uid="string",
    ldap_scope="string",
    ldap_search_dn="string",
    ldap_search_password="string",
    ldap_uid="string",
    ldap_url="string",
    ldap_verify_cert=False,
    oidc_admin_group="string",
    oidc_auto_onboard=False,
    oidc_client_id="string",
    oidc_client_secret="string",
    oidc_endpoint="string",
    oidc_group_filter="string",
    oidc_groups_claim="string",
    oidc_name="string",
    oidc_scope="string",
    oidc_user_claim="string",
    oidc_verify_cert=False,
    primary_auth_mode=False)

    const configAuthResource = new harbor.ConfigAuth("configAuthResource", {
    authMode: "string",
    ldapBaseDn: "string",
    ldapFilter: "string",
    ldapGroupAdminDn: "string",
    ldapGroupBaseDn: "string",
    ldapGroupFilter: "string",
    ldapGroupGid: "string",
    ldapGroupMembership: "string",
    ldapGroupScope: "string",
    ldapGroupUid: "string",
    ldapScope: "string",
    ldapSearchDn: "string",
    ldapSearchPassword: "string",
    ldapUid: "string",
    ldapUrl: "string",
    ldapVerifyCert: false,
    oidcAdminGroup: "string",
    oidcAutoOnboard: false,
    oidcClientId: "string",
    oidcClientSecret: "string",
    oidcEndpoint: "string",
    oidcGroupFilter: "string",
    oidcGroupsClaim: "string",
    oidcName: "string",
    oidcScope: "string",
    oidcUserClaim: "string",
    oidcVerifyCert: false,
    primaryAuthMode: false,
});

    type: harbor:ConfigAuth
properties:
    authMode: string
    ldapBaseDn: string
    ldapFilter: string
    ldapGroupAdminDn: string
    ldapGroupBaseDn: string
    ldapGroupFilter: string
    ldapGroupGid: string
    ldapGroupMembership: string
    ldapGroupScope: string
    ldapGroupUid: string
    ldapScope: string
    ldapSearchDn: string
    ldapSearchPassword: string
    ldapUid: string
    ldapUrl: string
    ldapVerifyCert: false
    oidcAdminGroup: string
    oidcAutoOnboard: false
    oidcClientId: string
    oidcClientSecret: string
    oidcEndpoint: string
    oidcGroupFilter: string
    oidcGroupsClaim: string
    oidcName: string
    oidcScope: string
    oidcUserClaim: string
    oidcVerifyCert: false
    primaryAuthMode: false

    ConfigAuth Resource Properties

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

    Inputs

    The ConfigAuth resource accepts the following input properties:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ConfigAuth Resource

    Get an existing ConfigAuth 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?: ConfigAuthState, opts?: CustomResourceOptions): ConfigAuth
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_mode: Optional[str] = None,
        ldap_base_dn: Optional[str] = None,
        ldap_filter: Optional[str] = None,
        ldap_group_admin_dn: Optional[str] = None,
        ldap_group_base_dn: Optional[str] = None,
        ldap_group_filter: Optional[str] = None,
        ldap_group_gid: Optional[str] = None,
        ldap_group_membership: Optional[str] = None,
        ldap_group_scope: Optional[str] = None,
        ldap_group_uid: Optional[str] = None,
        ldap_scope: Optional[str] = None,
        ldap_search_dn: Optional[str] = None,
        ldap_search_password: Optional[str] = None,
        ldap_uid: Optional[str] = None,
        ldap_url: Optional[str] = None,
        ldap_verify_cert: Optional[bool] = None,
        oidc_admin_group: Optional[str] = None,
        oidc_auto_onboard: Optional[bool] = None,
        oidc_client_id: Optional[str] = None,
        oidc_client_secret: Optional[str] = None,
        oidc_endpoint: Optional[str] = None,
        oidc_group_filter: Optional[str] = None,
        oidc_groups_claim: Optional[str] = None,
        oidc_name: Optional[str] = None,
        oidc_scope: Optional[str] = None,
        oidc_user_claim: Optional[str] = None,
        oidc_verify_cert: Optional[bool] = None,
        primary_auth_mode: Optional[bool] = None) -> ConfigAuth
    func GetConfigAuth(ctx *Context, name string, id IDInput, state *ConfigAuthState, opts ...ResourceOption) (*ConfigAuth, error)
    public static ConfigAuth Get(string name, Input<string> id, ConfigAuthState? state, CustomResourceOptions? opts = null)
    public static ConfigAuth get(String name, Output<String> id, ConfigAuthState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:

    Package Details

    Repository
    harbor pulumiverse/pulumi-harbor
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harbor Terraform Provider.
    harbor logo
    Harbor v3.10.8 published on Wednesday, Feb 14, 2024 by Pulumiverse
    pulumiverse/pulumi-harbor