OrgsGuests

searchOrgGuestAuthorization

GET
/api/v1/orgs/{org_id}/guests/search

Search organization guest authorization records with filters for WLAN, SSID, authentication method, and time range.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

wlan_id?string

Filter results by WLAN identifier

auth_method?string

Filter results by authentication method

ssid?string

Filter results by SSID

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/guests/search"
{  "end": 1531862583,  "limit": 2,  "next": "/api/v1/sites/8aaba0aa-09cc-44bd-9709-33b98040550c/guests/search?wlan_id=88ffe630-95b8-11e8-b294-346895ed1b7d&end=1531855849.000&limit=2&start=1531776183.0",  "results": [    {      "ap": "5c5b350e0001",      "auth_method": "passphrase",      "authorized_expiring_time": 1531810258.186273,      "authorized_time": 1531782218,      "company": "mistsystems",      "email": "user@mistsys.com",      "name": "john",      "ssid": "openNet",      "timestamp": 1531782218    },    {      "ap": "5c5b350e0001",      "auth_method": "facebook",      "authorized_expiring_time": 1531810821.145,      "authorized_time": 1531782632,      "company": "xyz inc.",      "email": "cool_user@yahoo.com",      "name": "John White",      "ssid": "openNet",      "timestamp": 1531782632    }  ],  "start": 1531776183,  "total": 14}