Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. getSmUsers
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.getSmUsers

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    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);

    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)

    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
	})
}

    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),
    };
});

    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()));
    }
}

    variables:
  example:
    fn::invoke:
      Function: meraki:networks:getSmUsers
      Arguments:
        emails:
          - string
        ids:
          - string
        networkId: string
        scopes:
          - string
        usernames:
          - string
outputs:
  merakiNetworksSmUsersExample: ${example.items}

    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>
    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]
    func GetSmUsers(ctx *Context, args *GetSmUsersArgs, opts ...InvokeOption) (*GetSmUsersResult, error)
func GetSmUsersOutput(ctx *Context, args *GetSmUsersOutputArgs, opts ...InvokeOption) GetSmUsersResultOutput

    > 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)
}
    public static CompletableFuture<GetSmUsersResult> getSmUsers(GetSmUsersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: meraki:networks/getSmUsers:getSmUsers
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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).
    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).
    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).
    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).
    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).
    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).

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