1. Packages
  2. Prismacloud Provider
  3. API Docs
  4. getUserRole
prismacloud 1.7.0 published on Monday, Apr 14, 2025 by paloaltonetworks

prismacloud.getUserRole

Explore with Pulumi AI

Retrieve information on a specific user role.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as prismacloud from "@pulumi/prismacloud";

const example = prismacloud.getUserRole({
    name: "My Role",
});
Copy
import pulumi
import pulumi_prismacloud as prismacloud

example = prismacloud.get_user_role(name="My Role")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/prismacloud/prismacloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := prismacloud.LookupUserRole(ctx, &prismacloud.LookupUserRoleArgs{
			Name: pulumi.StringRef("My Role"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prismacloud = Pulumi.Prismacloud;

return await Deployment.RunAsync(() => 
{
    var example = Prismacloud.GetUserRole.Invoke(new()
    {
        Name = "My Role",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prismacloud.PrismacloudFunctions;
import com.pulumi.prismacloud.inputs.GetUserRoleArgs;
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) {
        final var example = PrismacloudFunctions.getUserRole(GetUserRoleArgs.builder()
            .name("My Role")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: prismacloud:getUserRole
      arguments:
        name: My Role
Copy

Additional Attributes

  • only_allow_ci_access - (bool) - Allows only CI Access.
  • only_allow_read_access - (bool) - Allow read only access.
  • has_defender_permissions- (bool) - Has defender Permissions.
  • only_allow_compute_access- (bool) - Access to only Compute tab and Access keys.

Using getUserRole

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 getUserRole(args: GetUserRoleArgs, opts?: InvokeOptions): Promise<GetUserRoleResult>
function getUserRoleOutput(args: GetUserRoleOutputArgs, opts?: InvokeOptions): Output<GetUserRoleResult>
Copy
def get_user_role(backoff_retry: Optional[bool] = None,
                  id: Optional[str] = None,
                  max_retries: Optional[float] = None,
                  name: Optional[str] = None,
                  role_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUserRoleResult
def get_user_role_output(backoff_retry: Optional[pulumi.Input[bool]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  max_retries: Optional[pulumi.Input[float]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  role_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetUserRoleResult]
Copy
func LookupUserRole(ctx *Context, args *LookupUserRoleArgs, opts ...InvokeOption) (*LookupUserRoleResult, error)
func LookupUserRoleOutput(ctx *Context, args *LookupUserRoleOutputArgs, opts ...InvokeOption) LookupUserRoleResultOutput
Copy

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

public static class GetUserRole 
{
    public static Task<GetUserRoleResult> InvokeAsync(GetUserRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetUserRoleResult> Invoke(GetUserRoleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserRoleResult> getUserRole(GetUserRoleArgs args, InvokeOptions options)
public static Output<GetUserRoleResult> getUserRole(GetUserRoleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: prismacloud:index/getUserRole:getUserRole
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BackoffRetry bool
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
Id string
MaxRetries double
(int) (Default: 10) Maximum number of retries.
Name string
Name of the role.
RoleId string
Role Id
BackoffRetry bool
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
Id string
MaxRetries float64
(int) (Default: 10) Maximum number of retries.
Name string
Name of the role.
RoleId string
Role Id
backoffRetry Boolean
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
id String
maxRetries Double
(int) (Default: 10) Maximum number of retries.
name String
Name of the role.
roleId String
Role Id
backoffRetry boolean
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
id string
maxRetries number
(int) (Default: 10) Maximum number of retries.
name string
Name of the role.
roleId string
Role Id
backoff_retry bool
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
id str
max_retries float
(int) (Default: 10) Maximum number of retries.
name str
Name of the role.
role_id str
Role Id
backoffRetry Boolean
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
id String
maxRetries Number
(int) (Default: 10) Maximum number of retries.
name String
Name of the role.
roleId String
Role Id

getUserRole Result

The following output properties are available:

AccountGroupIds List<string>
List of accessible account group IDs.
AdditionalAttributes List<GetUserRoleAdditionalAttribute>
An Additional attributes spec, as defined below.
AssociatedUsers List<string>
List of associated application users which cannot exist in the system without the user role.
CodeRepositoryIds List<string>
List of code repository IDs.
Description string
Description.
Id string
LastModifiedBy string
Last modified by.
LastModifiedTs double
(int) Last modified timestamp.
Name string
ResourceListIds List<string>
List of resource list IDs.
RestrictDismissalAccess bool
(bool) Restrict dismissal access.
RoleId string
RoleType string
User role type.
BackoffRetry bool
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
MaxRetries double
(int) (Default: 10) Maximum number of retries.
AccountGroupIds []string
List of accessible account group IDs.
AdditionalAttributes []GetUserRoleAdditionalAttribute
An Additional attributes spec, as defined below.
AssociatedUsers []string
List of associated application users which cannot exist in the system without the user role.
CodeRepositoryIds []string
List of code repository IDs.
Description string
Description.
Id string
LastModifiedBy string
Last modified by.
LastModifiedTs float64
(int) Last modified timestamp.
Name string
ResourceListIds []string
List of resource list IDs.
RestrictDismissalAccess bool
(bool) Restrict dismissal access.
RoleId string
RoleType string
User role type.
BackoffRetry bool
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
MaxRetries float64
(int) (Default: 10) Maximum number of retries.
accountGroupIds List<String>
List of accessible account group IDs.
additionalAttributes List<GetUserRoleAdditionalAttribute>
An Additional attributes spec, as defined below.
associatedUsers List<String>
List of associated application users which cannot exist in the system without the user role.
codeRepositoryIds List<String>
List of code repository IDs.
description String
Description.
id String
lastModifiedBy String
Last modified by.
lastModifiedTs Double
(int) Last modified timestamp.
name String
resourceListIds List<String>
List of resource list IDs.
restrictDismissalAccess Boolean
(bool) Restrict dismissal access.
roleId String
roleType String
User role type.
backoffRetry Boolean
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
maxRetries Double
(int) (Default: 10) Maximum number of retries.
accountGroupIds string[]
List of accessible account group IDs.
additionalAttributes GetUserRoleAdditionalAttribute[]
An Additional attributes spec, as defined below.
associatedUsers string[]
List of associated application users which cannot exist in the system without the user role.
codeRepositoryIds string[]
List of code repository IDs.
description string
Description.
id string
lastModifiedBy string
Last modified by.
lastModifiedTs number
(int) Last modified timestamp.
name string
resourceListIds string[]
List of resource list IDs.
restrictDismissalAccess boolean
(bool) Restrict dismissal access.
roleId string
roleType string
User role type.
backoffRetry boolean
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
maxRetries number
(int) (Default: 10) Maximum number of retries.
account_group_ids Sequence[str]
List of accessible account group IDs.
additional_attributes Sequence[GetUserRoleAdditionalAttribute]
An Additional attributes spec, as defined below.
associated_users Sequence[str]
List of associated application users which cannot exist in the system without the user role.
code_repository_ids Sequence[str]
List of code repository IDs.
description str
Description.
id str
last_modified_by str
Last modified by.
last_modified_ts float
(int) Last modified timestamp.
name str
resource_list_ids Sequence[str]
List of resource list IDs.
restrict_dismissal_access bool
(bool) Restrict dismissal access.
role_id str
role_type str
User role type.
backoff_retry bool
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
max_retries float
(int) (Default: 10) Maximum number of retries.
accountGroupIds List<String>
List of accessible account group IDs.
additionalAttributes List<Property Map>
An Additional attributes spec, as defined below.
associatedUsers List<String>
List of associated application users which cannot exist in the system without the user role.
codeRepositoryIds List<String>
List of code repository IDs.
description String
Description.
id String
lastModifiedBy String
Last modified by.
lastModifiedTs Number
(int) Last modified timestamp.
name String
resourceListIds List<String>
List of resource list IDs.
restrictDismissalAccess Boolean
(bool) Restrict dismissal access.
roleId String
roleType String
User role type.
backoffRetry Boolean
(bool) Backoff retry parameter manages retries when the API fails, using exponential backoff.
maxRetries Number
(int) (Default: 10) Maximum number of retries.

Supporting Types

GetUserRoleAdditionalAttribute

HasDefenderPermissions This property is required. bool
OnlyAllowCiAccess This property is required. bool
OnlyAllowComputeAccess This property is required. bool
OnlyAllowReadAccess This property is required. bool
HasDefenderPermissions This property is required. bool
OnlyAllowCiAccess This property is required. bool
OnlyAllowComputeAccess This property is required. bool
OnlyAllowReadAccess This property is required. bool
hasDefenderPermissions This property is required. Boolean
onlyAllowCiAccess This property is required. Boolean
onlyAllowComputeAccess This property is required. Boolean
onlyAllowReadAccess This property is required. Boolean
hasDefenderPermissions This property is required. boolean
onlyAllowCiAccess This property is required. boolean
onlyAllowComputeAccess This property is required. boolean
onlyAllowReadAccess This property is required. boolean
has_defender_permissions This property is required. bool
only_allow_ci_access This property is required. bool
only_allow_compute_access This property is required. bool
only_allow_read_access This property is required. bool
hasDefenderPermissions This property is required. Boolean
onlyAllowCiAccess This property is required. Boolean
onlyAllowComputeAccess This property is required. Boolean
onlyAllowReadAccess This property is required. Boolean

Package Details

Repository
prismacloud paloaltonetworks/terraform-provider-prismacloud
License
Notes
This Pulumi package is based on the prismacloud Terraform Provider.