Register New User

API Type

REST

HTTP Method

POST

Description

Registers a new user in the AgilePoint system.

URL Format (OnPremises, PrivateCloud)

https://[domain]:[port]/AgilePointServer/Admin/RegisterUser

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Admin/RegisterUser

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
Department	Function: Gets and sets department of the user. Type string Accepted Values: A valid department name.
EMailAddress	Function: Gets and sets the user's e-mail address. Type string Accepted Values: A valid e-mail address.
FullName	Function: Specifies the full name of the user. Type string Accepted Values: One line of text that can have spaces.
Locale	Function: Specifies the client locale. Type string Accepted Values: A valid locale in standardized format. Example: en-US
Manager	Function: Specifies the manager of the user. Type string Accepted Values: A valid user name.
OnlineContact	Function: Gets and sets online contact of the user. Type string Accepted Values: A valid contact.
RefID	Function: Specifies the reference ID for the user. Type string Accepted Values: A valid reference ID.
RegisteredDate	Function: Gets and sets date registered. Type DateTime Accepted Values: A valid DateTime value.
TimeZone	Function: Specifies the user's time zone. Type string Accepted Values: A valid time zone.
Title	Function: Specifies the job title of the user. Type string Accepted Values: One line of text that can have spaces.
UALExpirationDate	Function: Specifies the user's UAL expiration. Type DateTime Accepted Values: A valid DateTime value.
UALNeverExpires	Function: Specifies whether UAL for the user expires. Type bool Accepted Values: True - The UAL for the user expires. False - The UAL for the user does not expire.
UserName	Function: The user name for the user. Type string Accepted Values: A valid user name for a registered AgilePoint user.

JavaScript Code Example

$("#btnRegisterUser").click(function () {
  var JSONObject = {
    Department: "HR",
    EMailAddress: "Bob@tusca.com",
    FullName: "Bob",
    Locale: "en-US",
    Manager: "mydomain\\Bill",
    OnlineContact: "",
    RefID: "",
    RegisteredDate: "\/Date(928149600000+0000)\/",
    TimeZone: "",
    Title: "",
    UALExpirationDate: "\/Date(928149600000+0000)\/",
    UALNeverExpires: true,
    UserName: "mydomain\\Bob"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/RegisterUser",
    dataType: "text",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String RegisterUser() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/RegisterUser";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  
    JSONObject postData = new JSONObject();
    postData.put("Department", "HR");
    postData.put("EMailAddress", "Bob@tusca.com");
    postData.put("FullName", "Bob");
    postData.put("Locale", "en-US");
    postData.put("Manager", "mydomain\\Bill");
    postData.put("OnlineContact", "");
    postData.put("RefID", "");
    postData.put("TimeZone", "");
    postData.put("Title", "");
    postData.put("UserName", "mydomain\\Bob");
    postData.put("RegisteredDate", "/Date("
      + Calendar.getInstance().getTimeInMillis() + ")/");
    postData.put("UALExpirationDate", "/Date("
      + Calendar.getInstance().getTimeInMillis() + ")/");
    postData.put("UALNeverExpires", "true");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string RegisterUser()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Admin/RegisterUser";

    string jsonRequestData = "{
      \"Department\":\"\",
      \"EMailAddress\":\"abc@mydomain.com\",
      \"FullName\":\"AmericaBritainCalifornia\",
      \"Locale\":\"\",
      \"Manager\":\"\",
      \"OnlineContact\":\"\",
      \"RefID\":\"\",
      \"RegisteredDate\":\"\\/Date(1357803786593+0530)\\/\",
      \"TimeZone\":\"\",
      \"Title\":\"\",
      \"UALExpirationDate\":\"\\/Date(-62135596800000)\\/\",
      \"UALNeverExpires\":false,
      \"UserName\":\"AP2\\\\abc\"}";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.POSTMethod(URI, jsonREquestData);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password.

curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"Department\":\"HR\",
                         \"EMailAddress\":\"Bob@tusca.com\",
                         \"FullName\":\"Bob\",
                         \"Locale\":\"en-US\",
                         \"Manager\":\"mydomain\\Bill\",
                         \"RegisteredDate\":\"/Date(1499797800000+0000)/\",
                         \"UserName\":\"mydomain\\Bob\"} 
                         https://mydomain:9011/AgilePointServer/Admin/RegisterUser

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.