Home
Extending product function
Learn how to extend the function of HCL Launch.
REST API reference
You can use these REST interfaces to automate tasks.
REST commands for the HCL Launch server
The following list shows the commands that are available for the HCL Launch server.
user resource
Get the user or users with a given e-mail address

Extending product function
Learn how to extend the function of HCL Launch.
- Plug-ins
  The HCL plug-ins provide tools for creating component processes and integrations. HCL plug-ins provides plug-ins for several common deployment processes, and others are available to integrate with a wide variety of tools, such as middleware tools, databases, and servers.
- Creating notification templates
  Notification templates are the basis for emails that the server sends to users after an event occurs on the server. You can create customized notification templates by modifying the default templates provided, or by creating new templates of your own.
- REST API reference
  You can use these REST interfaces to automate tasks.
  - Running REST commands
    Many different programs can run REST commands. To run the command, you call a method on a REST resource and pass parameters or a request in JSON format.
  - Examples of REST API commands
    Many REST and command-line client commands have examples in their help topics. A few more examples using various programming languages and scenarios are provided here. The commands are similar for the server.
  - Authenticating for REST commands
    The way that you authenticate to run REST commands depends on how the server is set up and the tool that you are using to run the commands.
  - Deploying applications by using REST commands: An example
    The following example describes how to use the REST commands to deploy an application.
  - REST commands for the HCL Launch server
    The following list shows the commands that are available for the HCL Launch server.
    - agentCLI resource
    - agentPool resource
    - application resource
    - applicationProcess resource
    - applicationProcessRequest resource
      Resources for requesting application processes.
    - applicationTemplate resource
    - approval/task resource
    - authenticationRealm resource
    - component resource
    - componentProcess resource
    - componentProcessRequest resource
    - componentTemplate resource
    - deploymentTrigger resource
    - environment resource
    - environmentTemplate resource
    - frontendServer resource
    - group resource
    - inventory resource
    - javaPackage resource
    - login resource
    - process resource
    - processRequest resource
    - relay resource
    - resource resource
    - resourceTemplate resource
    - snapshot resource
    - sshInstallAgent resource
    - status resource
    - systemConfiguration resource
    - tags resource
    - team resource
    - teamsecurity resource
    - user resource
      - Create a user
      - Delete a user
      - Get all users with a given e-mail address
      - Get the first user with a given e-mail address
      - Get the user or users with a given e-mail address
      - Import a user from LDAP
        This command adds one or more users from an LDAP realm to the server.
      - List all users with a given role on a team
        This command returns all users in a role for a given team, including users that are associated via a group membership
      - List information about a user
      - Update a user
        Specify the user name in the 'user' parameter and use the JSON string to specify new information about the user. This command can update the name and email address of the user, but not the password.
    - version resource
    - webhookTemplate resource
    - workflowTrace resource
- Command-line client (CLI) reference
  CLI is a command-line interface that provides access to the HCL Launch server. It can be used to find or set properties and to run numerous functions.
- Process-as-code feature
  Programmatically manage processes with PAC language.

Get the user or users with a given e-mail address

Request

GET https://{hostname}:{port}
    /cli/user/byEmail?{parameters}
Accept: application/json

Table 1. Request parameters
Parameter	Type	Required	Description
email	string	true	E-mail address of the user
allUsers	boolean	false	Specify true to retrieve all users with the e-mail address or false to return only the first user that matches the address

Table 2. Header parameters
Parameter	Type	Required	Description
Accept	`application/json`	true

Example

curl -k -u jsmith:passwd 
   
  "https://myserver.example.com:8443/cli/user/byEmail
  ?email=jsmith@us.ibm.com&allUsers=true" 
  -H "Accept: application/json"

Example response

[{"id":"bade154b-c8c9-4aa6-a875-4b56d7132be5","name":"jsmith"},
{"id":"2c1c9012-2111-4d6a-b5f0-b6cabff94713","name":"janesmith"}]

Related CLI command: getUserByEmail.