updateOrgMultiPsks
PUT https://{{host}}/api/v1/orgs/:org_id/psks
Body Parameters
Name | Type | Description |
---|---|---|
name | string | a name for the PSK |
passphrase | string | passphrase of the PSK (8-63 character or 64 in hex) |
ssid | string | SSID this PSK should be applicable to |
usage | string | multi (default) / single |
vlan_id | int | VLAN for this PSK key |
mac | string | if usage==single, the mac that this PSK ties to, empty if auto-binding |
max_usage | int | max concurrent users for this PSK key. Default is 0 (unlimited) |
role | string | Role for this PSK key (32 character maximum) |
expire_time | int | Expire time for this PSK key. Default is half year, max is 5 year |
notes | string | notes |
notify_expiry | boolean | If set to true, reminder notification will be sent when psk is about to expire |
expiry_notification_time | int | Number of days before psk is expired. Used as to when to start sending reminder notification when the psk is about to expire |
notify_on_create_or_edit | boolean | If set to true, notification will be sent when psk is created or edited |
email | string | Email to send psk expiring notifications to |
admin_sso_id | string | sso id for psk created from psk portal |
old_passphrase | string | previous passphrase of the PSK if it has been rotated |
macs | list | if usage==macs, this list contains N number of client mac addresses or mac patterns(11:22:*) or both. This list is capped at 5000 |
Request Body
{"0"=>{"id"=>"2f64a022-9422-4fa3-92aa-ff6559a9f7f9", "name"=>"common123"}, "1"=>{"id"=>"110c59ae-d7b2-40f9-9bf2-82367370e55a", "usage"=>"single", "name"=>"common12", "passphrase"=>"foryoureyesonly1", "role"=>"teacher"}}