Cisco Meraki v0.3.2, Sep 24 24

Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

meraki.networks.MerakiAuthUsers

Explore with Pulumi AI

Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.MerakiAuthUsers;
import com.pulumi.meraki.networks.MerakiAuthUsersArgs;
import com.pulumi.meraki.networks.inputs.MerakiAuthUsersAuthorizationArgs;
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) {
        var example = new MerakiAuthUsers("example", MerakiAuthUsersArgs.builder()
            .accountType("802.1X")
            .authorizations(MerakiAuthUsersAuthorizationArgs.builder()
                .expires_at("2018-03-13T00:00:00.090210Z")
                .ssid_number(1)
                .build())
            .email("miles@meraki.com")
            .emailPasswordToUser(false)
            .isAdmin(false)
            .name("Miles Meraki")
            .networkId("string")
            .password("secret")
            .build());

        ctx.export("merakiNetworksMerakiAuthUsersExample", example);
    }
}

resources:
  example:
    type: meraki:networks:MerakiAuthUsers
    properties:
      accountType: 802.1X
      authorizations:
        - expires_at: 2018-03-13T00:00:00.090210Z
          ssid_number: 1
      email: miles@meraki.com
      emailPasswordToUser: false
      isAdmin: false
      name: Miles Meraki
      networkId: string
      password: secret
outputs:
  merakiNetworksMerakiAuthUsersExample: ${example}

Create MerakiAuthUsers Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MerakiAuthUsers(name: string, args: MerakiAuthUsersArgs, opts?: CustomResourceOptions);

@overload
def MerakiAuthUsers(resource_name: str,
                    args: MerakiAuthUsersArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def MerakiAuthUsers(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    network_id: Optional[str] = None,
                    account_type: Optional[str] = None,
                    authorizations: Optional[Sequence[MerakiAuthUsersAuthorizationArgs]] = None,
                    email: Optional[str] = None,
                    email_password_to_user: Optional[bool] = None,
                    is_admin: Optional[bool] = None,
                    meraki_auth_user_id: Optional[str] = None,
                    name: Optional[str] = None,
                    password: Optional[str] = None)

func NewMerakiAuthUsers(ctx *Context, name string, args MerakiAuthUsersArgs, opts ...ResourceOption) (*MerakiAuthUsers, error)

public MerakiAuthUsers(string name, MerakiAuthUsersArgs args, CustomResourceOptions? opts = null)

public MerakiAuthUsers(String name, MerakiAuthUsersArgs args)
public MerakiAuthUsers(String name, MerakiAuthUsersArgs args, CustomResourceOptions options)

type: meraki:networks:MerakiAuthUsers
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args MerakiAuthUsersArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args MerakiAuthUsersArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args MerakiAuthUsersArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args MerakiAuthUsersArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args MerakiAuthUsersArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var merakiAuthUsersResource = new Meraki.Networks.MerakiAuthUsers("merakiAuthUsersResource", new()
{
    NetworkId = "string",
    AccountType = "string",
    Authorizations = new[]
    {
        new Meraki.Networks.Inputs.MerakiAuthUsersAuthorizationArgs
        {
            AuthorizedByEmail = "string",
            AuthorizedByName = "string",
            AuthorizedZone = "string",
            ExpiresAt = "string",
            SsidNumber = 0,
        },
    },
    Email = "string",
    EmailPasswordToUser = false,
    IsAdmin = false,
    MerakiAuthUserId = "string",
    Name = "string",
    Password = "string",
});

example, err := networks.NewMerakiAuthUsers(ctx, "merakiAuthUsersResource", &networks.MerakiAuthUsersArgs{
	NetworkId:   pulumi.String("string"),
	AccountType: pulumi.String("string"),
	Authorizations: networks.MerakiAuthUsersAuthorizationArray{
		&networks.MerakiAuthUsersAuthorizationArgs{
			AuthorizedByEmail: pulumi.String("string"),
			AuthorizedByName:  pulumi.String("string"),
			AuthorizedZone:    pulumi.String("string"),
			ExpiresAt:         pulumi.String("string"),
			SsidNumber:        pulumi.Int(0),
		},
	},
	Email:               pulumi.String("string"),
	EmailPasswordToUser: pulumi.Bool(false),
	IsAdmin:             pulumi.Bool(false),
	MerakiAuthUserId:    pulumi.String("string"),
	Name:                pulumi.String("string"),
	Password:            pulumi.String("string"),
})

var merakiAuthUsersResource = new MerakiAuthUsers("merakiAuthUsersResource", MerakiAuthUsersArgs.builder()
    .networkId("string")
    .accountType("string")
    .authorizations(MerakiAuthUsersAuthorizationArgs.builder()
        .authorizedByEmail("string")
        .authorizedByName("string")
        .authorizedZone("string")
        .expiresAt("string")
        .ssidNumber(0)
        .build())
    .email("string")
    .emailPasswordToUser(false)
    .isAdmin(false)
    .merakiAuthUserId("string")
    .name("string")
    .password("string")
    .build());

meraki_auth_users_resource = meraki.networks.MerakiAuthUsers("merakiAuthUsersResource",
    network_id="string",
    account_type="string",
    authorizations=[{
        "authorized_by_email": "string",
        "authorized_by_name": "string",
        "authorized_zone": "string",
        "expires_at": "string",
        "ssid_number": 0,
    }],
    email="string",
    email_password_to_user=False,
    is_admin=False,
    meraki_auth_user_id="string",
    name="string",
    password="string")

const merakiAuthUsersResource = new meraki.networks.MerakiAuthUsers("merakiAuthUsersResource", {
    networkId: "string",
    accountType: "string",
    authorizations: [{
        authorizedByEmail: "string",
        authorizedByName: "string",
        authorizedZone: "string",
        expiresAt: "string",
        ssidNumber: 0,
    }],
    email: "string",
    emailPasswordToUser: false,
    isAdmin: false,
    merakiAuthUserId: "string",
    name: "string",
    password: "string",
});

type: meraki:networks:MerakiAuthUsers
properties:
    accountType: string
    authorizations:
        - authorizedByEmail: string
          authorizedByName: string
          authorizedZone: string
          expiresAt: string
          ssidNumber: 0
    email: string
    emailPasswordToUser: false
    isAdmin: false
    merakiAuthUserId: string
    name: string
    networkId: string
    password: string

MerakiAuthUsers Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MerakiAuthUsers resource accepts the following input properties:

NetworkId string: networkId path parameter. Network ID
AccountType string: Authorization type for user.
Authorizations List<MerakiAuthUsersAuthorization>: User authorization info
Email string: Email address of the user
EmailPasswordToUser bool: Whether or not Meraki should email the password to user. Default is false.
IsAdmin bool: Whether or not the user is a Dashboard administrator
MerakiAuthUserId string: merakiAuthUserId path parameter. Meraki auth user ID
Name string: Name of the user
Password string: The password for this user account. Only required If the user is not a Dashboard administrator.

NetworkId string: networkId path parameter. Network ID
AccountType string: Authorization type for user.
Authorizations []MerakiAuthUsersAuthorizationArgs: User authorization info
Email string: Email address of the user
EmailPasswordToUser bool: Whether or not Meraki should email the password to user. Default is false.
IsAdmin bool: Whether or not the user is a Dashboard administrator
MerakiAuthUserId string: merakiAuthUserId path parameter. Meraki auth user ID
Name string: Name of the user
Password string: The password for this user account. Only required If the user is not a Dashboard administrator.

networkId String: networkId path parameter. Network ID
accountType String: Authorization type for user.
authorizations List<MerakiAuthUsersAuthorization>: User authorization info
email String: Email address of the user
emailPasswordToUser Boolean: Whether or not Meraki should email the password to user. Default is false.
isAdmin Boolean: Whether or not the user is a Dashboard administrator
merakiAuthUserId String: merakiAuthUserId path parameter. Meraki auth user ID
name String: Name of the user
password String: The password for this user account. Only required If the user is not a Dashboard administrator.

networkId string: networkId path parameter. Network ID
accountType string: Authorization type for user.
authorizations MerakiAuthUsersAuthorization[]: User authorization info
email string: Email address of the user
emailPasswordToUser boolean: Whether or not Meraki should email the password to user. Default is false.
isAdmin boolean: Whether or not the user is a Dashboard administrator
merakiAuthUserId string: merakiAuthUserId path parameter. Meraki auth user ID
name string: Name of the user
password string: The password for this user account. Only required If the user is not a Dashboard administrator.

network_id str: networkId path parameter. Network ID
account_type str: Authorization type for user.
authorizations Sequence[MerakiAuthUsersAuthorizationArgs]: User authorization info
email str: Email address of the user
email_password_to_user bool: Whether or not Meraki should email the password to user. Default is false.
is_admin bool: Whether or not the user is a Dashboard administrator
meraki_auth_user_id str: merakiAuthUserId path parameter. Meraki auth user ID
name str: Name of the user
password str: The password for this user account. Only required If the user is not a Dashboard administrator.

networkId String: networkId path parameter. Network ID
accountType String: Authorization type for user.
authorizations List<Property Map>: User authorization info
email String: Email address of the user
emailPasswordToUser Boolean: Whether or not Meraki should email the password to user. Default is false.
isAdmin Boolean: Whether or not the user is a Dashboard administrator
merakiAuthUserId String: merakiAuthUserId path parameter. Meraki auth user ID
name String: Name of the user
password String: The password for this user account. Only required If the user is not a Dashboard administrator.

Outputs

All input properties are implicitly available as output properties. Additionally, the MerakiAuthUsers resource produces the following output properties:

CreatedAt string: Creation time of the user
Id string: The provider-assigned unique ID for this managed resource.

CreatedAt string: Creation time of the user
Id string: The provider-assigned unique ID for this managed resource.

createdAt String: Creation time of the user
id String: The provider-assigned unique ID for this managed resource.

createdAt string: Creation time of the user
id string: The provider-assigned unique ID for this managed resource.

created_at str: Creation time of the user
id str: The provider-assigned unique ID for this managed resource.

createdAt String: Creation time of the user
id String: The provider-assigned unique ID for this managed resource.

Look up Existing MerakiAuthUsers Resource

Get an existing MerakiAuthUsers resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MerakiAuthUsersState, opts?: CustomResourceOptions): MerakiAuthUsers

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_type: Optional[str] = None,
        authorizations: Optional[Sequence[MerakiAuthUsersAuthorizationArgs]] = None,
        created_at: Optional[str] = None,
        email: Optional[str] = None,
        email_password_to_user: Optional[bool] = None,
        is_admin: Optional[bool] = None,
        meraki_auth_user_id: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        password: Optional[str] = None) -> MerakiAuthUsers

func GetMerakiAuthUsers(ctx *Context, name string, id IDInput, state *MerakiAuthUsersState, opts ...ResourceOption) (*MerakiAuthUsers, error)

public static MerakiAuthUsers Get(string name, Input<string> id, MerakiAuthUsersState? state, CustomResourceOptions? opts = null)

public static MerakiAuthUsers get(String name, Output<String> id, MerakiAuthUsersState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountType string: Authorization type for user.
Authorizations List<MerakiAuthUsersAuthorization>: User authorization info
CreatedAt string: Creation time of the user
Email string: Email address of the user
EmailPasswordToUser bool: Whether or not Meraki should email the password to user. Default is false.
IsAdmin bool: Whether or not the user is a Dashboard administrator
MerakiAuthUserId string: merakiAuthUserId path parameter. Meraki auth user ID
Name string: Name of the user
NetworkId string: networkId path parameter. Network ID
Password string: The password for this user account. Only required If the user is not a Dashboard administrator.

AccountType string: Authorization type for user.
Authorizations []MerakiAuthUsersAuthorizationArgs: User authorization info
CreatedAt string: Creation time of the user
Email string: Email address of the user
EmailPasswordToUser bool: Whether or not Meraki should email the password to user. Default is false.
IsAdmin bool: Whether or not the user is a Dashboard administrator
MerakiAuthUserId string: merakiAuthUserId path parameter. Meraki auth user ID
Name string: Name of the user
NetworkId string: networkId path parameter. Network ID
Password string: The password for this user account. Only required If the user is not a Dashboard administrator.

accountType String: Authorization type for user.
authorizations List<MerakiAuthUsersAuthorization>: User authorization info
createdAt String: Creation time of the user
email String: Email address of the user
emailPasswordToUser Boolean: Whether or not Meraki should email the password to user. Default is false.
isAdmin Boolean: Whether or not the user is a Dashboard administrator
merakiAuthUserId String: merakiAuthUserId path parameter. Meraki auth user ID
name String: Name of the user
networkId String: networkId path parameter. Network ID
password String: The password for this user account. Only required If the user is not a Dashboard administrator.

accountType string: Authorization type for user.
authorizations MerakiAuthUsersAuthorization[]: User authorization info
createdAt string: Creation time of the user
email string: Email address of the user
emailPasswordToUser boolean: Whether or not Meraki should email the password to user. Default is false.
isAdmin boolean: Whether or not the user is a Dashboard administrator
merakiAuthUserId string: merakiAuthUserId path parameter. Meraki auth user ID
name string: Name of the user
networkId string: networkId path parameter. Network ID
password string: The password for this user account. Only required If the user is not a Dashboard administrator.

account_type str: Authorization type for user.
authorizations Sequence[MerakiAuthUsersAuthorizationArgs]: User authorization info
created_at str: Creation time of the user
email str: Email address of the user
email_password_to_user bool: Whether or not Meraki should email the password to user. Default is false.
is_admin bool: Whether or not the user is a Dashboard administrator
meraki_auth_user_id str: merakiAuthUserId path parameter. Meraki auth user ID
name str: Name of the user
network_id str: networkId path parameter. Network ID
password str: The password for this user account. Only required If the user is not a Dashboard administrator.

accountType String: Authorization type for user.
authorizations List<Property Map>: User authorization info
createdAt String: Creation time of the user
email String: Email address of the user
emailPasswordToUser Boolean: Whether or not Meraki should email the password to user. Default is false.
isAdmin Boolean: Whether or not the user is a Dashboard administrator
merakiAuthUserId String: merakiAuthUserId path parameter. Meraki auth user ID
name String: Name of the user
networkId String: networkId path parameter. Network ID
password String: The password for this user account. Only required If the user is not a Dashboard administrator.

Supporting Types

MerakiAuthUsersAuthorization, MerakiAuthUsersAuthorizationArgs

AuthorizedByEmail string: User is authorized by the account email address
AuthorizedByName string: User is authorized by the account name
AuthorizedZone string: Authorized zone of the user
ExpiresAt string: Authorization expiration time
SsidNumber int: SSID number

AuthorizedByEmail string: User is authorized by the account email address
AuthorizedByName string: User is authorized by the account name
AuthorizedZone string: Authorized zone of the user
ExpiresAt string: Authorization expiration time
SsidNumber int: SSID number

authorizedByEmail String: User is authorized by the account email address
authorizedByName String: User is authorized by the account name
authorizedZone String: Authorized zone of the user
expiresAt String: Authorization expiration time
ssidNumber Integer: SSID number

authorizedByEmail string: User is authorized by the account email address
authorizedByName string: User is authorized by the account name
authorizedZone string: Authorized zone of the user
expiresAt string: Authorization expiration time
ssidNumber number: SSID number

authorized_by_email str: User is authorized by the account email address
authorized_by_name str: User is authorized by the account name
authorized_zone str: Authorized zone of the user
expires_at str: Authorization expiration time
ssid_number int: SSID number

authorizedByEmail String: User is authorized by the account email address
authorizedByName String: User is authorized by the account name
authorizedZone String: Authorized zone of the user
expiresAt String: Authorization expiration time
ssidNumber Number: SSID number

Import

$ pulumi import meraki:networks/merakiAuthUsers:MerakiAuthUsers example "meraki_auth_user_id,network_id"

To learn more about importing existing cloud resources, see Importing resources.

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.3.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.networks.MerakiAuthUsers

On this page

On this page

Example Usage

Create MerakiAuthUsers Resource

Constructor syntax

Parameters

Constructor example

MerakiAuthUsers Resource Properties

Inputs

Outputs

Look up Existing MerakiAuthUsers Resource

Supporting Types

MerakiAuthUsersAuthorization, MerakiAuthUsersAuthorizationArgs

Import

Package Details

On this page

On this page