1. Packages
  2. Meraki
  3. API Docs
  4. organizations
  5. Admins
Meraki v0.1.1 published on Thursday, May 16, 2024 by Pulumi

meraki.organizations.Admins

Explore with Pulumi AI

meraki logo
Meraki v0.1.1 published on Thursday, May 16, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.organizations.Admins("example", {
        authenticationMethod: "Email",
        email: "miles@meraki.com",
        name: "Miles Meraki",
        networks: [{
            access: "full",
            id: "N_24329156",
        }],
        orgAccess: "none",
        organizationId: "string",
        tags: [{
            access: "read-only",
            tag: "west",
        }],
    });
    export const merakiOrganizationsAdminsExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.Admins("example",
        authentication_method="Email",
        email="miles@meraki.com",
        name="Miles Meraki",
        networks=[meraki.organizations.AdminsNetworkArgs(
            access="full",
            id="N_24329156",
        )],
        org_access="none",
        organization_id="string",
        tags=[meraki.organizations.AdminsTagArgs(
            access="read-only",
            tag="west",
        )])
    pulumi.export("merakiOrganizationsAdminsExample", example)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := organizations.NewAdmins(ctx, "example", &organizations.AdminsArgs{
    			AuthenticationMethod: pulumi.String("Email"),
    			Email:                pulumi.String("miles@meraki.com"),
    			Name:                 pulumi.String("Miles Meraki"),
    			Networks: organizations.AdminsNetworkArray{
    				&organizations.AdminsNetworkArgs{
    					Access: pulumi.String("full"),
    					Id:     pulumi.String("N_24329156"),
    				},
    			},
    			OrgAccess:      pulumi.String("none"),
    			OrganizationId: pulumi.String("string"),
    			Tags: organizations.AdminsTagArray{
    				&organizations.AdminsTagArgs{
    					Access: pulumi.String("read-only"),
    					Tag:    pulumi.String("west"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsAdminsExample", example)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Meraki = Pulumi.Meraki;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Meraki.Organizations.Admins("example", new()
        {
            AuthenticationMethod = "Email",
            Email = "miles@meraki.com",
            Name = "Miles Meraki",
            Networks = new[]
            {
                new Meraki.Organizations.Inputs.AdminsNetworkArgs
                {
                    Access = "full",
                    Id = "N_24329156",
                },
            },
            OrgAccess = "none",
            OrganizationId = "string",
            Tags = new[]
            {
                new Meraki.Organizations.Inputs.AdminsTagArgs
                {
                    Access = "read-only",
                    Tag = "west",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsAdminsExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.Admins;
    import com.pulumi.meraki.organizations.AdminsArgs;
    import com.pulumi.meraki.organizations.inputs.AdminsNetworkArgs;
    import com.pulumi.meraki.organizations.inputs.AdminsTagArgs;
    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 Admins("example", AdminsArgs.builder()        
                .authenticationMethod("Email")
                .email("miles@meraki.com")
                .name("Miles Meraki")
                .networks(AdminsNetworkArgs.builder()
                    .access("full")
                    .id("N_24329156")
                    .build())
                .orgAccess("none")
                .organizationId("string")
                .tags(AdminsTagArgs.builder()
                    .access("read-only")
                    .tag("west")
                    .build())
                .build());
    
            ctx.export("merakiOrganizationsAdminsExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:organizations:Admins
        properties:
          authenticationMethod: Email
          email: miles@meraki.com
          name: Miles Meraki
          networks:
            - access: full
              id: N_24329156
          orgAccess: none
          organizationId: string
          tags:
            - access: read-only
              tag: west
    outputs:
      merakiOrganizationsAdminsExample: ${example}
    

    Create Admins Resource

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

    Constructor syntax

    new Admins(name: string, args: AdminsArgs, opts?: CustomResourceOptions);
    @overload
    def Admins(resource_name: str,
               args: AdminsArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Admins(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               organization_id: Optional[str] = None,
               admin_id: Optional[str] = None,
               authentication_method: Optional[str] = None,
               email: Optional[str] = None,
               name: Optional[str] = None,
               networks: Optional[Sequence[AdminsNetworkArgs]] = None,
               org_access: Optional[str] = None,
               tags: Optional[Sequence[AdminsTagArgs]] = None)
    func NewAdmins(ctx *Context, name string, args AdminsArgs, opts ...ResourceOption) (*Admins, error)
    public Admins(string name, AdminsArgs args, CustomResourceOptions? opts = null)
    public Admins(String name, AdminsArgs args)
    public Admins(String name, AdminsArgs args, CustomResourceOptions options)
    
    type: meraki:organizations:Admins
    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 AdminsArgs
    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 AdminsArgs
    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 AdminsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AdminsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AdminsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var adminsResource = new Meraki.Organizations.Admins("adminsResource", new()
    {
        OrganizationId = "string",
        AdminId = "string",
        AuthenticationMethod = "string",
        Email = "string",
        Name = "string",
        Networks = new[]
        {
            new Meraki.Organizations.Inputs.AdminsNetworkArgs
            {
                Access = "string",
                Id = "string",
            },
        },
        OrgAccess = "string",
        Tags = new[]
        {
            new Meraki.Organizations.Inputs.AdminsTagArgs
            {
                Access = "string",
                Tag = "string",
            },
        },
    });
    
    example, err := organizations.NewAdmins(ctx, "adminsResource", &organizations.AdminsArgs{
    	OrganizationId:       pulumi.String("string"),
    	AdminId:              pulumi.String("string"),
    	AuthenticationMethod: pulumi.String("string"),
    	Email:                pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	Networks: organizations.AdminsNetworkArray{
    		&organizations.AdminsNetworkArgs{
    			Access: pulumi.String("string"),
    			Id:     pulumi.String("string"),
    		},
    	},
    	OrgAccess: pulumi.String("string"),
    	Tags: organizations.AdminsTagArray{
    		&organizations.AdminsTagArgs{
    			Access: pulumi.String("string"),
    			Tag:    pulumi.String("string"),
    		},
    	},
    })
    
    var adminsResource = new Admins("adminsResource", AdminsArgs.builder()        
        .organizationId("string")
        .adminId("string")
        .authenticationMethod("string")
        .email("string")
        .name("string")
        .networks(AdminsNetworkArgs.builder()
            .access("string")
            .id("string")
            .build())
        .orgAccess("string")
        .tags(AdminsTagArgs.builder()
            .access("string")
            .tag("string")
            .build())
        .build());
    
    admins_resource = meraki.organizations.Admins("adminsResource",
        organization_id="string",
        admin_id="string",
        authentication_method="string",
        email="string",
        name="string",
        networks=[meraki.organizations.AdminsNetworkArgs(
            access="string",
            id="string",
        )],
        org_access="string",
        tags=[meraki.organizations.AdminsTagArgs(
            access="string",
            tag="string",
        )])
    
    const adminsResource = new meraki.organizations.Admins("adminsResource", {
        organizationId: "string",
        adminId: "string",
        authenticationMethod: "string",
        email: "string",
        name: "string",
        networks: [{
            access: "string",
            id: "string",
        }],
        orgAccess: "string",
        tags: [{
            access: "string",
            tag: "string",
        }],
    });
    
    type: meraki:organizations:Admins
    properties:
        adminId: string
        authenticationMethod: string
        email: string
        name: string
        networks:
            - access: string
              id: string
        orgAccess: string
        organizationId: string
        tags:
            - access: string
              tag: string
    

    Admins Resource Properties

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

    Inputs

    The Admins resource accepts the following input properties:

    OrganizationId string
    organizationId path parameter. Organization ID
    AdminId string
    adminId path parameter. Admin ID
    AuthenticationMethod string
    Admin's authentication method
    Email string
    Admin's email address
    Name string
    Admin's username
    Networks List<AdminsNetwork>
    Admin network access information
    OrgAccess string
    Admin's level of access to the organization
    Tags List<AdminsTag>
    Admin tag information
    OrganizationId string
    organizationId path parameter. Organization ID
    AdminId string
    adminId path parameter. Admin ID
    AuthenticationMethod string
    Admin's authentication method
    Email string
    Admin's email address
    Name string
    Admin's username
    Networks []AdminsNetworkArgs
    Admin network access information
    OrgAccess string
    Admin's level of access to the organization
    Tags []AdminsTagArgs
    Admin tag information
    organizationId String
    organizationId path parameter. Organization ID
    adminId String
    adminId path parameter. Admin ID
    authenticationMethod String
    Admin's authentication method
    email String
    Admin's email address
    name String
    Admin's username
    networks List<AdminsNetwork>
    Admin network access information
    orgAccess String
    Admin's level of access to the organization
    tags List<AdminsTag>
    Admin tag information
    organizationId string
    organizationId path parameter. Organization ID
    adminId string
    adminId path parameter. Admin ID
    authenticationMethod string
    Admin's authentication method
    email string
    Admin's email address
    name string
    Admin's username
    networks AdminsNetwork[]
    Admin network access information
    orgAccess string
    Admin's level of access to the organization
    tags AdminsTag[]
    Admin tag information
    organization_id str
    organizationId path parameter. Organization ID
    admin_id str
    adminId path parameter. Admin ID
    authentication_method str
    Admin's authentication method
    email str
    Admin's email address
    name str
    Admin's username
    networks Sequence[AdminsNetworkArgs]
    Admin network access information
    org_access str
    Admin's level of access to the organization
    tags Sequence[AdminsTagArgs]
    Admin tag information
    organizationId String
    organizationId path parameter. Organization ID
    adminId String
    adminId path parameter. Admin ID
    authenticationMethod String
    Admin's authentication method
    email String
    Admin's email address
    name String
    Admin's username
    networks List<Property Map>
    Admin network access information
    orgAccess String
    Admin's level of access to the organization
    tags List<Property Map>
    Admin tag information

    Outputs

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

    AccountStatus string
    Status of the admin's account
    HasApiKey bool
    Indicates whether the admin has an API key
    Id string
    The provider-assigned unique ID for this managed resource.
    LastActive string
    Time when the admin was last active
    TwoFactorAuthEnabled bool
    Indicates whether two-factor authentication is enabled
    AccountStatus string
    Status of the admin's account
    HasApiKey bool
    Indicates whether the admin has an API key
    Id string
    The provider-assigned unique ID for this managed resource.
    LastActive string
    Time when the admin was last active
    TwoFactorAuthEnabled bool
    Indicates whether two-factor authentication is enabled
    accountStatus String
    Status of the admin's account
    hasApiKey Boolean
    Indicates whether the admin has an API key
    id String
    The provider-assigned unique ID for this managed resource.
    lastActive String
    Time when the admin was last active
    twoFactorAuthEnabled Boolean
    Indicates whether two-factor authentication is enabled
    accountStatus string
    Status of the admin's account
    hasApiKey boolean
    Indicates whether the admin has an API key
    id string
    The provider-assigned unique ID for this managed resource.
    lastActive string
    Time when the admin was last active
    twoFactorAuthEnabled boolean
    Indicates whether two-factor authentication is enabled
    account_status str
    Status of the admin's account
    has_api_key bool
    Indicates whether the admin has an API key
    id str
    The provider-assigned unique ID for this managed resource.
    last_active str
    Time when the admin was last active
    two_factor_auth_enabled bool
    Indicates whether two-factor authentication is enabled
    accountStatus String
    Status of the admin's account
    hasApiKey Boolean
    Indicates whether the admin has an API key
    id String
    The provider-assigned unique ID for this managed resource.
    lastActive String
    Time when the admin was last active
    twoFactorAuthEnabled Boolean
    Indicates whether two-factor authentication is enabled

    Look up Existing Admins Resource

    Get an existing Admins 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?: AdminsState, opts?: CustomResourceOptions): Admins
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_status: Optional[str] = None,
            admin_id: Optional[str] = None,
            authentication_method: Optional[str] = None,
            email: Optional[str] = None,
            has_api_key: Optional[bool] = None,
            last_active: Optional[str] = None,
            name: Optional[str] = None,
            networks: Optional[Sequence[AdminsNetworkArgs]] = None,
            org_access: Optional[str] = None,
            organization_id: Optional[str] = None,
            tags: Optional[Sequence[AdminsTagArgs]] = None,
            two_factor_auth_enabled: Optional[bool] = None) -> Admins
    func GetAdmins(ctx *Context, name string, id IDInput, state *AdminsState, opts ...ResourceOption) (*Admins, error)
    public static Admins Get(string name, Input<string> id, AdminsState? state, CustomResourceOptions? opts = null)
    public static Admins get(String name, Output<String> id, AdminsState 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:
    AccountStatus string
    Status of the admin's account
    AdminId string
    adminId path parameter. Admin ID
    AuthenticationMethod string
    Admin's authentication method
    Email string
    Admin's email address
    HasApiKey bool
    Indicates whether the admin has an API key
    LastActive string
    Time when the admin was last active
    Name string
    Admin's username
    Networks List<AdminsNetwork>
    Admin network access information
    OrgAccess string
    Admin's level of access to the organization
    OrganizationId string
    organizationId path parameter. Organization ID
    Tags List<AdminsTag>
    Admin tag information
    TwoFactorAuthEnabled bool
    Indicates whether two-factor authentication is enabled
    AccountStatus string
    Status of the admin's account
    AdminId string
    adminId path parameter. Admin ID
    AuthenticationMethod string
    Admin's authentication method
    Email string
    Admin's email address
    HasApiKey bool
    Indicates whether the admin has an API key
    LastActive string
    Time when the admin was last active
    Name string
    Admin's username
    Networks []AdminsNetworkArgs
    Admin network access information
    OrgAccess string
    Admin's level of access to the organization
    OrganizationId string
    organizationId path parameter. Organization ID
    Tags []AdminsTagArgs
    Admin tag information
    TwoFactorAuthEnabled bool
    Indicates whether two-factor authentication is enabled
    accountStatus String
    Status of the admin's account
    adminId String
    adminId path parameter. Admin ID
    authenticationMethod String
    Admin's authentication method
    email String
    Admin's email address
    hasApiKey Boolean
    Indicates whether the admin has an API key
    lastActive String
    Time when the admin was last active
    name String
    Admin's username
    networks List<AdminsNetwork>
    Admin network access information
    orgAccess String
    Admin's level of access to the organization
    organizationId String
    organizationId path parameter. Organization ID
    tags List<AdminsTag>
    Admin tag information
    twoFactorAuthEnabled Boolean
    Indicates whether two-factor authentication is enabled
    accountStatus string
    Status of the admin's account
    adminId string
    adminId path parameter. Admin ID
    authenticationMethod string
    Admin's authentication method
    email string
    Admin's email address
    hasApiKey boolean
    Indicates whether the admin has an API key
    lastActive string
    Time when the admin was last active
    name string
    Admin's username
    networks AdminsNetwork[]
    Admin network access information
    orgAccess string
    Admin's level of access to the organization
    organizationId string
    organizationId path parameter. Organization ID
    tags AdminsTag[]
    Admin tag information
    twoFactorAuthEnabled boolean
    Indicates whether two-factor authentication is enabled
    account_status str
    Status of the admin's account
    admin_id str
    adminId path parameter. Admin ID
    authentication_method str
    Admin's authentication method
    email str
    Admin's email address
    has_api_key bool
    Indicates whether the admin has an API key
    last_active str
    Time when the admin was last active
    name str
    Admin's username
    networks Sequence[AdminsNetworkArgs]
    Admin network access information
    org_access str
    Admin's level of access to the organization
    organization_id str
    organizationId path parameter. Organization ID
    tags Sequence[AdminsTagArgs]
    Admin tag information
    two_factor_auth_enabled bool
    Indicates whether two-factor authentication is enabled
    accountStatus String
    Status of the admin's account
    adminId String
    adminId path parameter. Admin ID
    authenticationMethod String
    Admin's authentication method
    email String
    Admin's email address
    hasApiKey Boolean
    Indicates whether the admin has an API key
    lastActive String
    Time when the admin was last active
    name String
    Admin's username
    networks List<Property Map>
    Admin network access information
    orgAccess String
    Admin's level of access to the organization
    organizationId String
    organizationId path parameter. Organization ID
    tags List<Property Map>
    Admin tag information
    twoFactorAuthEnabled Boolean
    Indicates whether two-factor authentication is enabled

    Supporting Types

    AdminsNetwork, AdminsNetworkArgs

    Access string
    Admin's level of access to the network
    Id string
    Network ID
    Access string
    Admin's level of access to the network
    Id string
    Network ID
    access String
    Admin's level of access to the network
    id String
    Network ID
    access string
    Admin's level of access to the network
    id string
    Network ID
    access str
    Admin's level of access to the network
    id str
    Network ID
    access String
    Admin's level of access to the network
    id String
    Network ID

    AdminsTag, AdminsTagArgs

    Access string
    Access level for the tag
    Tag string
    Tag value
    Access string
    Access level for the tag
    Tag string
    Tag value
    access String
    Access level for the tag
    tag String
    Tag value
    access string
    Access level for the tag
    tag string
    Tag value
    access str
    Access level for the tag
    tag str
    Tag value
    access String
    Access level for the tag
    tag String
    Tag value

    Import

    $ pulumi import meraki:organizations/admins:Admins example "organization_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.
    meraki logo
    Meraki v0.1.1 published on Thursday, May 16, 2024 by Pulumi