Docs Packages
  1. Packages
  2. onelogin
  3. API Docs
  4. Privileges
onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-onelogin

onelogin.Privileges

Explore with Pulumi AI

onelogin logo
onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-onelogin

    Create Privileges Resource

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

    Constructor syntax

    new Privileges(name: string, args: PrivilegesArgs, opts?: CustomResourceOptions);
    @overload
def Privileges(resource_name: str,
               args: PrivilegesArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Privileges(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               privilege: Optional[PrivilegesPrivilegeArgs] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
    func NewPrivileges(ctx *Context, name string, args PrivilegesArgs, opts ...ResourceOption) (*Privileges, error)
    public Privileges(string name, PrivilegesArgs args, CustomResourceOptions? opts = null)
    public Privileges(String name, PrivilegesArgs args)
public Privileges(String name, PrivilegesArgs args, CustomResourceOptions options)

    type: onelogin:Privileges
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 PrivilegesArgs
    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 PrivilegesArgs
    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 PrivilegesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivilegesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivilegesArgs
    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 privilegesResource = new Onelogin.Privileges("privilegesResource", new()
{
    Privilege = new Onelogin.Inputs.PrivilegesPrivilegeArgs
    {
        Statements = new[]
        {
            new Onelogin.Inputs.PrivilegesPrivilegeStatementArgs
            {
                Actions = new[]
                {
                    "string",
                },
                Effect = "string",
                Scopes = new[]
                {
                    "string",
                },
            },
        },
        Version = "string",
    },
    Description = "string",
    Name = "string",
});

    example, err := onelogin.NewPrivileges(ctx, "privilegesResource", &onelogin.PrivilegesArgs{
	Privilege: &onelogin.PrivilegesPrivilegeArgs{
		Statements: onelogin.PrivilegesPrivilegeStatementArray{
			&onelogin.PrivilegesPrivilegeStatementArgs{
				Actions: pulumi.StringArray{
					pulumi.String("string"),
				},
				Effect: pulumi.String("string"),
				Scopes: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
		Version: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var privilegesResource = new Privileges("privilegesResource", PrivilegesArgs.builder()
    .privilege(PrivilegesPrivilegeArgs.builder()
        .statements(PrivilegesPrivilegeStatementArgs.builder()
            .actions("string")
            .effect("string")
            .scopes("string")
            .build())
        .version("string")
        .build())
    .description("string")
    .name("string")
    .build());

    privileges_resource = onelogin.Privileges("privilegesResource",
    privilege=onelogin.PrivilegesPrivilegeArgs(
        statements=[onelogin.PrivilegesPrivilegeStatementArgs(
            actions=["string"],
            effect="string",
            scopes=["string"],
        )],
        version="string",
    ),
    description="string",
    name="string")

    const privilegesResource = new onelogin.Privileges("privilegesResource", {
    privilege: {
        statements: [{
            actions: ["string"],
            effect: "string",
            scopes: ["string"],
        }],
        version: "string",
    },
    description: "string",
    name: "string",
});

    type: onelogin:Privileges
properties:
    description: string
    name: string
    privilege:
        statements:
            - actions:
                - string
              effect: string
              scopes:
                - string
        version: string

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Privileges 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 Privileges Resource

    Get an existing Privileges 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?: PrivilegesState, opts?: CustomResourceOptions): Privileges
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        privilege: Optional[PrivilegesPrivilegeArgs] = None) -> Privileges
    func GetPrivileges(ctx *Context, name string, id IDInput, state *PrivilegesState, opts ...ResourceOption) (*Privileges, error)
    public static Privileges Get(string name, Input<string> id, PrivilegesState? state, CustomResourceOptions? opts = null)
    public static Privileges get(String name, Output<String> id, PrivilegesState 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.

    Supporting Types

    PrivilegesPrivilege, PrivilegesPrivilegeArgs

    PrivilegesPrivilegeStatement, PrivilegesPrivilegeStatementArgs

    Actions List<string>
    An array of strings that represent actions within OneLogin. Actions are prefixed with the class of object they are related to and followed by a specific action for the given class. e.g. users:List, where the class is users and the specific action is List. Don’t mix classes within an Action array. To create a privilege that includes multiple different classes, create multiple statements. A wildcard * that includes all actions is supported. Use wildcards to create a Super User privilege.
    Effect string
    Set to “Allow.” By default, all actions are denied, this Statement allows the listed actions to be executed.
    Scopes List<string>
    Target the privileged action against specific resources with the scope. The scope pattern is the class of object used by the Action, followed by an ID that represents a resource in OneLogin. e.g. apps/1234, where apps is the class and 1234 is the ID of an app. The wildcard * is supported and indicates that all resources of the class type declared, in the Action, are in scope. The Action and Scope classes must match. However, there is an exception, a scope of roles/{role_id} can be combined with Actions on the user or app class. The exception allows you to target groups of users or apps with specific actions.
    Actions []string
    An array of strings that represent actions within OneLogin. Actions are prefixed with the class of object they are related to and followed by a specific action for the given class. e.g. users:List, where the class is users and the specific action is List. Don’t mix classes within an Action array. To create a privilege that includes multiple different classes, create multiple statements. A wildcard * that includes all actions is supported. Use wildcards to create a Super User privilege.
    Effect string
    Set to “Allow.” By default, all actions are denied, this Statement allows the listed actions to be executed.
    Scopes []string
    Target the privileged action against specific resources with the scope. The scope pattern is the class of object used by the Action, followed by an ID that represents a resource in OneLogin. e.g. apps/1234, where apps is the class and 1234 is the ID of an app. The wildcard * is supported and indicates that all resources of the class type declared, in the Action, are in scope. The Action and Scope classes must match. However, there is an exception, a scope of roles/{role_id} can be combined with Actions on the user or app class. The exception allows you to target groups of users or apps with specific actions.
    actions List<String>
    An array of strings that represent actions within OneLogin. Actions are prefixed with the class of object they are related to and followed by a specific action for the given class. e.g. users:List, where the class is users and the specific action is List. Don’t mix classes within an Action array. To create a privilege that includes multiple different classes, create multiple statements. A wildcard * that includes all actions is supported. Use wildcards to create a Super User privilege.
    effect String
    Set to “Allow.” By default, all actions are denied, this Statement allows the listed actions to be executed.
    scopes List<String>
    Target the privileged action against specific resources with the scope. The scope pattern is the class of object used by the Action, followed by an ID that represents a resource in OneLogin. e.g. apps/1234, where apps is the class and 1234 is the ID of an app. The wildcard * is supported and indicates that all resources of the class type declared, in the Action, are in scope. The Action and Scope classes must match. However, there is an exception, a scope of roles/{role_id} can be combined with Actions on the user or app class. The exception allows you to target groups of users or apps with specific actions.
    actions string[]
    An array of strings that represent actions within OneLogin. Actions are prefixed with the class of object they are related to and followed by a specific action for the given class. e.g. users:List, where the class is users and the specific action is List. Don’t mix classes within an Action array. To create a privilege that includes multiple different classes, create multiple statements. A wildcard * that includes all actions is supported. Use wildcards to create a Super User privilege.
    effect string
    Set to “Allow.” By default, all actions are denied, this Statement allows the listed actions to be executed.
    scopes string[]
    Target the privileged action against specific resources with the scope. The scope pattern is the class of object used by the Action, followed by an ID that represents a resource in OneLogin. e.g. apps/1234, where apps is the class and 1234 is the ID of an app. The wildcard * is supported and indicates that all resources of the class type declared, in the Action, are in scope. The Action and Scope classes must match. However, there is an exception, a scope of roles/{role_id} can be combined with Actions on the user or app class. The exception allows you to target groups of users or apps with specific actions.
    actions Sequence[str]
    An array of strings that represent actions within OneLogin. Actions are prefixed with the class of object they are related to and followed by a specific action for the given class. e.g. users:List, where the class is users and the specific action is List. Don’t mix classes within an Action array. To create a privilege that includes multiple different classes, create multiple statements. A wildcard * that includes all actions is supported. Use wildcards to create a Super User privilege.
    effect str
    Set to “Allow.” By default, all actions are denied, this Statement allows the listed actions to be executed.
    scopes Sequence[str]
    Target the privileged action against specific resources with the scope. The scope pattern is the class of object used by the Action, followed by an ID that represents a resource in OneLogin. e.g. apps/1234, where apps is the class and 1234 is the ID of an app. The wildcard * is supported and indicates that all resources of the class type declared, in the Action, are in scope. The Action and Scope classes must match. However, there is an exception, a scope of roles/{role_id} can be combined with Actions on the user or app class. The exception allows you to target groups of users or apps with specific actions.
    actions List<String>
    An array of strings that represent actions within OneLogin. Actions are prefixed with the class of object they are related to and followed by a specific action for the given class. e.g. users:List, where the class is users and the specific action is List. Don’t mix classes within an Action array. To create a privilege that includes multiple different classes, create multiple statements. A wildcard * that includes all actions is supported. Use wildcards to create a Super User privilege.
    effect String
    Set to “Allow.” By default, all actions are denied, this Statement allows the listed actions to be executed.
    scopes List<String>
    Target the privileged action against specific resources with the scope. The scope pattern is the class of object used by the Action, followed by an ID that represents a resource in OneLogin. e.g. apps/1234, where apps is the class and 1234 is the ID of an app. The wildcard * is supported and indicates that all resources of the class type declared, in the Action, are in scope. The Action and Scope classes must match. However, there is an exception, a scope of roles/{role_id} can be combined with Actions on the user or app class. The exception allows you to target groups of users or apps with specific actions.

    Package Details

    Repository
    onelogin pulumi/pulumi-onelogin
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the onelogin Terraform Provider.
    onelogin logo
    onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-onelogin