Create a Meraki Frontend API wrapper for the organizations process. This is uses the same API as the Meraki webfrontend. So stuff can break
- Source:
Example
const target = 'n12'
const basePath = ``
const rateLimiter = {
enabled: true
}
const organizationEndpoints = require('./lib/frontend/organizations')({ basePath, baseUrl, rateLimiter })Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
target |
string |
<optional> |
'account'
|
The Meraki target |
basePath |
string |
<optional> |
The Meraki base path for the Authentication ressource |
|
baseUrl |
string |
<optional> |
The Meraki base url for the Authentication ressource |
|
rateLimiter |
string | The rate limiter (bottleneck) configuration |
Returns:
The initialized Meraki REST API wrapper for the Authentication ressource
- Type
- Object
Methods
(async, static) deleteOrganization(targetopt, eidopt) → {Promise}
- Source:
delete the org
Example
Example response
{ success:true }Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
target |
string |
<optional> |
targetOrt
|
Optional custom target for this request (if not set will take the inital target) |
eid |
string |
<optional> |
email address of the user to authenticate with |
Returns:
A promise holding the informations about this organization
- Type
- Promise
(async, static) getOrganization(targetopt, eidopt) → {Promise}
- Source:
Get the information about the org from the api
Example
Example response
{
"id":"123",
"eid":"asdfasdf",
"uid":"123",
"org_admin_type":"write",
"name":"Test api Deletion",
"node_groups":{
},
"num_networks":0,
"locales":{
},
"shard_id":123,
"licensed_product_edition_name":"enterprise",
"license_expires_on":0,
"block_meraki_admins":false,
"org":{
"reported_api_level":4,
"resolved_api_level":4,
"id":"123",
"eid":"asdfasdf",
"l3_vpn_config_hash":{
"participants":[
],
"firewall_rules":[
],
"vpn_firewall_inbound_default_rules_logging":true,
"vpn_firewall_outbound_default_rules_logging":true,
"ipsec_peers":[
]
},
"mcn":"1233-1233"
},
"inventory":[
],
"api_level":4,
"support_password":"1234"
}Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
target |
string |
<optional> |
targetOrt
|
Optional custom target for this request (if not set will take the inital target) |
eid |
string |
<optional> |
email address of the user to authenticate with |
Returns:
A promise holding the informations about this organization
- Type
- Promise