Harbor v3.10.19, Feb 10 25

Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse

harbor.ConfigAuth

Explore with Pulumi AI

Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse

pulumiverse/pulumi-harbor

Example Usage

OIDC

resource "harbor_config_auth" "oidc" {
  auth_mode          = "oidc_auth"
  primary_auth_mode  = true
  oidc_name          = "azure"
  oidc_endpoint      = "https://login.microsoftonline.com/{GUID goes here}/v2.0"
  oidc_client_id     = "OIDC Client ID goes here"
  oidc_client_secret = "ODDC Client Secret goes here"
  oidc_scope         = "openid,email"
  oidc_verify_cert   = true
  oidc_auto_onboard  = true
  oidc_user_claim    = "name"
  oidc_admin_group   = "administrators"
}

LDAP

resource "harbor_config_auth" "ldap" {
  auth_mode            = "ldap_auth"
  primary_auth_mode    = true
  ldap_url             = "openldap.default.svc.cluster.local:389"
  ldap_search_dn       = "cn=admin,dc=example,dc=org"
  ldap_search_password = "Not@SecurePassw0rd"
  ldap_base_dn         = "dc=example,dc=org"
  ldap_uid             = "email"
  ldap_verify_cert     = false
}

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.

Constructor 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ConfigAuth resource accepts the following input properties:

AuthMode string: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 bool
OidcAdminGroup string
OidcAutoOnboard bool
OidcClientId string
OidcClientSecret string
OidcEndpoint string
OidcGroupFilter string
OidcGroupsClaim string
OidcName string
OidcScope string
OidcUserClaim string
OidcVerifyCert bool
PrimaryAuthMode bool

AuthMode string: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 bool
OidcAdminGroup string
OidcAutoOnboard bool
OidcClientId string
OidcClientSecret string
OidcEndpoint string
OidcGroupFilter string
OidcGroupsClaim string
OidcName string
OidcScope string
OidcUserClaim string
OidcVerifyCert bool
PrimaryAuthMode bool

authMode String: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 Boolean
oidcAdminGroup String
oidcAutoOnboard Boolean
oidcClientId String
oidcClientSecret String
oidcEndpoint String
oidcGroupFilter String
oidcGroupsClaim String
oidcName String
oidcScope String
oidcUserClaim String
oidcVerifyCert Boolean
primaryAuthMode Boolean

authMode string: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 boolean
oidcAdminGroup string
oidcAutoOnboard boolean
oidcClientId string
oidcClientSecret string
oidcEndpoint string
oidcGroupFilter string
oidcGroupsClaim string
oidcName string
oidcScope string
oidcUserClaim string
oidcVerifyCert boolean
primaryAuthMode boolean

auth_mode str: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
ldap_base_dn str
ldap_filter str
ldap_group_admin_dn str
ldap_group_base_dn str
ldap_group_filter str
ldap_group_gid str
ldap_group_membership str
ldap_group_scope str
ldap_group_uid str
ldap_scope str
ldap_search_dn str
ldap_search_password str
ldap_uid str
ldap_url str
ldap_verify_cert bool
oidc_admin_group str
oidc_auto_onboard bool
oidc_client_id str
oidc_client_secret str
oidc_endpoint str
oidc_group_filter str
oidc_groups_claim str
oidc_name str
oidc_scope str
oidc_user_claim str
oidc_verify_cert bool
primary_auth_mode bool

authMode String: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 Boolean
oidcAdminGroup String
oidcAutoOnboard Boolean
oidcClientId String
oidcClientSecret String
oidcEndpoint String
oidcGroupFilter String
oidcGroupsClaim String
oidcName String
oidcScope String
oidcUserClaim String
oidcVerifyCert Boolean
primaryAuthMode Boolean

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)

resources:  _:    type: harbor:ConfigAuth    get:      id: ${id}

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:

AuthMode string: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 bool
OidcAdminGroup string
OidcAutoOnboard bool
OidcClientId string
OidcClientSecret string
OidcEndpoint string
OidcGroupFilter string
OidcGroupsClaim string
OidcName string
OidcScope string
OidcUserClaim string
OidcVerifyCert bool
PrimaryAuthMode bool

AuthMode string: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 bool
OidcAdminGroup string
OidcAutoOnboard bool
OidcClientId string
OidcClientSecret string
OidcEndpoint string
OidcGroupFilter string
OidcGroupsClaim string
OidcName string
OidcScope string
OidcUserClaim string
OidcVerifyCert bool
PrimaryAuthMode bool

authMode String: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 Boolean
oidcAdminGroup String
oidcAutoOnboard Boolean
oidcClientId String
oidcClientSecret String
oidcEndpoint String
oidcGroupFilter String
oidcGroupsClaim String
oidcName String
oidcScope String
oidcUserClaim String
oidcVerifyCert Boolean
primaryAuthMode Boolean

authMode string: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 boolean
oidcAdminGroup string
oidcAutoOnboard boolean
oidcClientId string
oidcClientSecret string
oidcEndpoint string
oidcGroupFilter string
oidcGroupsClaim string
oidcName string
oidcScope string
oidcUserClaim string
oidcVerifyCert boolean
primaryAuthMode boolean

auth_mode str: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
ldap_base_dn str
ldap_filter str
ldap_group_admin_dn str
ldap_group_base_dn str
ldap_group_filter str
ldap_group_gid str
ldap_group_membership str
ldap_group_scope str
ldap_group_uid str
ldap_scope str
ldap_search_dn str
ldap_search_password str
ldap_uid str
ldap_url str
ldap_verify_cert bool
oidc_admin_group str
oidc_auto_onboard bool
oidc_client_id str
oidc_client_secret str
oidc_endpoint str
oidc_group_filter str
oidc_groups_claim str
oidc_name str
oidc_scope str
oidc_user_claim str
oidc_verify_cert bool
primary_auth_mode bool

authMode String: Harbor authentication mode. Can be "oidc_auth", "db_auth" or "ldap_auth". (Default: "db_auth")
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 Boolean
oidcAdminGroup String
oidcAutoOnboard Boolean
oidcClientId String
oidcClientSecret String
oidcEndpoint String
oidcGroupFilter String
oidcGroupsClaim String
oidcName String
oidcScope String
oidcUserClaim String
oidcVerifyCert Boolean
primaryAuthMode Boolean

Package Details

Repository: harbor pulumiverse/pulumi-harbor
License: Apache-2.0
Notes: This Pulumi package is based on the harbor Terraform Provider.

Harbor v3.10.19 published on Monday, Feb 10, 2025 by Pulumiverse

pulumiverse/pulumi-harbor

harbor.ConfigAuth

On this page

On this page

Example Usage

OIDC

LDAP

Create ConfigAuth Resource

Constructor syntax

Parameters

Constructor example

ConfigAuth Resource Properties

Inputs

Outputs

Look up Existing ConfigAuth Resource

Package Details

On this page

On this page