Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added ldap api calls
Table of Contents

Project Aims:

The aim of this project is to provide an more effective mechanism to provision users from LDAP into cloudstack. Currently Cloudstack enables LDAP authentication. In this authentication users must be first setup in Cloudstack. Once the user is setup in Cloudstack they can authenticate using their LDAP username and password. This project will improve Cloudstack LDAP integration by enabling users be setup automatically using their LDAP credentials.

...

Progress on UI features is slow. At the moment I have a list of LDAP users coming up when you click add account. You can pick an user and then fill in the optional information.

API Calls

Java Class

API call

Description

params

LdapUserSearchCmd

searchLdap

Searches LDAP based on the username attribute

  • query - username to search using

LdapListUsersCmd

listLdapUsers

Lists all LDAP Users

  • listType - if "all" returns all users else only non-cloudstack users

LdapAddConfigurationCmd

addLdapConfiguration

Add a new Ldap Configuration

  • hostname - Host name of the ldap server
  • port - port number

LdapDeleteConfigurationCmd

deleteLdapConfiguration

Remove an Ldap Configuration

  • hostname - the hostname of the configuration to delete

LdapListConfigurationCmd

listLdapConfigurations

Lists all LDAP configurations

  • hostname - Host name of the ldap server
  • port - port number

LdapCreateAccountCmd

ldapCreateAccount

Creates an account from an LDAP user

  • accountName - Creates the user under the specified account. If no account is specified, the username will be used as the account name.
  • accountType - Type of the account.  Specify 0 for user, 1 for root admin, and 2 for domain admin
  • domainId - Creates the user under the specified domain.
  • timezone - the timezone of the user
  • username - Unique username.
  • networkDomain - Network domain for the account's networks
  • details - details for account used to store specific parameters
  • accountUUID - Account UUID
  • userUUID - User UUID

LdapImportUsersCmd

importLdapUsers

Import LDAP users to cloudstack

  • timezone - the timezone for the imported users
  • accountType - Type of the account.  Specify 0 for user, 1 for root admin, and 2 for domain admin
  • details - details for account used to store specific parameters
  • groupName - Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.
  • domainName - Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain