{ "opencollection": "1.0.0", "info": { "name": "Mist Admins Orgs Psks API", "version": "2604.1.1" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Orgs Psks", "type": "folder" }, "items": [ { "info": { "name": "listOrgPsks", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "name", "value": "psk_name", "type": "query" }, { "name": "ssid", "value": "", "type": "query" }, { "name": "role", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Get List of Org Psks" }, { "info": { "name": "createOrgPsk", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "upsert", "value": "", "type": "query", "description": "If a key exists with the same `name`, replace it with the new one" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Org PSK\n\n\nWhen `usage`==`macs`, corresponding \"macs\" field will hold a list consisting of client mac addresses ([\"xx:xx:xx:xx:xx\",...]) or mac patterns([\"xx:xx:*\",\"xx*\",...]) or both ([\"xx:xx:xx:xx:xx:xx\", \"xx:*\", ...]). This list is capped at 5000" }, { "info": { "name": "updateOrgMultiplePsks", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Multiple PSKs" }, { "info": { "name": "deleteOrgPskList", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks/delete", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Org PSK List\n\nDelete list of psks on the org. This API accepts single string or list of strings" }, { "info": { "name": "importOrgPsks", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks/import", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Import PSK from CSV file or JSON\n\n## CSV File Format\n```\nPSK Import CSV File Format:\nname,ssid,passphrase,usage,vlan_id,mac,max_usage,role,expire_time,notify_expiry,expiry_notification_time,notify_on_create_or_edit,email\nCommon,warehouse,foryoureyesonly,single,35,a31425f31278,0,student,1618594236\nJustin,reception,visible,multi,1002,200,teacher,1618594236\nCommon2,ssid,1245678-xx,single,35,a31425f31278,0,student,1618594236,true,7,true,admin@test.com\n```" }, { "info": { "name": "getOrgPsk", "type": "http" }, "http": { "method": "GET", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks/:psk_id", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "psk_id", "value": "", "type": "path", "description": "PSK ID" } ] }, "docs": "Get Org PSK Details" }, { "info": { "name": "updateOrgPsk", "type": "http" }, "http": { "method": "PUT", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks/:psk_id", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "psk_id", "value": "", "type": "path", "description": "PSK ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Org PSK" }, { "info": { "name": "deleteOrgPsk", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks/:psk_id", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "psk_id", "value": "", "type": "path", "description": "PSK ID" } ] }, "docs": "Delete Org PSK" }, { "info": { "name": "deleteOrgPskOldPassphrase", "type": "http" }, "http": { "method": "POST", "url": "https://api.mist.com/api/v1/orgs/:org_id/psks/:psk_id/delete_old_passphrase", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "psk_id", "value": "", "type": "path", "description": "PSK ID" } ] }, "docs": "Delete `old_passphrase` from PSK. \nIf successful, response is same as GET, returns the PSK with `old_passphrase` removed." } ] } ], "bundled": true }