Close
    logoCloudomation Docs

    TaskLDAP

    class tasks.task_ldap.TaskLDAP

    Call a LDAP service.

    Inputs

    NameTypeDefaultDescription
    encodingstrutf-8The encoding of the return values of the LDAP server
    hoststrThe LDAP server to connect to
    paged_searchboolFalsePerform a paged search until the enpoint is exhausted
    passwordstrThe password used to bind to the LDAP server
    portintNoneThe port number to use. If unset port 389 for ldap:// and port 636 for ldaps:// will be used
    searchdictPerform a LDAP search. Pass a dictionary containing the parameters of the search. e.g. {'search_base': 'o=test', 'search_filter': '(objectclass=)', 'attributes': ''}
    use_sslboolTrueWill use ldap:// if set to False, ldaps:// otherwise
    userstrThe username used to bind to the LDAP server

    Outputs

    NameTypeDefaultDescription
    resultobject
    execution_idintThe ID of the task execution
    messagestrThe ended message for the task. If the task ended with an error, the message will contain information about what went wrong
    statusstrThe ended status for the task. Either "success" or "error".

    Constants

    input_list = ['encoding', 'host', 'paged_search', 'password', 'port', 'search', 'use_ssl', 'user']output_list = ['result']version = 1

    Methods

    log (message)
    run ()

    Example

    import flow_api
    def handler(system: flow_api.System, this: flow_api.Execution):
    this.task(
    'LDAP',
    host='my-ldap-server',
    user='cn=user,dc=example,dc=com',
    password='my-secret-password',
    search={
    'search_base': 'dc=example,dc=com',
    'search_filter': '(objectclass=*)',
    'attributes': '*',
    },
    )
    return this.success('all done')
    Previous
    TaskK8S
    Next
    TaskPS