Custom Attributes Management

Get Custom Attributes

This call gets a list of custom attributes in the system. You can use this call to get all custome attributes, or narrow the search to account, device, AAD, or LDAP custom attributes.

Authentication

This call requires Tenant Admin credentials.

HTTP method

GET

Request URI

To get all custom attributes:

/api/v1/customattributes

To get custom attributes of the specified type:

/api/v1/customattributes?type=account|device| AAD|LDAP

Request parameters

Parameter	Argument Type	Description	Example Value
type	Query	Type of custom attribute to retrieve. Can be: account device AAD LDAP Sending the call without the type parameter retrieves all custom attributes.	account

Example request

Get account custom attributes.

curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/customattributes?type=account' \
--header 'Authorization: Basic <token>' \

Response fields

Field	Description
errors	Lists errors, if any.
result	Container for results.
searchResults	Container for search results.
id	Custom attribute ID.
createdAt	When custom attribute created.
createdBy	Who created custom attribute.
modifiedAt	When custom attribute modified.
modifiedBy	Who modified custom attribute.
type	Type of custom attribute, account, device, AAD, or LDAP.
name	Name of custom attribute.
totalCount	How many custom attributes found.
offset	Where in the results the return starts.
limit	How many rows retrieved.

Example response

{
    "errors": null, 
    "result": {
        "searchResults": [
            {
                "id": 197, 
                "createdAt": 1488590903744, 
                "createdBy": 67076, 
                "modifiedAt": 1488590903744, 
                "modifiedBy": null, 
                "type": "ACCOUNT", 
                "name": "firstName"
            }, 
            {
                "id": 448, 
                "createdAt": 1511926900839, 
                "createdBy": 67076, 
                "modifiedAt": 1511926900839, 
                "modifiedBy": null, 
                "type": "ACCOUNT", 
                "name": "fn"
            }, 
            {
                "id": 1044, 
                "createdAt": 1516915901064, 
                "createdBy": 67076, 
                "modifiedAt": 1516915901064, 
                "modifiedBy": null, 
                "type": "ACCOUNT", 
                "name": "phoneNumber"
            }, 
            {
                "id": 2205, 
                "createdAt": 1542063540291, 
                "createdBy": 67076, 
                "modifiedAt": 1542063540291, 
                "modifiedBy": null, 
                "type": "ACCOUNT", 
                "name": "idamattrib"
            }, 
            {
                "id": 5003, 
                "createdAt": 1581633006072, 
                "createdBy": 67076, 
                "modifiedAt": 1581633006072, 
                "modifiedBy": null, 
                "type": "ACCOUNT", 
                "name": "test234"
            }
        ], 
        "totalCount": 5, 
        "offset": 0, 
        "limit": 50
    }
}

Create Custom Attributes

This call creates custom attributes.

Authentication

This call requires Tenant Admin credentials.

HTTP method

POST

Request URI

POST https://<hostname>/api/v1/customattributes

Request parameters

Parameter	Argument Type	Description	Example Value
attrs	Array	List of custom attributes to be created.	attribute1, DEVICE

Example request

POST /api/v1/customattributes

Host: <hostname>

Content-Type: application/json

Authorization: Bearer <access_token>

{

"attrs": [

{

"name": "attribute1",

"type": "DEVICE",

"dataType": "TEXT",

"isPreserved": false

}

]

}

Example response

{"errors":null,"result":[{"id":196079,"createdAt":null,"createdBy":2960452,"modifiedAt":null,"modifiedBy":null,"type":"DEVICE","dataType":"TEXT","isPreserved":false,"name":"attribute1"}]}

Update Custom Attributes

This call updates custom attributes.

Authentication

This call requires Tenant Admin credentials.

HTTP method

PUT

Request URI

PUT https://<hostname>/api/v1/customattributes

Request parameters

Parameter	Argument Type	Description	Example Value
attrs	Array	List of custom attributes to be updated.	attribute1, DEVICE

Example request

PUT /api/v1/customattributes

Host: <hostname>

Content-Type: application/json

Authorization: Bearer <access_token>

{

"attrs": [

{

"id": "86972",

"name": "attribute1",

"type": "DEVICE",

"isPreserved": false

}

]

}

Example response

{"errors":null,"result":1}

Delete Custom Attributes

This call updates custom attributes.

Authentication

This call requires Tenant Admin credentials.

HTTP method

DELETE

Request URI

DELETE https://<hostname>/api/v1/customattributes

Request parameters

Parameter	Argument Type	Description	Example Value
ids	Array	Custom attributes to be deleted.	182626

Example request

DELETE /api/v1/customattributes

Host: <hostname>

Content-Type: application/json

Authorization: Bearer <access_token>

{

"ids": [182626]

}

Example response

{"errors":null,"result":1}