Get Access Rights

API Type

REST

HTTP Method

POST

Description

Retrieves the access rights for a specified user.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
userName	Definition: The user name for the user. Type string Allowed Values: A valid user name for a registered AgilePoint user.

JavaScript Code Example

$("#btnGetAccessRights").click(function () {
  var JSONObject = {
    userName: "demo3\\administrator"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetAccessRights",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String GetAccessRights(String userName) {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetAccessRights";

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

  try {
    JSONObject postData = new JSONObject();
    postData.put("userName", userName);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

public string GetAccessRights(string username)
  {
    string URL = "http://mydomain:9011/AgilePointServer/Admin/GetAccessRights";

    string jsonRequestData = "{\"userName\":\"" + username + "\"}";

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

Output

An array of integers that represent the access rights of the user.

JSON Response Body Example

[
  0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23
]

Supported Versions

AgilePoint BPMS v5.0 R2 and higher