meraki/rest/saml-roles

Create a Meraki REST API wrapper for the saml-roles ressource. See the online documentation for more information.

Source:
Example
const apiKey = 'secret meraki api key'
const organizationId = 'meraki organization id'
const version = 'v0'
const target = 'n12'
const basePath = `/${target}/${version}`
const rateLimiter = {
 enabled: true
}
const samlEndpoints = require('./lib/rest/saml')({ apiKey, target, basePath, baseUrl, rateLimiter })
Parameters:
Name Type Attributes Default Description
apiKey string <optional>
 ''

The Meraki api key
target string <optional>
 'api'

The Meraki target
basePath string <optional>
 '/'

The Meraki base path for the saml-roles ressource
rateLimiter string

The rate limiter (bottleneck) configuration
logger object <optional>

Logger to use if logging is enabled
Returns:

The initialized Meraki REST API wrapper for the saml-roles ressource

Type
Object

Methods

(static) createSamlRole(apiKeyopt, targetopt, scopeopt, orgId, role, orgAccess, tags, networks) → {Promise}

Source:

Create a SAML role.

Example

Example response

{
  "id": "TEdJIEN1c3RvbWVy",
  "role": "myrole",
  "orgAccess": "none",
  "networks": [{
    "id": "N_1234",
    "access": "full"
  }],
  "tags": [{
    "tag": "west",
    "access": "read-only"
  }]
}
Parameters:
Name Type Attributes Description
apiKey string <optional>

Optional custom apiKey for this request (if not set will take the inital apiKey)
target string <optional>

Optional custom target for this request (if not set will take the inital target)
scope string <optional>

Optional custom scope for rate limiter
orgId string

The organization id
role string

The role of the SAML administrator
orgAccess string

The privilege of the SAML administrator on the organization (none, read-only, full)
tags array

The list of tags that the SAML administrator has privileges on

Properties
Name Type Description
tag string

The name of the tag
access string

The privilege of the SAML administrator on the tag
networks array

The list of networks that the SAML administrator has privileges on

Properties
Name Type Description
id string

The network ID
access string

The privilege of the SAML administrator on the network
Returns:

A promise holding the new SAML role

Type
Promise

(static) deleteSamlRole(apiKeyopt, targetopt, scopeopt, orgId, roleId) → {Promise}

Source:

Remove a SAML role.

Parameters:
Name Type Attributes Description
apiKey string <optional>

Optional custom apiKey for this request (if not set will take the inital apiKey)
target string <optional>

Optional custom target for this request (if not set will take the inital target)
scope string <optional>

Optional custom scope for rate limiter
orgId string

The organization id
roleId string

The SAML role id
Returns:

A promise with no data

Type
Promise

(static) listSamlRoles(apiKeyopt, targetopt, scopeopt, orgId) → {Promise}

Source:

List the SAML roles in an organization.

Example

Example response

[{
  "id": "TEdJIEN1c3RvbWVy",
  "role": "myrole",
  "orgAccess": "none",
  "networks": [{
    "id": "N_1234",
    "access": "full"
  }],
  "tags": [{
    "tag": "west",
    "access": "read-only"
  }]
}]
Parameters:
Name Type Attributes Description
apiKey string <optional>

Optional custom apiKey for this request (if not set will take the inital apiKey)
target string <optional>

Optional custom target for this request (if not set will take the inital target)
scope string <optional>

Optional custom scope for rate limiter
orgId string

The organization id
Returns:

A promise holding the SAML roles this organization

Type
Promise

(static) showSamlRole(apiKeyopt, targetopt, scopeopt, orgId, roleId) → {Promise}

Source:

Return a SAML role.

Example

Example response

{
  "id": "TEdJIEN1c3RvbWVy",
  "role": "myrole",
  "orgAccess": "none",
  "networks": [{
    "id": "N_1234",
    "access": "full"
  }],
  "tags": [{
    "tag": "west",
    "access": "read-only"
  }]
}
Parameters:
Name Type Attributes Description
apiKey string <optional>

Optional custom apiKey for this request (if not set will take the inital apiKey)
target string <optional>

Optional custom target for this request (if not set will take the inital target)
scope string <optional>

Optional custom scope for rate limiter
orgId string

The organization id
roleId string

The SAML role id
Returns:

A promise holding the SAML role for this role id

Type
Promise

(static) updateSamlRole(apiKeyopt, targetopt, scopeopt, orgId, roleId, role, orgAccess, tags, networks) → {Promise}

Source:

Update a SAML role.

Example

Example response

{
  "id": "TEdJIEN1c3RvbWVy",
  "role": "myrole",
  "orgAccess": "none",
  "networks": [{
    "id": "N_1234",
    "access": "full"
  }],
  "tags": [{
    "tag": "west",
    "access": "read-only"
  }]
}
Parameters:
Name Type Attributes Description
apiKey string <optional>

Optional custom apiKey for this request (if not set will take the inital apiKey)
target string <optional>

Optional custom target for this request (if not set will take the inital target)
scope string <optional>

Optional custom scope for rate limiter
orgId string

The organization id
roleId string

The SAML role id
role string

The role of the SAML administrator
orgAccess string

The privilege of the SAML administrator on the organization (none, read-only, full)
tags array

The list of tags that the SAML administrator has privileges on

Properties
Name Type Description
tag string

The name of the tag
access string

The privilege of the SAML administrator on the tag
networks array

The list of networks that the SAML administrator has privileges on

Properties
Name Type Description
id string

The network ID
access string

The privilege of the SAML administrator on the network
Returns:

A promise holding the updated SAML role for this role id

Type
Promise