1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. SamlRoles
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi

meraki.organizations.SamlRoles

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as meraki from "@pulumi/meraki";
    
    const example = new meraki.organizations.SamlRoles("example", {
        networks: [{
            access: "full",
            id: "N_24329156",
        }],
        orgAccess: "none",
        organizationId: "string",
        role: "myrole",
        tags: [{
            access: "read-only",
            tag: "west",
        }],
    });
    export const merakiOrganizationsSamlRolesExample = example;
    
    import pulumi
    import pulumi_meraki as meraki
    
    example = meraki.organizations.SamlRoles("example",
        networks=[meraki.organizations.SamlRolesNetworkArgs(
            access="full",
            id="N_24329156",
        )],
        org_access="none",
        organization_id="string",
        role="myrole",
        tags=[meraki.organizations.SamlRolesTagArgs(
            access="read-only",
            tag="west",
        )])
    pulumi.export("merakiOrganizationsSamlRolesExample", 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.NewSamlRoles(ctx, "example", &organizations.SamlRolesArgs{
    			Networks: organizations.SamlRolesNetworkArray{
    				&organizations.SamlRolesNetworkArgs{
    					Access: pulumi.String("full"),
    					Id:     pulumi.String("N_24329156"),
    				},
    			},
    			OrgAccess:      pulumi.String("none"),
    			OrganizationId: pulumi.String("string"),
    			Role:           pulumi.String("myrole"),
    			Tags: organizations.SamlRolesTagArray{
    				&organizations.SamlRolesTagArgs{
    					Access: pulumi.String("read-only"),
    					Tag:    pulumi.String("west"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("merakiOrganizationsSamlRolesExample", 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.SamlRoles("example", new()
        {
            Networks = new[]
            {
                new Meraki.Organizations.Inputs.SamlRolesNetworkArgs
                {
                    Access = "full",
                    Id = "N_24329156",
                },
            },
            OrgAccess = "none",
            OrganizationId = "string",
            Role = "myrole",
            Tags = new[]
            {
                new Meraki.Organizations.Inputs.SamlRolesTagArgs
                {
                    Access = "read-only",
                    Tag = "west",
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["merakiOrganizationsSamlRolesExample"] = example,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.SamlRoles;
    import com.pulumi.meraki.organizations.SamlRolesArgs;
    import com.pulumi.meraki.organizations.inputs.SamlRolesNetworkArgs;
    import com.pulumi.meraki.organizations.inputs.SamlRolesTagArgs;
    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 SamlRoles("example", SamlRolesArgs.builder()
                .networks(SamlRolesNetworkArgs.builder()
                    .access("full")
                    .id("N_24329156")
                    .build())
                .orgAccess("none")
                .organizationId("string")
                .role("myrole")
                .tags(SamlRolesTagArgs.builder()
                    .access("read-only")
                    .tag("west")
                    .build())
                .build());
    
            ctx.export("merakiOrganizationsSamlRolesExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:organizations:SamlRoles
        properties:
          networks:
            - access: full
              id: N_24329156
          orgAccess: none
          organizationId: string
          role: myrole
          tags:
            - access: read-only
              tag: west
    outputs:
      merakiOrganizationsSamlRolesExample: ${example}
    

    Create SamlRoles Resource

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

    Constructor syntax

    new SamlRoles(name: string, args: SamlRolesArgs, opts?: CustomResourceOptions);
    @overload
    def SamlRoles(resource_name: str,
                  args: SamlRolesArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def SamlRoles(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  organization_id: Optional[str] = None,
                  networks: Optional[Sequence[SamlRolesNetworkArgs]] = None,
                  org_access: Optional[str] = None,
                  role: Optional[str] = None,
                  saml_role_id: Optional[str] = None,
                  tags: Optional[Sequence[SamlRolesTagArgs]] = None)
    func NewSamlRoles(ctx *Context, name string, args SamlRolesArgs, opts ...ResourceOption) (*SamlRoles, error)
    public SamlRoles(string name, SamlRolesArgs args, CustomResourceOptions? opts = null)
    public SamlRoles(String name, SamlRolesArgs args)
    public SamlRoles(String name, SamlRolesArgs args, CustomResourceOptions options)
    
    type: meraki:organizations:SamlRoles
    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 SamlRolesArgs
    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 SamlRolesArgs
    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 SamlRolesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SamlRolesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SamlRolesArgs
    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 samlRolesResource = new Meraki.Organizations.SamlRoles("samlRolesResource", new()
    {
        OrganizationId = "string",
        Networks = new[]
        {
            new Meraki.Organizations.Inputs.SamlRolesNetworkArgs
            {
                Access = "string",
                Id = "string",
            },
        },
        OrgAccess = "string",
        Role = "string",
        SamlRoleId = "string",
        Tags = new[]
        {
            new Meraki.Organizations.Inputs.SamlRolesTagArgs
            {
                Access = "string",
                Tag = "string",
            },
        },
    });
    
    example, err := organizations.NewSamlRoles(ctx, "samlRolesResource", &organizations.SamlRolesArgs{
    	OrganizationId: pulumi.String("string"),
    	Networks: organizations.SamlRolesNetworkArray{
    		&organizations.SamlRolesNetworkArgs{
    			Access: pulumi.String("string"),
    			Id:     pulumi.String("string"),
    		},
    	},
    	OrgAccess:  pulumi.String("string"),
    	Role:       pulumi.String("string"),
    	SamlRoleId: pulumi.String("string"),
    	Tags: organizations.SamlRolesTagArray{
    		&organizations.SamlRolesTagArgs{
    			Access: pulumi.String("string"),
    			Tag:    pulumi.String("string"),
    		},
    	},
    })
    
    var samlRolesResource = new SamlRoles("samlRolesResource", SamlRolesArgs.builder()
        .organizationId("string")
        .networks(SamlRolesNetworkArgs.builder()
            .access("string")
            .id("string")
            .build())
        .orgAccess("string")
        .role("string")
        .samlRoleId("string")
        .tags(SamlRolesTagArgs.builder()
            .access("string")
            .tag("string")
            .build())
        .build());
    
    saml_roles_resource = meraki.organizations.SamlRoles("samlRolesResource",
        organization_id="string",
        networks=[meraki.organizations.SamlRolesNetworkArgs(
            access="string",
            id="string",
        )],
        org_access="string",
        role="string",
        saml_role_id="string",
        tags=[meraki.organizations.SamlRolesTagArgs(
            access="string",
            tag="string",
        )])
    
    const samlRolesResource = new meraki.organizations.SamlRoles("samlRolesResource", {
        organizationId: "string",
        networks: [{
            access: "string",
            id: "string",
        }],
        orgAccess: "string",
        role: "string",
        samlRoleId: "string",
        tags: [{
            access: "string",
            tag: "string",
        }],
    });
    
    type: meraki:organizations:SamlRoles
    properties:
        networks:
            - access: string
              id: string
        orgAccess: string
        organizationId: string
        role: string
        samlRoleId: string
        tags:
            - access: string
              tag: string
    

    SamlRoles 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 SamlRoles resource accepts the following input properties:

    OrganizationId string
    organizationId path parameter. Organization ID
    Networks List<SamlRolesNetwork>
    The list of networks that the SAML administrator has privileges on
    OrgAccess string
    The privilege of the SAML administrator on the organization
    Role string
    The role of the SAML administrator
    SamlRoleId string
    samlRoleId path parameter. Saml role ID
    Tags List<SamlRolesTag>
    The list of tags that the SAML administrator has privleges on
    OrganizationId string
    organizationId path parameter. Organization ID
    Networks []SamlRolesNetworkArgs
    The list of networks that the SAML administrator has privileges on
    OrgAccess string
    The privilege of the SAML administrator on the organization
    Role string
    The role of the SAML administrator
    SamlRoleId string
    samlRoleId path parameter. Saml role ID
    Tags []SamlRolesTagArgs
    The list of tags that the SAML administrator has privleges on
    organizationId String
    organizationId path parameter. Organization ID
    networks List<SamlRolesNetwork>
    The list of networks that the SAML administrator has privileges on
    orgAccess String
    The privilege of the SAML administrator on the organization
    role String
    The role of the SAML administrator
    samlRoleId String
    samlRoleId path parameter. Saml role ID
    tags List<SamlRolesTag>
    The list of tags that the SAML administrator has privleges on
    organizationId string
    organizationId path parameter. Organization ID
    networks SamlRolesNetwork[]
    The list of networks that the SAML administrator has privileges on
    orgAccess string
    The privilege of the SAML administrator on the organization
    role string
    The role of the SAML administrator
    samlRoleId string
    samlRoleId path parameter. Saml role ID
    tags SamlRolesTag[]
    The list of tags that the SAML administrator has privleges on
    organization_id str
    organizationId path parameter. Organization ID
    networks Sequence[SamlRolesNetworkArgs]
    The list of networks that the SAML administrator has privileges on
    org_access str
    The privilege of the SAML administrator on the organization
    role str
    The role of the SAML administrator
    saml_role_id str
    samlRoleId path parameter. Saml role ID
    tags Sequence[SamlRolesTagArgs]
    The list of tags that the SAML administrator has privleges on
    organizationId String
    organizationId path parameter. Organization ID
    networks List<Property Map>
    The list of networks that the SAML administrator has privileges on
    orgAccess String
    The privilege of the SAML administrator on the organization
    role String
    The role of the SAML administrator
    samlRoleId String
    samlRoleId path parameter. Saml role ID
    tags List<Property Map>
    The list of tags that the SAML administrator has privleges on

    Outputs

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

    Cameras List<SamlRolesCamera>
    The list of camera access privileges for SAML administrator
    Id string
    The provider-assigned unique ID for this managed resource.
    Cameras []SamlRolesCamera
    The list of camera access privileges for SAML administrator
    Id string
    The provider-assigned unique ID for this managed resource.
    cameras List<SamlRolesCamera>
    The list of camera access privileges for SAML administrator
    id String
    The provider-assigned unique ID for this managed resource.
    cameras SamlRolesCamera[]
    The list of camera access privileges for SAML administrator
    id string
    The provider-assigned unique ID for this managed resource.
    cameras Sequence[SamlRolesCamera]
    The list of camera access privileges for SAML administrator
    id str
    The provider-assigned unique ID for this managed resource.
    cameras List<Property Map>
    The list of camera access privileges for SAML administrator
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SamlRoles Resource

    Get an existing SamlRoles 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?: SamlRolesState, opts?: CustomResourceOptions): SamlRoles
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cameras: Optional[Sequence[SamlRolesCameraArgs]] = None,
            networks: Optional[Sequence[SamlRolesNetworkArgs]] = None,
            org_access: Optional[str] = None,
            organization_id: Optional[str] = None,
            role: Optional[str] = None,
            saml_role_id: Optional[str] = None,
            tags: Optional[Sequence[SamlRolesTagArgs]] = None) -> SamlRoles
    func GetSamlRoles(ctx *Context, name string, id IDInput, state *SamlRolesState, opts ...ResourceOption) (*SamlRoles, error)
    public static SamlRoles Get(string name, Input<string> id, SamlRolesState? state, CustomResourceOptions? opts = null)
    public static SamlRoles get(String name, Output<String> id, SamlRolesState 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:
    Cameras List<SamlRolesCamera>
    The list of camera access privileges for SAML administrator
    Networks List<SamlRolesNetwork>
    The list of networks that the SAML administrator has privileges on
    OrgAccess string
    The privilege of the SAML administrator on the organization
    OrganizationId string
    organizationId path parameter. Organization ID
    Role string
    The role of the SAML administrator
    SamlRoleId string
    samlRoleId path parameter. Saml role ID
    Tags List<SamlRolesTag>
    The list of tags that the SAML administrator has privleges on
    Cameras []SamlRolesCameraArgs
    The list of camera access privileges for SAML administrator
    Networks []SamlRolesNetworkArgs
    The list of networks that the SAML administrator has privileges on
    OrgAccess string
    The privilege of the SAML administrator on the organization
    OrganizationId string
    organizationId path parameter. Organization ID
    Role string
    The role of the SAML administrator
    SamlRoleId string
    samlRoleId path parameter. Saml role ID
    Tags []SamlRolesTagArgs
    The list of tags that the SAML administrator has privleges on
    cameras List<SamlRolesCamera>
    The list of camera access privileges for SAML administrator
    networks List<SamlRolesNetwork>
    The list of networks that the SAML administrator has privileges on
    orgAccess String
    The privilege of the SAML administrator on the organization
    organizationId String
    organizationId path parameter. Organization ID
    role String
    The role of the SAML administrator
    samlRoleId String
    samlRoleId path parameter. Saml role ID
    tags List<SamlRolesTag>
    The list of tags that the SAML administrator has privleges on
    cameras SamlRolesCamera[]
    The list of camera access privileges for SAML administrator
    networks SamlRolesNetwork[]
    The list of networks that the SAML administrator has privileges on
    orgAccess string
    The privilege of the SAML administrator on the organization
    organizationId string
    organizationId path parameter. Organization ID
    role string
    The role of the SAML administrator
    samlRoleId string
    samlRoleId path parameter. Saml role ID
    tags SamlRolesTag[]
    The list of tags that the SAML administrator has privleges on
    cameras Sequence[SamlRolesCameraArgs]
    The list of camera access privileges for SAML administrator
    networks Sequence[SamlRolesNetworkArgs]
    The list of networks that the SAML administrator has privileges on
    org_access str
    The privilege of the SAML administrator on the organization
    organization_id str
    organizationId path parameter. Organization ID
    role str
    The role of the SAML administrator
    saml_role_id str
    samlRoleId path parameter. Saml role ID
    tags Sequence[SamlRolesTagArgs]
    The list of tags that the SAML administrator has privleges on
    cameras List<Property Map>
    The list of camera access privileges for SAML administrator
    networks List<Property Map>
    The list of networks that the SAML administrator has privileges on
    orgAccess String
    The privilege of the SAML administrator on the organization
    organizationId String
    organizationId path parameter. Organization ID
    role String
    The role of the SAML administrator
    samlRoleId String
    samlRoleId path parameter. Saml role ID
    tags List<Property Map>
    The list of tags that the SAML administrator has privleges on

    Supporting Types

    SamlRolesCamera, SamlRolesCameraArgs

    Access string
    Camera access ability
    OrgWide bool
    Whether or not SAML administrator has org-wide access
    Access string
    Camera access ability
    OrgWide bool
    Whether or not SAML administrator has org-wide access
    access String
    Camera access ability
    orgWide Boolean
    Whether or not SAML administrator has org-wide access
    access string
    Camera access ability
    orgWide boolean
    Whether or not SAML administrator has org-wide access
    access str
    Camera access ability
    org_wide bool
    Whether or not SAML administrator has org-wide access
    access String
    Camera access ability
    orgWide Boolean
    Whether or not SAML administrator has org-wide access

    SamlRolesNetwork, SamlRolesNetworkArgs

    Access string
    The privilege of the SAML administrator on the network
    Id string
    The network ID
    Access string
    The privilege of the SAML administrator on the network
    Id string
    The network ID
    access String
    The privilege of the SAML administrator on the network
    id String
    The network ID
    access string
    The privilege of the SAML administrator on the network
    id string
    The network ID
    access str
    The privilege of the SAML administrator on the network
    id str
    The network ID
    access String
    The privilege of the SAML administrator on the network
    id String
    The network ID

    SamlRolesTag, SamlRolesTagArgs

    Access string
    The privilege of the SAML administrator on the tag
    Tag string
    The name of the tag
    Access string
    The privilege of the SAML administrator on the tag
    Tag string
    The name of the tag
    access String
    The privilege of the SAML administrator on the tag
    tag String
    The name of the tag
    access string
    The privilege of the SAML administrator on the tag
    tag string
    The name of the tag
    access str
    The privilege of the SAML administrator on the tag
    tag str
    The name of the tag
    access String
    The privilege of the SAML administrator on the tag
    tag String
    The name of the tag

    Import

    $ pulumi import meraki:organizations/samlRoles:SamlRoles example "organization_id,saml_role_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
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi