Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIamUserPolicy
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIamUserPolicy

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information about an IAM user policy. For more information, about IAM role action, see managing access to resources.

    Example Usage

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

const policy = new ibm.IamUserPolicy("policy", {
    ibmId: "test@in.ibm.com",
    roles: ["Viewer"],
    resources: {
        service: "kms",
        region: "us-south",
    },
});
const testaccDsUserPolicy = ibm.getIamUserPolicyOutput({
    ibmId: policy.ibmId,
    transactionId: "terrformUserPolicy",
});

    import pulumi
import pulumi_ibm as ibm

policy = ibm.IamUserPolicy("policy",
    ibm_id="test@in.ibm.com",
    roles=["Viewer"],
    resources={
        "service": "kms",
        "region": "us-south",
    })
testacc_ds_user_policy = ibm.get_iam_user_policy_output(ibm_id=policy.ibm_id,
    transaction_id="terrformUserPolicy")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		policy, err := ibm.NewIamUserPolicy(ctx, "policy", &ibm.IamUserPolicyArgs{
			IbmId: pulumi.String("test@in.ibm.com"),
			Roles: pulumi.StringArray{
				pulumi.String("Viewer"),
			},
			Resources: &ibm.IamUserPolicyResourcesArgs{
				Service: pulumi.String("kms"),
				Region:  pulumi.String("us-south"),
			},
		})
		if err != nil {
			return err
		}
		_ = ibm.LookupIamUserPolicyOutput(ctx, ibm.GetIamUserPolicyOutputArgs{
			IbmId:         policy.IbmId,
			TransactionId: pulumi.String("terrformUserPolicy"),
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var policy = new Ibm.IamUserPolicy("policy", new()
    {
        IbmId = "test@in.ibm.com",
        Roles = new[]
        {
            "Viewer",
        },
        Resources = new Ibm.Inputs.IamUserPolicyResourcesArgs
        {
            Service = "kms",
            Region = "us-south",
        },
    });

    var testaccDsUserPolicy = Ibm.GetIamUserPolicy.Invoke(new()
    {
        IbmId = policy.IbmId,
        TransactionId = "terrformUserPolicy",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IamUserPolicy;
import com.pulumi.ibm.IamUserPolicyArgs;
import com.pulumi.ibm.inputs.IamUserPolicyResourcesArgs;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIamUserPolicyArgs;
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 policy = new IamUserPolicy("policy", IamUserPolicyArgs.builder()
            .ibmId("test@in.ibm.com")
            .roles("Viewer")
            .resources(IamUserPolicyResourcesArgs.builder()
                .service("kms")
                .region("us-south")
                .build())
            .build());

        final var testaccDsUserPolicy = IbmFunctions.getIamUserPolicy(GetIamUserPolicyArgs.builder()
            .ibmId(policy.ibmId())
            .transactionId("terrformUserPolicy")
            .build());

    }
}

    resources:
  policy:
    type: ibm:IamUserPolicy
    properties:
      ibmId: test@in.ibm.com
      roles:
        - Viewer
      resources:
        service: kms
        region: us-south
variables:
  testaccDsUserPolicy:
    fn::invoke:
      function: ibm:getIamUserPolicy
      arguments:
        ibmId: ${policy.ibmId}
        transactionId: terrformUserPolicy

    Using getIamUserPolicy

    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 getIamUserPolicy(args: GetIamUserPolicyArgs, opts?: InvokeOptions): Promise<GetIamUserPolicyResult>
function getIamUserPolicyOutput(args: GetIamUserPolicyOutputArgs, opts?: InvokeOptions): Output<GetIamUserPolicyResult>
    def get_iam_user_policy(ibm_id: Optional[str] = None,
                        id: Optional[str] = None,
                        sort: Optional[str] = None,
                        transaction_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIamUserPolicyResult
def get_iam_user_policy_output(ibm_id: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        sort: Optional[pulumi.Input[str]] = None,
                        transaction_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIamUserPolicyResult]
    func LookupIamUserPolicy(ctx *Context, args *LookupIamUserPolicyArgs, opts ...InvokeOption) (*LookupIamUserPolicyResult, error)
func LookupIamUserPolicyOutput(ctx *Context, args *LookupIamUserPolicyOutputArgs, opts ...InvokeOption) LookupIamUserPolicyResultOutput

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

    public static class GetIamUserPolicy 
{
    public static Task<GetIamUserPolicyResult> InvokeAsync(GetIamUserPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetIamUserPolicyResult> Invoke(GetIamUserPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIamUserPolicyResult> getIamUserPolicy(GetIamUserPolicyArgs args, InvokeOptions options)
public static Output<GetIamUserPolicyResult> getIamUserPolicy(GetIamUserPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIamUserPolicy:getIamUserPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    IbmId string
    The IBM ID or email address of the user.
    Id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    Sort string
    The single field sort query for policies.
    TransactionId string
    The TransactionID can be passed to your request for the tracking calls.
    IbmId string
    The IBM ID or email address of the user.
    Id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    Sort string
    The single field sort query for policies.
    TransactionId string
    The TransactionID can be passed to your request for the tracking calls.
    ibmId String
    The IBM ID or email address of the user.
    id String
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    sort String
    The single field sort query for policies.
    transactionId String
    The TransactionID can be passed to your request for the tracking calls.
    ibmId string
    The IBM ID or email address of the user.
    id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    sort string
    The single field sort query for policies.
    transactionId string
    The TransactionID can be passed to your request for the tracking calls.
    ibm_id str
    The IBM ID or email address of the user.
    id str
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    sort str
    The single field sort query for policies.
    transaction_id str
    The TransactionID can be passed to your request for the tracking calls.
    ibmId String
    The IBM ID or email address of the user.
    id String
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    sort String
    The single field sort query for policies.
    transactionId String
    The TransactionID can be passed to your request for the tracking calls.

    getIamUserPolicy Result

    The following output properties are available:

    IbmId string
    Id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    Policies List<GetIamUserPolicyPolicy>
    (List) A nested block describes IAM Policies assigned to user.
    TransactionId string
    Sort string
    IbmId string
    Id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    Policies []GetIamUserPolicyPolicy
    (List) A nested block describes IAM Policies assigned to user.
    TransactionId string
    Sort string
    ibmId String
    id String
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    policies List<GetIamUserPolicyPolicy>
    (List) A nested block describes IAM Policies assigned to user.
    transactionId String
    sort String
    ibmId string
    id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    policies GetIamUserPolicyPolicy[]
    (List) A nested block describes IAM Policies assigned to user.
    transactionId string
    sort string
    ibm_id str
    id str
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    policies Sequence[GetIamUserPolicyPolicy]
    (List) A nested block describes IAM Policies assigned to user.
    transaction_id str
    sort str
    ibmId String
    id String
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    policies List<Property Map>
    (List) A nested block describes IAM Policies assigned to user.
    transactionId String
    sort String

    Supporting Types

    GetIamUserPolicyPolicy

    Description string
    (String) The description of the IAM User Policy.
    Id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    Pattern string
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    ResourceTags List<GetIamUserPolicyPolicyResourceTag>
    (List of objects) A nested block describes the access management tags in the policy.
    Resources List<GetIamUserPolicyPolicyResource>
    (List of objects) A nested block describes the resources in the policy.
    Roles List<string>
    (String) The roles that are assigned to the policy.
    RuleConditions List<GetIamUserPolicyPolicyRuleCondition>
    (List of objects) A nested block describing the rule conditions of this policy.
    RuleOperator string
    (String) The operator used to evaluate multiple rule conditions, e.g., all must be satisfied with and.
    Description string
    (String) The description of the IAM User Policy.
    Id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    Pattern string
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    ResourceTags []GetIamUserPolicyPolicyResourceTag
    (List of objects) A nested block describes the access management tags in the policy.
    Resources []GetIamUserPolicyPolicyResource
    (List of objects) A nested block describes the resources in the policy.
    Roles []string
    (String) The roles that are assigned to the policy.
    RuleConditions []GetIamUserPolicyPolicyRuleCondition
    (List of objects) A nested block describing the rule conditions of this policy.
    RuleOperator string
    (String) The operator used to evaluate multiple rule conditions, e.g., all must be satisfied with and.
    description String
    (String) The description of the IAM User Policy.
    id String
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    pattern String
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resourceTags List<GetIamUserPolicyPolicyResourceTag>
    (List of objects) A nested block describes the access management tags in the policy.
    resources List<GetIamUserPolicyPolicyResource>
    (List of objects) A nested block describes the resources in the policy.
    roles List<String>
    (String) The roles that are assigned to the policy.
    ruleConditions List<GetIamUserPolicyPolicyRuleCondition>
    (List of objects) A nested block describing the rule conditions of this policy.
    ruleOperator String
    (String) The operator used to evaluate multiple rule conditions, e.g., all must be satisfied with and.
    description string
    (String) The description of the IAM User Policy.
    id string
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    pattern string
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resourceTags GetIamUserPolicyPolicyResourceTag[]
    (List of objects) A nested block describes the access management tags in the policy.
    resources GetIamUserPolicyPolicyResource[]
    (List of objects) A nested block describes the resources in the policy.
    roles string[]
    (String) The roles that are assigned to the policy.
    ruleConditions GetIamUserPolicyPolicyRuleCondition[]
    (List of objects) A nested block describing the rule conditions of this policy.
    ruleOperator string
    (String) The operator used to evaluate multiple rule conditions, e.g., all must be satisfied with and.
    description str
    (String) The description of the IAM User Policy.
    id str
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    pattern str
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resource_tags Sequence[GetIamUserPolicyPolicyResourceTag]
    (List of objects) A nested block describes the access management tags in the policy.
    resources Sequence[GetIamUserPolicyPolicyResource]
    (List of objects) A nested block describes the resources in the policy.
    roles Sequence[str]
    (String) The roles that are assigned to the policy.
    rule_conditions Sequence[GetIamUserPolicyPolicyRuleCondition]
    (List of objects) A nested block describing the rule conditions of this policy.
    rule_operator str
    (String) The operator used to evaluate multiple rule conditions, e.g., all must be satisfied with and.
    description String
    (String) The description of the IAM User Policy.
    id String
    (String) The unique identifier of the IAM user policy. The ID is composed of <ibm_id>/<user_policy_id>.
    pattern String
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resourceTags List<Property Map>
    (List of objects) A nested block describes the access management tags in the policy.
    resources List<Property Map>
    (List of objects) A nested block describes the resources in the policy.
    roles List<String>
    (String) The roles that are assigned to the policy.
    ruleConditions List<Property Map>
    (List of objects) A nested block describing the rule conditions of this policy.
    ruleOperator String
    (String) The operator used to evaluate multiple rule conditions, e.g., all must be satisfied with and.

    GetIamUserPolicyPolicyResource

    Attributes Dictionary<string, string>
    (Map) A set of resource attributes in the format name=value,name=value.
    Region string
    (String) The region of the policy definition.
    Resource string
    (String) The resource of the policy definition.
    ResourceGroupId string
    (String) The ID of the resource group.
    ResourceInstanceId string
    (String) The ID of resource instance of the policy definition.
    ResourceType string
    (String) The resource type of the policy definition.
    Service string
    (String) The service name of the policy definition.
    ServiceGroupId string
    (String) The service group id of the policy definition.
    ServiceType string
    Attributes map[string]string
    (Map) A set of resource attributes in the format name=value,name=value.
    Region string
    (String) The region of the policy definition.
    Resource string
    (String) The resource of the policy definition.
    ResourceGroupId string
    (String) The ID of the resource group.
    ResourceInstanceId string
    (String) The ID of resource instance of the policy definition.
    ResourceType string
    (String) The resource type of the policy definition.
    Service string
    (String) The service name of the policy definition.
    ServiceGroupId string
    (String) The service group id of the policy definition.
    ServiceType string
    attributes Map<String,String>
    (Map) A set of resource attributes in the format name=value,name=value.
    region String
    (String) The region of the policy definition.
    resource String
    (String) The resource of the policy definition.
    resourceGroupId String
    (String) The ID of the resource group.
    resourceInstanceId String
    (String) The ID of resource instance of the policy definition.
    resourceType String
    (String) The resource type of the policy definition.
    service String
    (String) The service name of the policy definition.
    serviceGroupId String
    (String) The service group id of the policy definition.
    serviceType String
    attributes {[key: string]: string}
    (Map) A set of resource attributes in the format name=value,name=value.
    region string
    (String) The region of the policy definition.
    resource string
    (String) The resource of the policy definition.
    resourceGroupId string
    (String) The ID of the resource group.
    resourceInstanceId string
    (String) The ID of resource instance of the policy definition.
    resourceType string
    (String) The resource type of the policy definition.
    service string
    (String) The service name of the policy definition.
    serviceGroupId string
    (String) The service group id of the policy definition.
    serviceType string
    attributes Mapping[str, str]
    (Map) A set of resource attributes in the format name=value,name=value.
    region str
    (String) The region of the policy definition.
    resource str
    (String) The resource of the policy definition.
    resource_group_id str
    (String) The ID of the resource group.
    resource_instance_id str
    (String) The ID of resource instance of the policy definition.
    resource_type str
    (String) The resource type of the policy definition.
    service str
    (String) The service name of the policy definition.
    service_group_id str
    (String) The service group id of the policy definition.
    service_type str
    attributes Map<String>
    (Map) A set of resource attributes in the format name=value,name=value.
    region String
    (String) The region of the policy definition.
    resource String
    (String) The resource of the policy definition.
    resourceGroupId String
    (String) The ID of the resource group.
    resourceInstanceId String
    (String) The ID of resource instance of the policy definition.
    resourceType String
    (String) The resource type of the policy definition.
    service String
    (String) The service name of the policy definition.
    serviceGroupId String
    (String) The service group id of the policy definition.
    serviceType String

    GetIamUserPolicyPolicyResourceTag

    Name string
    (String) The key of an access management tag.
    Operator string
    (String) The operator of a condition.
    Value string
    (List of Strings) The value of a condition.
    Name string
    (String) The key of an access management tag.
    Operator string
    (String) The operator of a condition.
    Value string
    (List of Strings) The value of a condition.
    name String
    (String) The key of an access management tag.
    operator String
    (String) The operator of a condition.
    value String
    (List of Strings) The value of a condition.
    name string
    (String) The key of an access management tag.
    operator string
    (String) The operator of a condition.
    value string
    (List of Strings) The value of a condition.
    name str
    (String) The key of an access management tag.
    operator str
    (String) The operator of a condition.
    value str
    (List of Strings) The value of a condition.
    name String
    (String) The key of an access management tag.
    operator String
    (String) The operator of a condition.
    value String
    (List of Strings) The value of a condition.

    GetIamUserPolicyPolicyRuleCondition

    Conditions List<GetIamUserPolicyPolicyRuleConditionCondition>
    (List of Objects) A nested block describing additional rule conditions of this policy.
    Key string
    (String) The key of a condition.
    Operator string
    (String) The operator of a condition.
    Values List<string>
    (List of Strings) The value of a condition.
    Conditions []GetIamUserPolicyPolicyRuleConditionCondition
    (List of Objects) A nested block describing additional rule conditions of this policy.
    Key string
    (String) The key of a condition.
    Operator string
    (String) The operator of a condition.
    Values []string
    (List of Strings) The value of a condition.
    conditions List<GetIamUserPolicyPolicyRuleConditionCondition>
    (List of Objects) A nested block describing additional rule conditions of this policy.
    key String
    (String) The key of a condition.
    operator String
    (String) The operator of a condition.
    values List<String>
    (List of Strings) The value of a condition.
    conditions GetIamUserPolicyPolicyRuleConditionCondition[]
    (List of Objects) A nested block describing additional rule conditions of this policy.
    key string
    (String) The key of a condition.
    operator string
    (String) The operator of a condition.
    values string[]
    (List of Strings) The value of a condition.
    conditions Sequence[GetIamUserPolicyPolicyRuleConditionCondition]
    (List of Objects) A nested block describing additional rule conditions of this policy.
    key str
    (String) The key of a condition.
    operator str
    (String) The operator of a condition.
    values Sequence[str]
    (List of Strings) The value of a condition.
    conditions List<Property Map>
    (List of Objects) A nested block describing additional rule conditions of this policy.
    key String
    (String) The key of a condition.
    operator String
    (String) The operator of a condition.
    values List<String>
    (List of Strings) The value of a condition.

    GetIamUserPolicyPolicyRuleConditionCondition

    Key string
    (String) The key of a condition.
    Operator string
    (String) The operator of a condition.
    Values List<string>
    (List of Strings) The value of a condition.
    Key string
    (String) The key of a condition.
    Operator string
    (String) The operator of a condition.
    Values []string
    (List of Strings) The value of a condition.
    key String
    (String) The key of a condition.
    operator String
    (String) The operator of a condition.
    values List<String>
    (List of Strings) The value of a condition.
    key string
    (String) The key of a condition.
    operator string
    (String) The operator of a condition.
    values string[]
    (List of Strings) The value of a condition.
    key str
    (String) The key of a condition.
    operator str
    (String) The operator of a condition.
    values Sequence[str]
    (List of Strings) The value of a condition.
    key String
    (String) The key of a condition.
    operator String
    (String) The operator of a condition.
    values List<String>
    (List of Strings) The value of a condition.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm