LdapConfig
class flow_api.ldap_config.LdapConfig(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, commit=False, authentication_mechanism=<class 'flow_api.system.NotSet'>, base_dn=<class 'flow_api.system.NotSet'>, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, cacert=<class 'flow_api.system.NotSet'>, client_cert=<class 'flow_api.system.NotSet'>, client_key=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, is_bundle_content=<class 'flow_api.system.NotSet'>, is_enabled=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, location_inheritance=<class 'flow_api.system.NotSet'>, mail_attribute=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, password=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, roles=<class 'flow_api.system.NotSet'>, server_url=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, use_starttls=<class 'flow_api.system.NotSet'>, username=<class 'flow_api.system.NotSet'>, username_attribute=<class 'flow_api.system.NotSet'>, users_filter=<class 'flow_api.system.NotSet'>, verify_tls=<class 'flow_api.system.NotSet'>, debug=False)
Base class: Resource
Configuration of a LDAP server which can be used to log in to Cloudomation Engine.
See the corresponding Resources class at LdapConfig
Parameters
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allow_deleted | bool | ||||||||||||||||
| allow_normal | bool | ||||||||||||||||
| authentication_mechanism | Union | The authentication mechanism to use. Popular choices are "SIMPLE" (=unencrypted plaintext), "DIGEST-MD5", "NTLM", "CRAM-MD5" and others. | |||||||||||||||
| base_dn | Union | The base container for all LDAP queries. | |||||||||||||||
| bundle_id | Union | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, CHAT, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id | |||||||||||||||
| bundle_name | Union | The name of the bundle. Will look up the bundle and set bundle_id. | |||||||||||||||
| by | str | ||||||||||||||||
| cacert | Union | The CA certificate of the server. | |||||||||||||||
| client_cert | Union | The client certificate used by the "EXTERNAL" authentication mechanism. | |||||||||||||||
| client_key | Union | The key of the client certificate used by the "EXTERNAL" authentication mechanism. | |||||||||||||||
| cls | Optional | ||||||||||||||||
| commit | bool | ||||||||||||||||
| commit_message | Union | The commit message for this change. | |||||||||||||||
| debug | bool | if set, the content of the data being written will be logged. | |||||||||||||||
| description | Union | A multiline description of what this record is and does. | |||||||||||||||
| init | Optional | ||||||||||||||||
| is_bundle_content | Union | A flag to control if the resource is considered bundle content. Changes in bundle content mark the bundle as modified. Updating the bundle will modify the bundle content. | |||||||||||||||
| is_enabled | Union | Flag to control if the configuration should be used. | |||||||||||||||
| is_readonly | Union | A 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 CHAT, EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE | |||||||||||||||
| location_inheritance | Union | Controls the project/bundle association of a newly created record when no project_id/project_name/bundle_id/bundle_name is specified in the create request. Depending on the record type different options are available:
| |||||||||||||||
| mail_attribute | Union | The LDAP attribute containing the email address of the user. | |||||||||||||||
| name | Union | The name of this record. Must be unique across a workspace. | |||||||||||||||
| password | Union | The password to authenticate. | |||||||||||||||
| project_id | Union | Reference 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, CHAT, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id. | |||||||||||||||
| project_name | Union | The name of the project. Will look up the project and set project_id. | |||||||||||||||
| roles | Union | The roles this identity has. | |||||||||||||||
| select | Optional | ||||||||||||||||
| server_url | Union | The 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. | |||||||||||||||
| track_in_git | Union | Should new records automatically be tracked in git. | |||||||||||||||
| use_starttls | Union | Flag to control if ldap:// connections should upgrade to TLS using STARTTLS. | |||||||||||||||
| username | Union | The username to authenticate. | |||||||||||||||
| username_attribute | Union | The LDAP attribute which maps to the Cloudomation username. | |||||||||||||||
| users_filter | Union | The filter used to find a user. | |||||||||||||||
| verify_tls | Union | Verify TLS certificate. |