Active Directory Query v2

The Active Directory Query integration enables you to access and manage Active Directory objects (users, contacts, and computers).

Authentication & Identity Management · Active Directory Query

Configuration parameters

  • server_ip — Server IP address (for example, 192.168.0.1) (required)
  • port — Server port. If not specified, the default port is 389 for LDAP, 636 for LDAPS, or 3268 for global catalog servers.
  • credentials — Username (required)
  • ntlm — NTLM authentication
  • base_dn — Base DN (for example "dc=company,dc=com") (required)
  • page_size — Page size
  • secure_connection — Secure Connection (required)
  • ssl_version — SSL Version
  • unsecure — Trust any certificate (not secure)
  • verify_base_dn — Verify base DN on every command
  • mapper-in — Incoming Mapper (required)
  • mapper-out — Outgoing Mapper (required)
  • group-cn — Group CN for terminated employees
  • create-if-not-exists — Create user if does not exist
  • default_base_query — Default base query to use in the ad-get-user command

Commands (28)

  • ad-add-to-group

    Adds an Active Directory user or computer to a group.

  • ad-create-contact

    Creates an Active Directory contact.

  • ad-create-group

    Creates a new security or distribution Active Directory group.

  • ad-create-user

    Creates an Active Directory user. This command requires a secure connection (SSL,TLS).

  • ad-delete-group

    Deletes an existing Active Directory security or distribution group.

  • ad-delete-user

    Deletes an Active Directory user.

  • ad-disable-account

    Disables an Active Directory user account.

  • ad-enable-account

    Enables a previously disabled Active Directory account.

  • ad-expire-password

    Expires the password of an Active Directory user.

  • ad-get-computer

    Retrieves detailed information about a computer account. The computer can be specified by name, email address, or as an Active Directory Distinguished Name (DN). If no filters are provided, all computers are returned.

  • ad-get-group-members

    Retrieves the list of users or computers that are members of the specified group.

  • ad-get-user

    Retrieves detailed information about a user account. The user can be specified by name, email address, or as an Active Directory Distinguished Name (DN). If no filter is specified, all users are returned.

  • ad-modify-computer-ou

    Modifies the computer organizational unit within a domain.

  • ad-modify-password-never-expire

    Modifies the AD account attribute "Password Never Expire".

  • ad-modify-user-ou

    Modifies the user organizational unit within a domain.

  • ad-remove-from-group

    Removes an Active Directory user or computer from a group.

  • ad-search

    Runs Active Directory queries.

  • ad-set-new-password

    Sets a new password for an Active Directory user. This command requires a secure connection (SSL,TLS).

  • ad-test-credentials

    Test given credentials.

  • ad-unlock-account

    Unlocks a previously locked Active Directory user account.

  • ad-update-contact

    Updates attributes of an existing Active Directory contact.

  • ad-update-group

    Updates attributes of an existing Active Directory group.

  • ad-update-user

    Updates attributes of an existing Active Directory user.

  • get-mapping-fields

    Retrieves a User Profile schema which holds all of the user fields in the application. Used for outgoing mapping through the Get Schema option.

  • iam-create-user

    Creates an Active Directory user. This command requires a secure connection (SSL,TLS).

  • iam-disable-user

    Disables a user.

  • iam-get-user

    Retrieves a single user resource.

  • iam-update-user

    Updates an existing user with the data in the User Profile indicator that is passed in the user-profile argument.