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
| Property | Description | Type | Import/Export |
|---|---|---|---|
| authentication_mechanism | The authentication mechanism to use. Popular choices are "SIMPLE" (=unencrypted plaintext), "DIGEST-MD5", "NTLM", "CRAM-MD5" and others. | String(length=128) | both |
| base_dn | The base container for all LDAP queries. | String(length=128) | both |
| bundle_id | Reference 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_id | UUID(as_uuid=False) | both |
| bundle_name | The name of the bundle. Will look up the bundle and set bundle_id. | String(length=128) | neither |
| cacert | The CA certificate of the server. | String(length=40960) | both |
| client_cert | The client certificate used by the "EXTERNAL" authentication mechanism. | String(length=40960) | both |
| client_key | The key of the client certificate used by the "EXTERNAL" authentication mechanism. | String(length=40960) | both |
| commit_message | The commit message for this change. | Text() | import only |
| created_at | DateTime(timezone=True) | export only | |
| created_by | UUID(as_uuid=False) | export only | |
| deleted_at | DateTime(timezone=True) | export only | |
| deleted_by | UUID(as_uuid=False) | export only | |
| description | A multiline description of what this record is and does. | Text() | both |
| has_password | Boolean() | neither | |
| id | UUID(as_uuid=False) | neither | |
| identity_type | Enum('EXECUTION', 'LDAP_CONFIG', 'SCHEDULE', 'SYNC_CONFIG', 'USER', 'WEBHOOK', 'WORKSPACE', name='identitytype') | neither | |
| is_bundle_readonly | Boolean() | neither | |
| is_deleted | Boolean() | export only | |
| is_enabled | Flag to control if the configuration should be used. | Boolean() | both |
| is_project_readonly | Boolean() | neither | |
| is_readonly | 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 EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE | Boolean() | both |
| last_activity | The last time the identity was active in Cloudomation. Output only. | DateTime(timezone=True) | export only |
| mail_attribute | The LDAP attribute containing the email address of the user. | String(length=128) | both |
| modified_at | DateTime(timezone=True) | export only | |
| modified_by | UUID(as_uuid=False) | export only | |
| name | The name of this record. Must be unique across a workspace. | String(length=128) | both |
| organization_id | UUID(as_uuid=False) | export only | |
| password | The password to authenticate. | String(length=128) | import only |
| project_id | 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, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id. | UUID(as_uuid=False) | both |
| project_name | The name of the project. Will look up the project and set project_id. | String(length=128) | neither |
| record_type | Enum('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_path | The path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATH | String(length=256) | neither |
| resource_type | Enum('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 | |
| roles | The roles this identity has. | JSONB(astext_type=Text()) | import only |
| schema_version | String(length=128) | both | |
| server_url | 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. | String(length=1024) | both |
| use_starttls | Flag to control if ldap:// connections should upgrade to TLS using STARTTLS. | Boolean() | both |
| username | The username to authenticate. | String(length=128) | both |
| username_attribute | The LDAP attribute which maps to the Cloudomation username. | String(length=128) | both |
| users_filter | The filter used to find a user. | String(length=128) | both |
| verify_tls | Verify TLS certificate. | Boolean() | both |
| workspace_id | UUID(as_uuid=False) | export only |