Staff
APIs for managing administrator/staff access.
Creates a new staff account with administrative access based on the requesting user's permissions. The available roles depend on the caller's authorization level:
Network Software Provider Admin: Can add any role to any domain
Network Operator Administrator: Can add:
Venue roles:
venueadministrator,leasingagent(requires VenueID)Operator roles:
domainadministrator,siemadministrator,accountmanager,customersupport(no VenueID)
Account Manager/Customer Support/Venue Administrator: Can only add venue-specific roles at venues they manage (requires VenueID)
The new staff member will receive a temporary password and must accept terms and conditions.
The access token for the network operator admin session.
The email address for the new staff member.
The administrative role to assign. Valid roles depend on caller permissions:
venueadministrator- Venue-level administrator (requires VenueID)leasingagent- Leasing agent for venue (requires VenueID)domainadministrator- Domain-level administratorsiemadministrator- SIEM administratoraccountmanager- Account managercustomersupport- Customer support representative
Required for venue-specific roles (venueadministrator, leasingagent). Must be a valid venue ID that the caller has access to.
The first name of the new staff member.
The last name of the new staff member.
The locale preference for the new staff member (e.g., "en-us").
The domain for network software provider level access (admin only).
POST /preview/networkoperatorconsole/staff/enableStaffAccess HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 268
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"EmailAddress": "[email protected]",
"Role": "venueadministrator",
"VenueID": "USA.CA.90210.EXAMPLE.BEVERLYHILLS._V3VENUE.USA.CA.90210.LUXURY.BEVERLYHILLS",
"GivenName": "Jane",
"FamilyName": "Smith",
"locale": "en-us"
}Staff access enabled successfully.
{
"GivenName": "Swagger",
"FamilyName": "YAML",
"contactpref_sms": false,
"contactpref_email": true,
"locale": "en-us",
"EmailAddress": "[email protected]",
"TemporaryPassword": "uqedyaxa",
"Status": "AUP not accepted",
"SubscriberToken": "NowYum",
"Username": "nowyum",
"Enabled": true,
"CognitoStatus": "FORCE_CHANGE_PASSWORD",
"email_verified": true,
"PhoneNumber.E164": "",
"phone_number_verified": false,
"externalSubscriberID": "",
"SubscriberManagedviaSSO": false,
"dateAddedUTC.ISO8601": "2025-06-20T14:04:59.283Z",
"AdministrativeAccess": {
"NetworkSoftwareProviderAdministrator": [],
"PropertyManagementAdministrator": [],
"NetworkOperatorAdministrator": [],
"NetworkOperatorAccountManager": [],
"CustomerSupport": [],
"VenueAdministrator": [],
"LeasingAgent": []
},
"errorProcessing": false
}Disables a staff member's administrative access. Only users with sufficient administrative privileges (such as Network Operator Administrator or higher) can perform this action.
The access token for the network operator admin session.
The email address of the staff member to disable.
POST /preview/networkoperatorconsole/staff/disableStaffAccess HTTP/1.1
Host: api.wifikey.io
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
"EmailAddress": "[email protected]"
}Staff access disabled successfully.
{
"message": "Operation complete. ",
"errorProcessing": false
}Was this helpful?