LdapConfig
class flow_api.ldap_config.LdapConfig(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=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_enabled=[class 'flow_api.system.NotSet'], is_readonly=[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'], 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 | typing.Union[ flow_api.system.NotSet, str ] | The authentication mechanism to use. Popular choices are "SIMPLE" (=unencrypted plaintext), "DIGEST-MD5", "NTLM", "CRAM-MD5" and others. |
| base_dn | typing.Union[ flow_api.system.NotSet, str ] | The base container for all LDAP queries. |
| bundle_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, 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_id |
| bundle_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the bundle. Will look up the bundle and set bundle_id. |
| by | str | |
| cacert | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The CA certificate of the server. |
| client_cert | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The client certificate used by the "EXTERNAL" authentication mechanism. |
| client_key | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The key of the client certificate used by the "EXTERNAL" authentication mechanism. |
| cls | typing.Union[ type, NoneType ] | |
| commit_message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The commit message for this change. |
| debug | bool | if set, the content of the data being written will be logged. |
| description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | A multiline description of what this record is and does. |
| init | typing.Union[ dict, NoneType ] | |
| is_enabled | typing.Union[ flow_api.system.NotSet, bool ] | Flag to control if the configuration should be used. |
| is_readonly | typing.Union[ flow_api.system.NotSet, bool ] | A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, 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, WORKSPACE |
| mail_attribute | typing.Union[ flow_api.system.NotSet, str ] | The LDAP attribute containing the email address of the user. |
| name | typing.Union[ flow_api.system.NotSet, str ] | The name of this record. Must be unique across a workspace. |
| password | typing.Union[ flow_api.system.NotSet, str ] | The password to authenticate. |
| project_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, 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. |
| project_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the project. Will look up the project and set project_id. |
| roles | typing.Union[ flow_api.system.NotSet, dict, NoneType ] | The roles this identity has. |
| select | typing.Union[ str, NoneType ] | |
| server_url | typing.Union[ flow_api.system.NotSet, str ] | 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. |
| use_starttls | typing.Union[ flow_api.system.NotSet, bool ] | Flag to control if ldap:// connections should upgrade to TLS using STARTTLS. |
| username | typing.Union[ flow_api.system.NotSet, str ] | The username to authenticate. |
| username_attribute | typing.Union[ flow_api.system.NotSet, str ] | The LDAP attribute which maps to the Cloudomation username. |
| users_filter | typing.Union[ flow_api.system.NotSet, str ] | The filter used to find a user. |
| verify_tls | typing.Union[ flow_api.system.NotSet, bool ] | Verify TLS certificate. |