onelogin

v0.3.0 published on Wednesday, Jun 1, 2022 by Pulumi

Role

Manage Role resources.

This resource allows you to create and configure Roles.

Example Usage

Strict Ordering

using Pulumi;
using Onelogin = Pulumi.Onelogin;

class MyStack : Stack
{
    public MyStack()
    {
        var executiveAdmin = new Onelogin.Role("executiveAdmin", new Onelogin.RoleArgs
        {
            Admins = 
            {
                777,
            },
            Apps = 
            {
                123,
                456,
                787,
            },
            Users = 
            {
                543,
                213,
                420,
            },
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := onelogin.NewRole(ctx, "executiveAdmin", &onelogin.RoleArgs{
			Admins: pulumi.IntArray{
				pulumi.Int(777),
			},
			Apps: pulumi.IntArray{
				pulumi.Int(123),
				pulumi.Int(456),
				pulumi.Int(787),
			},
			Users: pulumi.IntArray{
				pulumi.Int(543),
				pulumi.Int(213),
				pulumi.Int(420),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_onelogin as onelogin

executive_admin = onelogin.Role("executiveAdmin",
    admins=[777],
    apps=[
        123,
        456,
        787,
    ],
    users=[
        543,
        213,
        420,
    ])
import * as pulumi from "@pulumi/pulumi";
import * as onelogin from "@pulumi/onelogin";

const executiveAdmin = new onelogin.Role("executive_admin", {
    admins: [777],
    apps: [
        123,
        456,
        787,
    ],
    users: [
        543,
        213,
        420,
    ],
});

Coming soon!

Create Role Resource

new Role(name: string, args?: RoleArgs, opts?: CustomResourceOptions);
@overload
def Role(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         admins: Optional[Sequence[int]] = None,
         apps: Optional[Sequence[int]] = None,
         name: Optional[str] = None,
         users: Optional[Sequence[int]] = None)
@overload
def Role(resource_name: str,
         args: Optional[RoleArgs] = None,
         opts: Optional[ResourceOptions] = None)
func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
public Role(String name, RoleArgs args)
public Role(String name, RoleArgs args, CustomResourceOptions options)
type: onelogin:Role
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args RoleArgs
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 RoleArgs
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 RoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args RoleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Admins List<int>

A list of IDs of users who administer the role.

Apps List<int>

A list of app IDs for which the role applies.

Name string

The name of the role.

Users List<int>

A list of user IDs for whom the role applies.

Admins []int

A list of IDs of users who administer the role.

Apps []int

A list of app IDs for which the role applies.

Name string

The name of the role.

Users []int

A list of user IDs for whom the role applies.

admins List<Integer>

A list of IDs of users who administer the role.

apps List<Integer>

A list of app IDs for which the role applies.

name String

The name of the role.

users List<Integer>

A list of user IDs for whom the role applies.

admins number[]

A list of IDs of users who administer the role.

apps number[]

A list of app IDs for which the role applies.

name string

The name of the role.

users number[]

A list of user IDs for whom the role applies.

admins Sequence[int]

A list of IDs of users who administer the role.

apps Sequence[int]

A list of app IDs for which the role applies.

name str

The name of the role.

users Sequence[int]

A list of user IDs for whom the role applies.

admins List<Number>

A list of IDs of users who administer the role.

apps List<Number>

A list of app IDs for which the role applies.

name String

The name of the role.

users List<Number>

A list of user IDs for whom the role applies.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Role Resource

Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admins: Optional[Sequence[int]] = None,
        apps: Optional[Sequence[int]] = None,
        name: Optional[str] = None,
        users: Optional[Sequence[int]] = None) -> Role
func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
public static Role get(String name, Output<String> id, RoleState 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:
Admins List<int>

A list of IDs of users who administer the role.

Apps List<int>

A list of app IDs for which the role applies.

Name string

The name of the role.

Users List<int>

A list of user IDs for whom the role applies.

Admins []int

A list of IDs of users who administer the role.

Apps []int

A list of app IDs for which the role applies.

Name string

The name of the role.

Users []int

A list of user IDs for whom the role applies.

admins List<Integer>

A list of IDs of users who administer the role.

apps List<Integer>

A list of app IDs for which the role applies.

name String

The name of the role.

users List<Integer>

A list of user IDs for whom the role applies.

admins number[]

A list of IDs of users who administer the role.

apps number[]

A list of app IDs for which the role applies.

name string

The name of the role.

users number[]

A list of user IDs for whom the role applies.

admins Sequence[int]

A list of IDs of users who administer the role.

apps Sequence[int]

A list of app IDs for which the role applies.

name str

The name of the role.

users Sequence[int]

A list of user IDs for whom the role applies.

admins List<Number>

A list of IDs of users who administer the role.

apps List<Number>

A list of app IDs for which the role applies.

name String

The name of the role.

users List<Number>

A list of user IDs for whom the role applies.

Import

A role can be imported using the OneLogin Role ID.

 $ pulumi import onelogin:index/role:Role executive_admin <role id>

Package Details

Repository
https://github.com/pulumi/pulumi-onelogin
License
Apache-2.0
Notes

This Pulumi package is based on the onelogin Terraform Provider.