Admin Settings API

This Admin Settings API provides endpoints to programmatically manage environment variables and organizational attributes such as titles, departments, offices, and companies. These values are commonly referenced in templates, provisioning rules, and attribute mappings, and can be modified without accessing the ADManager Plus UI.

Download Admin Settings API OpenAPI Document

End Points

GET

/admin_settings/environment_variables

POST

/admin_settings/environment_variables

PATCH

/admin_settings/environment_variables/{variable_id}

GET

/admin_settings/organization_attributes/titles

POST

/admin_settings/organization_attributes/titles

DELETE

/admin_settings/organization_attributes/titles

GET

/admin_settings/organization_attributes/departments

POST

/admin_settings/organization_attributes/departments

DELETE

/admin_settings/organization_attributes/departments

GET

/admin_settings/organization_attributes/offices

POST

/admin_settings/organization_attributes/offices

DELETE

/admin_settings/organization_attributes/offices

GET

/admin_settings/organization_attributes/companies

POST

/admin_settings/organization_attributes/companies

DELETE

/admin_settings/organization_attributes/companies

List environment variables

This endpoint retrieves environment variables configured in ADManager Plus. Results can be refined using filters, sorting, and pagination.

Scope : Read environment variables action, All admin settings actions
Delegated role : Server Settings > Environment Variable

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

fields

string

The attributes to be returned in the response.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/environment_variables"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/environment_variables")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/environment_variables', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v2/admin_settings/environment_variables", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/environment_variables",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://admanagerplus:8080/api/v2/admin_settings/environment_variables \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": [
        {
            "VAR_NAME": "test",
            "VAR_VALUE": "**********",
            "UNIQUE_ID": 1
        },
        {
            "VAR_NAME": "test2",
            "VAR_VALUE": "TesterValue",
            "UNIQUE_ID": 2
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 10,
        "total_no_of_objects": 2
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Add environment variable

This endpoint adds a new environment variable to ADManager Plus. Environment variables store reusable values that can be referenced in multiple configurations and workflows.

Scope : Add environment variables action, All admin settings actions
Delegated role : Server Settings > Environment Variable

Arguments

data

object

Details of the environment variable to update.

Show Sub-Attributes

variable_name

string

The name of the environment variable.

variable_value

string

The value of the environment variable.

is_secure

boolean

Indicates if the environment variable should be secured.

description

string

Description of the environment variable

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/environment_variables"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/environment_variables")
  .post(body)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/environment_variables', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v2/admin_settings/environment_variables", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "POST",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/environment_variables",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url http://admanagerplus:8080/api/v2/admin_settings/environment_variables \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "data": {
        "variable_name": "TEST_VAR",
        "variable_value": "TesterValue",
        "is_secure": true,
        "description": "Tester"
    }
}

{
    "data": {
        "environment_variable": {
            "variable_name": "TEST_VAR",
            "variable_value": "TesterValue",
            "is_secure": true,
            "description": "Tester"
        },
        "status": {
            "status_code": 1,
            "status_message": "Environment Variable added successfully!"
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Update environment variable

This endpoint updates the value, security status, or description of an environment variable.

Scope : Update environment variables action, All admin settings actions
Delegated role : Server Settings > Environment Variable

Arguments

data

object

Details of the environment variable to update.

Show Sub-Attributes

variable_value

string

The new value of the environment variable.

is_secure

boolean

Indicates if the environment variable should be secured.

description

string

Description of the environment variable to be updated.

Path Parameters

variable_id

integer

(Required)

The unique identifier of the environment variable to be updated.

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

parameters_data='{"data":{"variable_value":"TesterValue","is_secure":true,"description":"Tester"}}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/environment_variables/1"
type: PATCH
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"variable_value\":\"TesterValue\",\"is_secure\":true,\"description\":\"Tester\"}}");
Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/environment_variables/1")
  .patch(body)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE',
    'content-type': 'application/json'
  },
  body: '{"data":{"variable_value":"TesterValue","is_secure":true,"description":"Tester"}}'
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/environment_variables/1', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

payload = "{\"data\":{\"variable_value\":\"TesterValue\",\"is_secure\":true,\"description\":\"Tester\"}}"

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE",
    'content-type': "application/json"
    }

conn.request("PATCH", "/api/v2/admin_settings/environment_variables/1", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "PATCH",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/environment_variables/1",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({data: {variable_value: 'TesterValue', is_secure: true, description: 'Tester'}}));
req.end();

curl --request PATCH \
  --url http://admanagerplus:8080/api/v2/admin_settings/environment_variables/1 \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API' \
  --header 'content-type: application/json' \
  --data '{"data":{"variable_value":"TesterValue","is_secure":true,"description":"Tester"}}'

{
    "data": {
        "variable_value": "TesterValue",
        "is_secure": true,
        "description": "Tester"
    }
}

{
    "data": {
        "environment_variable": {
            "variable_value": "TesterValue",
            "is_secure": "true,",
            "description": "Tester"
        },
        "status": {
            "status_code": 1,
            "status_message": "Environment Variable updated successfully!"
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

List organization titles

This endpoint retrieves organization titles available in ADManager Plus.

Scope : Read organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Titles

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

fields

string

The attributes to be returned in the response.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v2/admin_settings/organization_attributes/titles", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/titles",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": [
        {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "Manager"
        },
        {
            "ORG_ATTRIB_ID": 2,
            "ORG_ATTRIB_NAME": "Help Desk Technician"
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 10,
        "total_no_of_objects": 2
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Add organization title

This endpoint adds one or more new organization titles. Titles help classify and standardize roles across the organization.

Scope : Add organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Titles

Arguments

data

object

Details of the organization title(s) to add.

Show Sub-Attributes

attribute_values

string

Semicolon-separated names of the organization attribute values to be added.

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles")
  .post(body)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v2/admin_settings/organization_attributes/titles", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "POST",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/titles",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "data": {
        "attribute_values": "Manager;Help Desk Technician"
    }
}

Response Example

{
    "data": {
        "titles": {
            "attribute_values": "Manager;Help Desk Technician"
        },
        "status": {
            "status_code": 1,
            "status_message": "All the specified Titles have been successfully added."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Delete organization title

This endpoint deletes an organization title from ADManager Plus.

Scope : Delete organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Titles

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles")
  .delete(null)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("DELETE", "/api/v2/admin_settings/organization_attributes/titles", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "DELETE",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/titles",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/titles \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": {
        "object": {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "Org Attribute 1"
        },
        "status": {
            "status_code": 1,
            "status_message": "Successfully removed the entries."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

List organization departments

This endpoint retrieves organization departments available in ADManager Plus.

Scope : Read organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Departments

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

fields

string

The attributes to be returned in the response.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v2/admin_settings/organization_attributes/departments", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/departments",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": [
        {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "Sales"
        },
        {
            "ORG_ATTRIB_ID": 2,
            "ORG_ATTRIB_NAME": "Support"
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 10,
        "total_no_of_objects": 2
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Add organization departments

This endpoint adds one or more new organization departments.

Scope : Add organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Departments

Arguments

data

object

Details of the organization department(s) to add.

Show Sub-Attributes

attribute_values

string

Semicolon-separated names of the organization attribute values to be added.

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments")
  .post(body)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v2/admin_settings/organization_attributes/departments", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "POST",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/departments",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "data": {
        "attribute_values": "Sales;Support"
    }
}

Response Example

{
    "data": {
        "departments": {
            "attribute_values": "Sales;Support"
        },
        "status": {
            "status_code": 1,
            "status_message": "All the specified Departments have been successfully added."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Delete organization department

This endpoint deletes an organization department from ADManager Plus.

Scope : Delete organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Departments

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments")
  .delete(null)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("DELETE", "/api/v2/admin_settings/organization_attributes/departments", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "DELETE",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/departments",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/departments \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": {
        "object": {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "Org Attribute 1"
        },
        "status": {
            "status_code": 1,
            "status_message": "Successfully removed the entries."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

List organization offices

This endpoint retrieves organization offices available in ADManager Plus.

Scope : Read organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Offices

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

fields

string

The attributes to be returned in the response.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v2/admin_settings/organization_attributes/offices", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/offices",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": [
        {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "New York"
        },
        {
            "ORG_ATTRIB_ID": 2,
            "ORG_ATTRIB_NAME": "San Francisco"
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 10,
        "total_no_of_objects": 2
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Add organization office

This endpoint adds one or more new organization offices.

Scope : Add organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Offices

Arguments

data

object

Details of the organization office(s) to add.

Show Sub-Attributes

attribute_values

string

Semicolon-separated names of the organization attribute values to be added.

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices")
  .post(body)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v2/admin_settings/organization_attributes/offices", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "POST",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/offices",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "data": {
        "attribute_values": "New York;San Francisco"
    }
}

Response Example

{
    "data": {
        "offices": {
            "attribute_values": "New York;San Francisco"
        },
        "status": {
            "status_code": 1,
            "status_message": "All the specified Offices have been successfully added."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Delete organization offices

This endpoint deletes an organization office from ADManager Plus.

Scope : Delete organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Offices

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices")
  .delete(null)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("DELETE", "/api/v2/admin_settings/organization_attributes/offices", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "DELETE",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/offices",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/offices \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": {
        "object": {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "Org Attribute 1"
        },
        "status": {
            "status_code": 1,
            "status_message": "Successfully removed the entries."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

List organization companies

This endpoint retrieves organization companies available in ADManager Plus.

Scope : Read organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Companies

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

fields

string

The attributes to be returned in the response.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies")
  .get()
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("GET", "/api/v2/admin_settings/organization_attributes/companies", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "GET",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/companies",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": [
        {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "TechCorp"
        },
        {
            "ORG_ATTRIB_ID": 2,
            "ORG_ATTRIB_NAME": "Innovate Inc."
        }
    ],
    "meta": {
        "start_index": 1,
        "limit": 10,
        "total_no_of_objects": 2
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Add organization companies

This endpoint adds one or more new organization companies.

Scope : Add organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Companies

Arguments

data

object

Details of the organization company(ies) to add.

Show Sub-Attributes

attribute_values

string

Semicolon-separated names of the organization attribute values to be added.

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies")
  .post(body)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE",
    'content-type': "application/json"
    }

conn.request("POST", "/api/v2/admin_settings/organization_attributes/companies", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "POST",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/companies",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "data": {
        "attribute_values": "TechCorp;Innovate Inc."
    }
}

Response Example

{
    "data": {
        "companies": {
            "attribute_values": "TechCorp;Innovate Inc."
        },
        "status": {
            "status_code": 1,
            "status_message": "All the specified Companies have been successfully added."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}

Delete organization companies

This endpoint deletes an organization company from ADManager Plus.

Scope : Delete organization attributes action, All admin settings actions
Delegated role : Custom Settings > Organization Attributes > Companies

Query Parameters

from

integer

The starting index for pagination. Enables pagination through large result sets.

limit

integer

The maximum number of records to return per request.

filter

string

A SCIM filter query to refine which resources are returned. See Filter section for details.
eg: (ORG_ATTRIB_NAME eq Value1)

sort

string

This field is used to sort results. The default sort order is ascending. To sort in descending order, prefix the field with a hyphen (-).
eg: ORG_ATTRIB_NAME

Headers

string

The response format that the client accepts.

X-Module

string

The module name to be recorded in the audit logs. If not provided, the default module is recorded as Rest API.

Request Example

headers_data = Map();
headers_data.put("Accept", "application/json");
headers_data.put("X-Module", "External API");
headers_data.put("Authorization", "REPLACE_KEY_VALUE");
response = invokeUrl
[
url: "http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies")
  .delete(null)
  .addHeader("Accept", "application/json")
  .addHeader("X-Module", "External API")
  .addHeader("Authorization", "REPLACE_KEY_VALUE")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    'X-Module': 'External API',
    Authorization: 'REPLACE_KEY_VALUE'
  }
};

fetch('http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPConnection("admanagerplus:8080")

headers = {
    'Accept': "application/json",
    'X-Module': "External API",
    'Authorization': "REPLACE_KEY_VALUE"
    }

conn.request("DELETE", "/api/v2/admin_settings/organization_attributes/companies", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("http");

const options = {
  "method": "DELETE",
  "hostname": "admanagerplus",
  "port": "8080",
  "path": "/api/v2/admin_settings/organization_attributes/companies",
  "headers": {
    "Accept": "application/json",
    "X-Module": "External API",
    "Authorization": "REPLACE_KEY_VALUE"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url http://admanagerplus:8080/api/v2/admin_settings/organization_attributes/companies \
  --header 'Accept: application/json' \
  --header 'Authorization: REPLACE_KEY_VALUE' \
  --header 'X-Module: External API'

Response Example

{
    "data": {
        "object": {
            "ORG_ATTRIB_ID": 1,
            "ORG_ATTRIB_NAME": "Org Attribute 1"
        },
        "status": {
            "status_code": 1,
            "status_message": "Successfully removed the entries."
        }
    }
}

{
    "code": "00000100",
    "detail": "Some columns given in fields parameter are invalid",
    "title": "Bad Request."
}

{
    "code": "00000101",
    "detail": "The given Authtoken is invalid.",
    "title": "Unauthorized."
}

{
    "code": "00000000",
    "detail": "An internal server error occurred.",
    "title": "Internal Server Error."
}