Skip to main content
Version: 9 - Germknödel

LdapConfig

class resources.ldap_config.LdapConfig

Base class: Resource

Configuration of a LDAP server which can be used to log in to Cloudomation Engine.

See the corresponding Flow Api class at LdapConfig

PropertyDescriptionTypeImport/Export
authentication_mechanismThe authentication mechanism to use. Popular choices are "SIMPLE" (=unencrypted plaintext), "DIGEST-MD5", "NTLM", "CRAM-MD5" and others.String(length=128)both
base_dnThe base container for all LDAP queries.String(length=128)both
bundle_idReference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, LDAP_CONFIG, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, EXECUTION, MESSAGE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_idUUID(as_uuid=False)both
bundle_nameThe name of the bundle. Will look up the bundle and set bundle_id.String(length=128)neither
cacertThe CA certificate of the server.String(length=40960)both
client_certThe client certificate used by the "EXTERNAL" authentication mechanism.String(length=40960)both
client_keyThe key of the client certificate used by the "EXTERNAL" authentication mechanism.String(length=40960)both
commit_messageThe commit message for this change.Text()import only
created_atDateTime(timezone=True)export only
created_byUUID(as_uuid=False)export only
deleted_atDateTime(timezone=True)export only
deleted_byUUID(as_uuid=False)export only
descriptionA multiline description of what this record is and does.Text()both
has_passwordBoolean()neither
idUUID(as_uuid=False)neither
identity_typeEnum('EXECUTION', 'LDAP_CONFIG', 'SCHEDULE', 'SYNC_CONFIG', 'USER', 'WEBHOOK', 'WORKSPACE', name='identitytype')neither
is_bundle_readonlyBoolean()neither
is_deletedBoolean()export only
is_enabledFlag to control if the configuration should be used.Boolean()both
is_project_readonlyBoolean()neither
is_readonlyA flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACEBoolean()both
last_activityThe last time the identity was active in Cloudomation. Output only.DateTime(timezone=True)export only
mail_attributeThe LDAP attribute containing the email address of the user.String(length=128)both
modified_atDateTime(timezone=True)export only
modified_byUUID(as_uuid=False)export only
nameThe name of this record. Must be unique across a workspace.String(length=128)both
organization_idUUID(as_uuid=False)export only
passwordThe password to authenticate.String(length=128)import only
project_idReference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.UUID(as_uuid=False)both
project_nameThe name of the project. Will look up the project and set project_id.String(length=128)neither
record_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', 'EXECUTION', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')neither
repository_pathThe path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATHString(length=256)neither
resource_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', 'FILE', 'FLOW', 'LDAP_CONFIG', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype')neither
rolesThe roles this identity has.JSONB(astext_type=Text())import only
schema_versionString(length=128)both
server_urlThe LDAP URL which consists of a scheme, address, and port. Format is <scheme>://<address>:<port> or <scheme>://<address> where scheme is either ldap or ldaps.String(length=1024)both
use_starttlsFlag to control if ldap:// connections should upgrade to TLS using STARTTLS.Boolean()both
usernameThe username to authenticate.String(length=128)both
username_attributeThe LDAP attribute which maps to the Cloudomation username.String(length=128)both
users_filterThe filter used to find a user.String(length=128)both
verify_tlsVerify TLS certificate.Boolean()both
workspace_idUUID(as_uuid=False)export only