1. Packages
  2. Cisco Meraki Provider
  3. API Docs
  4. networks
  5. getSmUsers
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

meraki.networks.getSmUsers

Explore with Pulumi AI

Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.networks.getSmUsers({
    emails: ["string"],
    ids: ["string"],
    networkId: "string",
    scopes: ["string"],
    usernames: ["string"],
});
export const merakiNetworksSmUsersExample = example.then(example => example.items);
Copy
import pulumi
import pulumi_meraki as meraki

example = meraki.networks.get_sm_users(emails=["string"],
    ids=["string"],
    network_id="string",
    scopes=["string"],
    usernames=["string"])
pulumi.export("merakiNetworksSmUsersExample", example.items)
Copy
package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.GetSmUsers(ctx, &networks.GetSmUsersArgs{
			Emails: []string{
				"string",
			},
			Ids: []string{
				"string",
			},
			NetworkId: "string",
			Scopes: []string{
				"string",
			},
			Usernames: []string{
				"string",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksSmUsersExample", example.Items)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Networks.GetSmUsers.Invoke(new()
    {
        Emails = new[]
        {
            "string",
        },
        Ids = new[]
        {
            "string",
        },
        NetworkId = "string",
        Scopes = new[]
        {
            "string",
        },
        Usernames = new[]
        {
            "string",
        },
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksSmUsersExample"] = example.Apply(getSmUsersResult => getSmUsersResult.Items),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.NetworksFunctions;
import com.pulumi.meraki.networks.inputs.GetSmUsersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = NetworksFunctions.getSmUsers(GetSmUsersArgs.builder()
            .emails("string")
            .ids("string")
            .networkId("string")
            .scopes("string")
            .usernames("string")
            .build());

        ctx.export("merakiNetworksSmUsersExample", example.applyValue(getSmUsersResult -> getSmUsersResult.items()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: meraki:networks:getSmUsers
      arguments:
        emails:
          - string
        ids:
          - string
        networkId: string
        scopes:
          - string
        usernames:
          - string
outputs:
  merakiNetworksSmUsersExample: ${example.items}
Copy

Using getSmUsers

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSmUsers(args: GetSmUsersArgs, opts?: InvokeOptions): Promise<GetSmUsersResult>
function getSmUsersOutput(args: GetSmUsersOutputArgs, opts?: InvokeOptions): Output<GetSmUsersResult>
Copy
def get_sm_users(emails: Optional[Sequence[str]] = None,
                 ids: Optional[Sequence[str]] = None,
                 network_id: Optional[str] = None,
                 scopes: Optional[Sequence[str]] = None,
                 usernames: Optional[Sequence[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSmUsersResult
def get_sm_users_output(emails: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 network_id: Optional[pulumi.Input[str]] = None,
                 scopes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 usernames: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSmUsersResult]
Copy
func GetSmUsers(ctx *Context, args *GetSmUsersArgs, opts ...InvokeOption) (*GetSmUsersResult, error)
func GetSmUsersOutput(ctx *Context, args *GetSmUsersOutputArgs, opts ...InvokeOption) GetSmUsersResultOutput
Copy

> Note: This function is named GetSmUsers in the Go SDK.

public static class GetSmUsers 
{
    public static Task<GetSmUsersResult> InvokeAsync(GetSmUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetSmUsersResult> Invoke(GetSmUsersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSmUsersResult> getSmUsers(GetSmUsersArgs args, InvokeOptions options)
public static Output<GetSmUsersResult> getSmUsers(GetSmUsersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: meraki:networks/getSmUsers:getSmUsers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

NetworkId This property is required. string
networkId path parameter. Network ID
Emails List<string>
emails query parameter. Filter users by email(s).
Ids List<string>
ids query parameter. Filter users by id(s).
Scopes List<string>
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
Usernames List<string>
usernames query parameter. Filter users by username(s).
NetworkId This property is required. string
networkId path parameter. Network ID
Emails []string
emails query parameter. Filter users by email(s).
Ids []string
ids query parameter. Filter users by id(s).
Scopes []string
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
Usernames []string
usernames query parameter. Filter users by username(s).
networkId This property is required. String
networkId path parameter. Network ID
emails List<String>
emails query parameter. Filter users by email(s).
ids List<String>
ids query parameter. Filter users by id(s).
scopes List<String>
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames List<String>
usernames query parameter. Filter users by username(s).
networkId This property is required. string
networkId path parameter. Network ID
emails string[]
emails query parameter. Filter users by email(s).
ids string[]
ids query parameter. Filter users by id(s).
scopes string[]
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames string[]
usernames query parameter. Filter users by username(s).
network_id This property is required. str
networkId path parameter. Network ID
emails Sequence[str]
emails query parameter. Filter users by email(s).
ids Sequence[str]
ids query parameter. Filter users by id(s).
scopes Sequence[str]
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames Sequence[str]
usernames query parameter. Filter users by username(s).
networkId This property is required. String
networkId path parameter. Network ID
emails List<String>
emails query parameter. Filter users by email(s).
ids List<String>
ids query parameter. Filter users by id(s).
scopes List<String>
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames List<String>
usernames query parameter. Filter users by username(s).

getSmUsers Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Items List<GetSmUsersItem>
Array of ResponseSmGetNetworkSmUsers
NetworkId string
networkId path parameter. Network ID
Emails List<string>
emails query parameter. Filter users by email(s).
Ids List<string>
ids query parameter. Filter users by id(s).
Scopes List<string>
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
Usernames List<string>
usernames query parameter. Filter users by username(s).
Id string
The provider-assigned unique ID for this managed resource.
Items []GetSmUsersItem
Array of ResponseSmGetNetworkSmUsers
NetworkId string
networkId path parameter. Network ID
Emails []string
emails query parameter. Filter users by email(s).
Ids []string
ids query parameter. Filter users by id(s).
Scopes []string
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
Usernames []string
usernames query parameter. Filter users by username(s).
id String
The provider-assigned unique ID for this managed resource.
items List<GetSmUsersItem>
Array of ResponseSmGetNetworkSmUsers
networkId String
networkId path parameter. Network ID
emails List<String>
emails query parameter. Filter users by email(s).
ids List<String>
ids query parameter. Filter users by id(s).
scopes List<String>
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames List<String>
usernames query parameter. Filter users by username(s).
id string
The provider-assigned unique ID for this managed resource.
items GetSmUsersItem[]
Array of ResponseSmGetNetworkSmUsers
networkId string
networkId path parameter. Network ID
emails string[]
emails query parameter. Filter users by email(s).
ids string[]
ids query parameter. Filter users by id(s).
scopes string[]
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames string[]
usernames query parameter. Filter users by username(s).
id str
The provider-assigned unique ID for this managed resource.
items Sequence[GetSmUsersItem]
Array of ResponseSmGetNetworkSmUsers
network_id str
networkId path parameter. Network ID
emails Sequence[str]
emails query parameter. Filter users by email(s).
ids Sequence[str]
ids query parameter. Filter users by id(s).
scopes Sequence[str]
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames Sequence[str]
usernames query parameter. Filter users by username(s).
id String
The provider-assigned unique ID for this managed resource.
items List<Property Map>
Array of ResponseSmGetNetworkSmUsers
networkId String
networkId path parameter. Network ID
emails List<String>
emails query parameter. Filter users by email(s).
ids List<String>
ids query parameter. Filter users by id(s).
scopes List<String>
scope query parameter. Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.
usernames List<String>
usernames query parameter. Filter users by username(s).

Supporting Types

GetSmUsersItem

AdGroups This property is required. List<string>
Active Directory Groups the user belongs to.
AsmGroups This property is required. List<string>
Apple School Manager Groups the user belongs to.
AzureAdGroups This property is required. List<string>
Azure Active Directory Groups the user belongs to.
DisplayName This property is required. string
The user display name.
Email This property is required. string
User email.
FullName This property is required. string
User full name.
HasIdentityCertificate This property is required. bool
A boolean indicating if the user has an associated identity certificate..
HasPassword This property is required. bool
A boolean denoting if the user has a password associated with the record.
Id This property is required. string
The Meraki managed Id of the user record.
IsExternal This property is required. bool
Whether the user was created using an external integration, or via the Meraki Dashboard.
SamlGroups This property is required. List<string>
SAML Groups the user belongs to.
Tags This property is required. string
The set of tags the user is scoped to.
UserThumbnail This property is required. string
The url where the users thumbnail is hosted.
Username This property is required. string
The users username.
AdGroups This property is required. []string
Active Directory Groups the user belongs to.
AsmGroups This property is required. []string
Apple School Manager Groups the user belongs to.
AzureAdGroups This property is required. []string
Azure Active Directory Groups the user belongs to.
DisplayName This property is required. string
The user display name.
Email This property is required. string
User email.
FullName This property is required. string
User full name.
HasIdentityCertificate This property is required. bool
A boolean indicating if the user has an associated identity certificate..
HasPassword This property is required. bool
A boolean denoting if the user has a password associated with the record.
Id This property is required. string
The Meraki managed Id of the user record.
IsExternal This property is required. bool
Whether the user was created using an external integration, or via the Meraki Dashboard.
SamlGroups This property is required. []string
SAML Groups the user belongs to.
Tags This property is required. string
The set of tags the user is scoped to.
UserThumbnail This property is required. string
The url where the users thumbnail is hosted.
Username This property is required. string
The users username.
adGroups This property is required. List<String>
Active Directory Groups the user belongs to.
asmGroups This property is required. List<String>
Apple School Manager Groups the user belongs to.
azureAdGroups This property is required. List<String>
Azure Active Directory Groups the user belongs to.
displayName This property is required. String
The user display name.
email This property is required. String
User email.
fullName This property is required. String
User full name.
hasIdentityCertificate This property is required. Boolean
A boolean indicating if the user has an associated identity certificate..
hasPassword This property is required. Boolean
A boolean denoting if the user has a password associated with the record.
id This property is required. String
The Meraki managed Id of the user record.
isExternal This property is required. Boolean
Whether the user was created using an external integration, or via the Meraki Dashboard.
samlGroups This property is required. List<String>
SAML Groups the user belongs to.
tags This property is required. String
The set of tags the user is scoped to.
userThumbnail This property is required. String
The url where the users thumbnail is hosted.
username This property is required. String
The users username.
adGroups This property is required. string[]
Active Directory Groups the user belongs to.
asmGroups This property is required. string[]
Apple School Manager Groups the user belongs to.
azureAdGroups This property is required. string[]
Azure Active Directory Groups the user belongs to.
displayName This property is required. string
The user display name.
email This property is required. string
User email.
fullName This property is required. string
User full name.
hasIdentityCertificate This property is required. boolean
A boolean indicating if the user has an associated identity certificate..
hasPassword This property is required. boolean
A boolean denoting if the user has a password associated with the record.
id This property is required. string
The Meraki managed Id of the user record.
isExternal This property is required. boolean
Whether the user was created using an external integration, or via the Meraki Dashboard.
samlGroups This property is required. string[]
SAML Groups the user belongs to.
tags This property is required. string
The set of tags the user is scoped to.
userThumbnail This property is required. string
The url where the users thumbnail is hosted.
username This property is required. string
The users username.
ad_groups This property is required. Sequence[str]
Active Directory Groups the user belongs to.
asm_groups This property is required. Sequence[str]
Apple School Manager Groups the user belongs to.
azure_ad_groups This property is required. Sequence[str]
Azure Active Directory Groups the user belongs to.
display_name This property is required. str
The user display name.
email This property is required. str
User email.
full_name This property is required. str
User full name.
has_identity_certificate This property is required. bool
A boolean indicating if the user has an associated identity certificate..
has_password This property is required. bool
A boolean denoting if the user has a password associated with the record.
id This property is required. str
The Meraki managed Id of the user record.
is_external This property is required. bool
Whether the user was created using an external integration, or via the Meraki Dashboard.
saml_groups This property is required. Sequence[str]
SAML Groups the user belongs to.
tags This property is required. str
The set of tags the user is scoped to.
user_thumbnail This property is required. str
The url where the users thumbnail is hosted.
username This property is required. str
The users username.
adGroups This property is required. List<String>
Active Directory Groups the user belongs to.
asmGroups This property is required. List<String>
Apple School Manager Groups the user belongs to.
azureAdGroups This property is required. List<String>
Azure Active Directory Groups the user belongs to.
displayName This property is required. String
The user display name.
email This property is required. String
User email.
fullName This property is required. String
User full name.
hasIdentityCertificate This property is required. Boolean
A boolean indicating if the user has an associated identity certificate..
hasPassword This property is required. Boolean
A boolean denoting if the user has a password associated with the record.
id This property is required. String
The Meraki managed Id of the user record.
isExternal This property is required. Boolean
Whether the user was created using an external integration, or via the Meraki Dashboard.
samlGroups This property is required. List<String>
SAML Groups the user belongs to.
tags This property is required. String
The set of tags the user is scoped to.
userThumbnail This property is required. String
The url where the users thumbnail is hosted.
username This property is required. String
The users username.

Package Details

Repository
meraki pulumi/pulumi-meraki
License
Apache-2.0
Notes
This Pulumi package is based on the meraki Terraform Provider.
Cisco Meraki v0.4.1 published on Saturday, Mar 15, 2025 by Pulumi