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

onelogin.getPrivileges

Explore with Pulumi AI

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

    Using getPrivileges

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivileges(args: GetPrivilegesArgs, opts?: InvokeOptions): Promise<GetPrivilegesResult>
    function getPrivilegesOutput(args: GetPrivilegesOutputArgs, opts?: InvokeOptions): Output<GetPrivilegesResult>
    def get_privileges(description: Optional[str] = None,
                       filters: Optional[Sequence[GetPrivilegesFilter]] = None,
                       name: Optional[str] = None,
                       privilege: Optional[GetPrivilegesPrivilege] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPrivilegesResult
    def get_privileges_output(description: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPrivilegesFilterArgs]]]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       privilege: Optional[pulumi.Input[GetPrivilegesPrivilegeArgs]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPrivilegesResult]
    func LookupPrivileges(ctx *Context, args *LookupPrivilegesArgs, opts ...InvokeOption) (*LookupPrivilegesResult, error)
    func LookupPrivilegesOutput(ctx *Context, args *LookupPrivilegesOutputArgs, opts ...InvokeOption) LookupPrivilegesResultOutput

    > Note: This function is named LookupPrivileges in the Go SDK.

    public static class GetPrivileges 
    {
        public static Task<GetPrivilegesResult> InvokeAsync(GetPrivilegesArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivilegesResult> Invoke(GetPrivilegesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivilegesResult> getPrivileges(GetPrivilegesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: onelogin:index/getPrivileges:getPrivileges
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getPrivileges Result

    The following output properties are available:

    Description string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Privilege GetPrivilegesPrivilege
    Filters List<GetPrivilegesFilter>
    Description string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Privilege GetPrivilegesPrivilege
    Filters []GetPrivilegesFilter
    description String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    privilege GetPrivilegesPrivilege
    filters List<GetPrivilegesFilter>
    description string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    privilege GetPrivilegesPrivilege
    filters GetPrivilegesFilter[]
    description str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    privilege GetPrivilegesPrivilege
    filters Sequence[GetPrivilegesFilter]
    description String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    privilege Property Map
    filters List<Property Map>

    Supporting Types

    GetPrivilegesFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    GetPrivilegesPrivilege

    GetPrivilegesPrivilegeStatement

    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