1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIamAccessGroupPolicy
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getIamAccessGroupPolicy

Explore with Pulumi AI

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

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

    Using getIamAccessGroupPolicy

    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 getIamAccessGroupPolicy(args: GetIamAccessGroupPolicyArgs, opts?: InvokeOptions): Promise<GetIamAccessGroupPolicyResult>
    function getIamAccessGroupPolicyOutput(args: GetIamAccessGroupPolicyOutputArgs, opts?: InvokeOptions): Output<GetIamAccessGroupPolicyResult>
    def get_iam_access_group_policy(access_group_id: Optional[str] = None,
                                    id: Optional[str] = None,
                                    sort: Optional[str] = None,
                                    transaction_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetIamAccessGroupPolicyResult
    def get_iam_access_group_policy_output(access_group_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[GetIamAccessGroupPolicyResult]
    func LookupIamAccessGroupPolicy(ctx *Context, args *LookupIamAccessGroupPolicyArgs, opts ...InvokeOption) (*LookupIamAccessGroupPolicyResult, error)
    func LookupIamAccessGroupPolicyOutput(ctx *Context, args *LookupIamAccessGroupPolicyOutputArgs, opts ...InvokeOption) LookupIamAccessGroupPolicyResultOutput

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

    public static class GetIamAccessGroupPolicy 
    {
        public static Task<GetIamAccessGroupPolicyResult> InvokeAsync(GetIamAccessGroupPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetIamAccessGroupPolicyResult> Invoke(GetIamAccessGroupPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIamAccessGroupPolicyResult> getIamAccessGroupPolicy(GetIamAccessGroupPolicyArgs args, InvokeOptions options)
    public static Output<GetIamAccessGroupPolicyResult> getIamAccessGroupPolicy(GetIamAccessGroupPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIamAccessGroupPolicy:getIamAccessGroupPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccessGroupId string
    The ID of the access group.
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    Sort string
    The single field sort query for policies. Allowed values are id, type, href, created_at, created_by_id, last_modified_at,last_modified_by_id, state.
    TransactionId string
    The TransactionID can be passed to your request for the tracking calls.
    AccessGroupId string
    The ID of the access group.
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    Sort string
    The single field sort query for policies. Allowed values are id, type, href, created_at, created_by_id, last_modified_at,last_modified_by_id, state.
    TransactionId string
    The TransactionID can be passed to your request for the tracking calls.
    accessGroupId String
    The ID of the access group.
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    sort String
    The single field sort query for policies. Allowed values are id, type, href, created_at, created_by_id, last_modified_at,last_modified_by_id, state.
    transactionId String
    The TransactionID can be passed to your request for the tracking calls.
    accessGroupId string
    The ID of the access group.
    id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    sort string
    The single field sort query for policies. Allowed values are id, type, href, created_at, created_by_id, last_modified_at,last_modified_by_id, state.
    transactionId string
    The TransactionID can be passed to your request for the tracking calls.
    access_group_id str
    The ID of the access group.
    id str
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    sort str
    The single field sort query for policies. Allowed values are id, type, href, created_at, created_by_id, last_modified_at,last_modified_by_id, state.
    transaction_id str
    The TransactionID can be passed to your request for the tracking calls.
    accessGroupId String
    The ID of the access group.
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    sort String
    The single field sort query for policies. Allowed values are id, type, href, created_at, created_by_id, last_modified_at,last_modified_by_id, state.
    transactionId String
    The TransactionID can be passed to your request for the tracking calls.

    getIamAccessGroupPolicy Result

    The following output properties are available:

    AccessGroupId string
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    Policies List<GetIamAccessGroupPolicyPolicy>
    (List) A nested block describes IAM Policies assigned to access group.
    TransactionId string
    Sort string
    AccessGroupId string
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    Policies []GetIamAccessGroupPolicyPolicy
    (List) A nested block describes IAM Policies assigned to access group.
    TransactionId string
    Sort string
    accessGroupId String
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    policies List<GetIamAccessGroupPolicyPolicy>
    (List) A nested block describes IAM Policies assigned to access group.
    transactionId String
    sort String
    accessGroupId string
    id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    policies GetIamAccessGroupPolicyPolicy[]
    (List) A nested block describes IAM Policies assigned to access group.
    transactionId string
    sort string
    access_group_id str
    id str
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    policies Sequence[GetIamAccessGroupPolicyPolicy]
    (List) A nested block describes IAM Policies assigned to access group.
    transaction_id str
    sort str
    accessGroupId String
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    policies List<Property Map>
    (List) A nested block describes IAM Policies assigned to access group.
    transactionId String
    sort String

    Supporting Types

    GetIamAccessGroupPolicyPolicy

    Description string
    (String) The description of the IAM access group Policy.
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    Pattern string
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    ResourceTags List<GetIamAccessGroupPolicyPolicyResourceTag>
    (List of objects) A nested block describes the access management tags in the policy.
    Resources List<GetIamAccessGroupPolicyPolicyResource>
    (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<GetIamAccessGroupPolicyPolicyRuleCondition>
    (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.
    Templates List<GetIamAccessGroupPolicyPolicyTemplate>
    Description string
    (String) The description of the IAM access group Policy.
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    Pattern string
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    ResourceTags []GetIamAccessGroupPolicyPolicyResourceTag
    (List of objects) A nested block describes the access management tags in the policy.
    Resources []GetIamAccessGroupPolicyPolicyResource
    (List of objects) A nested block describes the resources in the policy.
    Roles []string
    (String) The roles that are assigned to the policy.
    RuleConditions []GetIamAccessGroupPolicyPolicyRuleCondition
    (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.
    Templates []GetIamAccessGroupPolicyPolicyTemplate
    description String
    (String) The description of the IAM access group Policy.
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    pattern String
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resourceTags List<GetIamAccessGroupPolicyPolicyResourceTag>
    (List of objects) A nested block describes the access management tags in the policy.
    resources List<GetIamAccessGroupPolicyPolicyResource>
    (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<GetIamAccessGroupPolicyPolicyRuleCondition>
    (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.
    templates List<GetIamAccessGroupPolicyPolicyTemplate>
    description string
    (String) The description of the IAM access group Policy.
    id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    pattern string
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resourceTags GetIamAccessGroupPolicyPolicyResourceTag[]
    (List of objects) A nested block describes the access management tags in the policy.
    resources GetIamAccessGroupPolicyPolicyResource[]
    (List of objects) A nested block describes the resources in the policy.
    roles string[]
    (String) The roles that are assigned to the policy.
    ruleConditions GetIamAccessGroupPolicyPolicyRuleCondition[]
    (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.
    templates GetIamAccessGroupPolicyPolicyTemplate[]
    description str
    (String) The description of the IAM access group Policy.
    id str
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    pattern str
    (String) The pattern that the rule follows, e.g., time-based-conditions:weekly:all-day.
    resource_tags Sequence[GetIamAccessGroupPolicyPolicyResourceTag]
    (List of objects) A nested block describes the access management tags in the policy.
    resources Sequence[GetIamAccessGroupPolicyPolicyResource]
    (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[GetIamAccessGroupPolicyPolicyRuleCondition]
    (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.
    templates Sequence[GetIamAccessGroupPolicyPolicyTemplate]
    description String
    (String) The description of the IAM access group Policy.
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_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.
    templates List<Property Map>

    GetIamAccessGroupPolicyPolicyResource

    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
    (String) The service type of the policy definition.
    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
    (String) The service type of the policy definition.
    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
    (String) The service type of the policy definition.
    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
    (String) The service type of the policy definition.
    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
    (String) The service type of the policy definition.
    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
    (String) The service type of the policy definition.

    GetIamAccessGroupPolicyPolicyResourceTag

    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.

    GetIamAccessGroupPolicyPolicyRuleCondition

    Conditions List<GetIamAccessGroupPolicyPolicyRuleConditionCondition>
    (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 []GetIamAccessGroupPolicyPolicyRuleConditionCondition
    (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<GetIamAccessGroupPolicyPolicyRuleConditionCondition>
    (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 GetIamAccessGroupPolicyPolicyRuleConditionCondition[]
    (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[GetIamAccessGroupPolicyPolicyRuleConditionCondition]
    (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.

    GetIamAccessGroupPolicyPolicyRuleConditionCondition

    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.

    GetIamAccessGroupPolicyPolicyTemplate

    AssignmentId string
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    RootIds List<string>
    RootVersions List<string>
    Version string
    AssignmentId string
    Id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    RootIds []string
    RootVersions []string
    Version string
    assignmentId String
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    rootIds List<String>
    rootVersions List<String>
    version String
    assignmentId string
    id string
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    rootIds string[]
    rootVersions string[]
    version string
    assignment_id str
    id str
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    root_ids Sequence[str]
    root_versions Sequence[str]
    version str
    assignmentId String
    id String
    (String) The unique identifier of the IAM access group policy. The ID is composed of <ibm_id>/<access_group_policy_id>.
    rootIds List<String>
    rootVersions List<String>
    version String

    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