​
Parameters​

ParameterDescription
Device IDThe ID of the device to update.
EnabledFlag indicating if the account is enabled.
Expire TimeTime at which the account will expire.
Role IDThe ID of the role to assign to the account.
Start TimeTime at which the account will be enabled.
Visitor NameName to display for the account.

​
Example Output​

{    "_links": {        "self": {            "href": "https://clearpass-host/api/device?calculate_count=false&offset=0&limit=25&sort=-id&filter=%7B%7D"        },        "first": {            "href": "https://clearpass-host/api/device?calculate_count=false&offset=0&limit=25&sort=-id&filter=%7B%7D"        }    },    "_embedded": {        "items": [            {                "id": "3001",                "username": "00-1A-2B-3C-4D-5E",                "start_time": 1696929372,                "expire_time": 1728465372,                "sponsor_name": "admin",                "sponsor_profile": "1",                "enabled": true,                "current_state": "active",                "notes": "",                "role_name": "[Guest]",                "role_id": 2,                "mac": "00-1A-2B-3C-4D-5E",                "mac_auth": true,                "source": "mac_create",                "do_expire": "1",                "no_portal": "1",                "create_time": 1696929372,                "no_password": "1",                "remote_addr": "85.64.17.207",                "visitor_name": "John's Amazing Laptop",                "airgroup_enable": "1",                "airgroup_shared": "",                "expire_postlogin": "0",                "simultaneous_use": "1",                "airgroup_shared_role": "",                "airgroup_shared_time": "",                "airgroup_shared_user": "admin",                "sponsor_profile_name": "Super Administrator",                "airgroup_shared_group": "",                "expired_notify_status": "1",                "airgroup_shared_location": "",                "_links": {                    "self": {                        "href": "https://clearpass-host/api/device/3001"                    }                }            }        ]    }}

​
Workflow Library Example​

Update Device Account with Clearpass and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

Get Insight Alert ConfigurationsUpdate Endpoint