Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIamAccessGroup
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIamAccessGroup

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Retrieve information about an IAM Access Group. Access groups can be used to define a set of permissions that you want to grant to a group of users.

Example Usage

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

const accgroup = ibm.getIamAccessGroup({
    accessGroupName: ibm_iam_access_group.accgroup.name,
});
Copy
import pulumi
import pulumi_ibm as ibm

accgroup = ibm.get_iam_access_group(access_group_name=ibm_iam_access_group["accgroup"]["name"])
Copy
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 {
		_, err := ibm.LookupIamAccessGroup(ctx, &ibm.LookupIamAccessGroupArgs{
			AccessGroupName: pulumi.StringRef(ibm_iam_access_group.Accgroup.Name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var accgroup = Ibm.GetIamAccessGroup.Invoke(new()
    {
        AccessGroupName = ibm_iam_access_group.Accgroup.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIamAccessGroupArgs;
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 accgroup = IbmFunctions.getIamAccessGroup(GetIamAccessGroupArgs.builder()
            .accessGroupName(ibm_iam_access_group.accgroup().name())
            .build());

    }
}
Copy
variables:
  accgroup:
    fn::invoke:
      function: ibm:getIamAccessGroup
      arguments:
        accessGroupName: ${ibm_iam_access_group.accgroup.name}
Copy

Using getIamAccessGroup

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 getIamAccessGroup(args: GetIamAccessGroupArgs, opts?: InvokeOptions): Promise<GetIamAccessGroupResult>
function getIamAccessGroupOutput(args: GetIamAccessGroupOutputArgs, opts?: InvokeOptions): Output<GetIamAccessGroupResult>
Copy
def get_iam_access_group(access_group_name: Optional[str] = None,
                         id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetIamAccessGroupResult
def get_iam_access_group_output(access_group_name: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetIamAccessGroupResult]
Copy
func LookupIamAccessGroup(ctx *Context, args *LookupIamAccessGroupArgs, opts ...InvokeOption) (*LookupIamAccessGroupResult, error)
func LookupIamAccessGroupOutput(ctx *Context, args *LookupIamAccessGroupOutputArgs, opts ...InvokeOption) LookupIamAccessGroupResultOutput
Copy

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

public static class GetIamAccessGroup 
{
    public static Task<GetIamAccessGroupResult> InvokeAsync(GetIamAccessGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetIamAccessGroupResult> Invoke(GetIamAccessGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIamAccessGroupResult> getIamAccessGroup(GetIamAccessGroupArgs args, InvokeOptions options)
public static Output<GetIamAccessGroupResult> getIamAccessGroup(GetIamAccessGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIamAccessGroup:getIamAccessGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccessGroupName string
The name of the access group that you want to retrieve details for. If no access group is specified, all access groups that exist in the IBM Cloud account are returned.
Id string
(String) The ID of the IAM access group.
AccessGroupName string
The name of the access group that you want to retrieve details for. If no access group is specified, all access groups that exist in the IBM Cloud account are returned.
Id string
(String) The ID of the IAM access group.
accessGroupName String
The name of the access group that you want to retrieve details for. If no access group is specified, all access groups that exist in the IBM Cloud account are returned.
id String
(String) The ID of the IAM access group.
accessGroupName string
The name of the access group that you want to retrieve details for. If no access group is specified, all access groups that exist in the IBM Cloud account are returned.
id string
(String) The ID of the IAM access group.
access_group_name str
The name of the access group that you want to retrieve details for. If no access group is specified, all access groups that exist in the IBM Cloud account are returned.
id str
(String) The ID of the IAM access group.
accessGroupName String
The name of the access group that you want to retrieve details for. If no access group is specified, all access groups that exist in the IBM Cloud account are returned.
id String
(String) The ID of the IAM access group.

getIamAccessGroup Result

The following output properties are available:

Groups List<GetIamAccessGroupGroup>
(List) A list of IAM access groups that are set up for an IBM Cloud account.
Id string
(String) The ID of the IAM access group.
AccessGroupName string
Groups []GetIamAccessGroupGroup
(List) A list of IAM access groups that are set up for an IBM Cloud account.
Id string
(String) The ID of the IAM access group.
AccessGroupName string
groups List<GetIamAccessGroupGroup>
(List) A list of IAM access groups that are set up for an IBM Cloud account.
id String
(String) The ID of the IAM access group.
accessGroupName String
groups GetIamAccessGroupGroup[]
(List) A list of IAM access groups that are set up for an IBM Cloud account.
id string
(String) The ID of the IAM access group.
accessGroupName string
groups Sequence[GetIamAccessGroupGroup]
(List) A list of IAM access groups that are set up for an IBM Cloud account.
id str
(String) The ID of the IAM access group.
access_group_name str
groups List<Property Map>
(List) A list of IAM access groups that are set up for an IBM Cloud account.
id String
(String) The ID of the IAM access group.
accessGroupName String

Supporting Types

GetIamAccessGroupGroup

Crn This property is required. string
(String) CRN of the access group
Description This property is required. string
(String) The description of the IAM access group.
IamProfileIds This property is required. List<string>
(Array of Strings) A list of trusted profile IDs that belong to the access group.
IamServiceIds This property is required. List<string>
(Array of Strings) A list of service IDs that belong to the access group.
IbmIds This property is required. List<string>
(Array of Strings) A list of IBM ID that belong to the access group.
Id This property is required. string
(String) The ID of the IAM access group.
Name This property is required. string
(String) The name of the dynamic rule.
Rules This property is required. List<GetIamAccessGroupGroupRule>
(List) A list of dynamic rules that are applied to the IAM access group.
Crn This property is required. string
(String) CRN of the access group
Description This property is required. string
(String) The description of the IAM access group.
IamProfileIds This property is required. []string
(Array of Strings) A list of trusted profile IDs that belong to the access group.
IamServiceIds This property is required. []string
(Array of Strings) A list of service IDs that belong to the access group.
IbmIds This property is required. []string
(Array of Strings) A list of IBM ID that belong to the access group.
Id This property is required. string
(String) The ID of the IAM access group.
Name This property is required. string
(String) The name of the dynamic rule.
Rules This property is required. []GetIamAccessGroupGroupRule
(List) A list of dynamic rules that are applied to the IAM access group.
crn This property is required. String
(String) CRN of the access group
description This property is required. String
(String) The description of the IAM access group.
iamProfileIds This property is required. List<String>
(Array of Strings) A list of trusted profile IDs that belong to the access group.
iamServiceIds This property is required. List<String>
(Array of Strings) A list of service IDs that belong to the access group.
ibmIds This property is required. List<String>
(Array of Strings) A list of IBM ID that belong to the access group.
id This property is required. String
(String) The ID of the IAM access group.
name This property is required. String
(String) The name of the dynamic rule.
rules This property is required. List<GetIamAccessGroupGroupRule>
(List) A list of dynamic rules that are applied to the IAM access group.
crn This property is required. string
(String) CRN of the access group
description This property is required. string
(String) The description of the IAM access group.
iamProfileIds This property is required. string[]
(Array of Strings) A list of trusted profile IDs that belong to the access group.
iamServiceIds This property is required. string[]
(Array of Strings) A list of service IDs that belong to the access group.
ibmIds This property is required. string[]
(Array of Strings) A list of IBM ID that belong to the access group.
id This property is required. string
(String) The ID of the IAM access group.
name This property is required. string
(String) The name of the dynamic rule.
rules This property is required. GetIamAccessGroupGroupRule[]
(List) A list of dynamic rules that are applied to the IAM access group.
crn This property is required. str
(String) CRN of the access group
description This property is required. str
(String) The description of the IAM access group.
iam_profile_ids This property is required. Sequence[str]
(Array of Strings) A list of trusted profile IDs that belong to the access group.
iam_service_ids This property is required. Sequence[str]
(Array of Strings) A list of service IDs that belong to the access group.
ibm_ids This property is required. Sequence[str]
(Array of Strings) A list of IBM ID that belong to the access group.
id This property is required. str
(String) The ID of the IAM access group.
name This property is required. str
(String) The name of the dynamic rule.
rules This property is required. Sequence[GetIamAccessGroupGroupRule]
(List) A list of dynamic rules that are applied to the IAM access group.
crn This property is required. String
(String) CRN of the access group
description This property is required. String
(String) The description of the IAM access group.
iamProfileIds This property is required. List<String>
(Array of Strings) A list of trusted profile IDs that belong to the access group.
iamServiceIds This property is required. List<String>
(Array of Strings) A list of service IDs that belong to the access group.
ibmIds This property is required. List<String>
(Array of Strings) A list of IBM ID that belong to the access group.
id This property is required. String
(String) The ID of the IAM access group.
name This property is required. String
(String) The name of the dynamic rule.
rules This property is required. List<Property Map>
(List) A list of dynamic rules that are applied to the IAM access group.

GetIamAccessGroupGroupRule

Conditions This property is required. List<GetIamAccessGroupGroupRuleCondition>
(List) A list of conditions that the rule must satisfy.
Expiration This property is required. double
(Integer) The number of hours that authenticated users can work in IBM Cloud before they must refresh their access.
IdentityProvider This property is required. string
(String) The URI of your identity provider. This is the SAML "entity ID" field, which is sometimes referred to as the issuer ID, for the identity provider as part of the federation configuration for onboarding with IBMID.
Name This property is required. string
(String) The name of the dynamic rule.
RuleId This property is required. string
(String) The ID of the dynamic rule.
Conditions This property is required. []GetIamAccessGroupGroupRuleCondition
(List) A list of conditions that the rule must satisfy.
Expiration This property is required. float64
(Integer) The number of hours that authenticated users can work in IBM Cloud before they must refresh their access.
IdentityProvider This property is required. string
(String) The URI of your identity provider. This is the SAML "entity ID" field, which is sometimes referred to as the issuer ID, for the identity provider as part of the federation configuration for onboarding with IBMID.
Name This property is required. string
(String) The name of the dynamic rule.
RuleId This property is required. string
(String) The ID of the dynamic rule.
conditions This property is required. List<GetIamAccessGroupGroupRuleCondition>
(List) A list of conditions that the rule must satisfy.
expiration This property is required. Double
(Integer) The number of hours that authenticated users can work in IBM Cloud before they must refresh their access.
identityProvider This property is required. String
(String) The URI of your identity provider. This is the SAML "entity ID" field, which is sometimes referred to as the issuer ID, for the identity provider as part of the federation configuration for onboarding with IBMID.
name This property is required. String
(String) The name of the dynamic rule.
ruleId This property is required. String
(String) The ID of the dynamic rule.
conditions This property is required. GetIamAccessGroupGroupRuleCondition[]
(List) A list of conditions that the rule must satisfy.
expiration This property is required. number
(Integer) The number of hours that authenticated users can work in IBM Cloud before they must refresh their access.
identityProvider This property is required. string
(String) The URI of your identity provider. This is the SAML "entity ID" field, which is sometimes referred to as the issuer ID, for the identity provider as part of the federation configuration for onboarding with IBMID.
name This property is required. string
(String) The name of the dynamic rule.
ruleId This property is required. string
(String) The ID of the dynamic rule.
conditions This property is required. Sequence[GetIamAccessGroupGroupRuleCondition]
(List) A list of conditions that the rule must satisfy.
expiration This property is required. float
(Integer) The number of hours that authenticated users can work in IBM Cloud before they must refresh their access.
identity_provider This property is required. str
(String) The URI of your identity provider. This is the SAML "entity ID" field, which is sometimes referred to as the issuer ID, for the identity provider as part of the federation configuration for onboarding with IBMID.
name This property is required. str
(String) The name of the dynamic rule.
rule_id This property is required. str
(String) The ID of the dynamic rule.
conditions This property is required. List<Property Map>
(List) A list of conditions that the rule must satisfy.
expiration This property is required. Number
(Integer) The number of hours that authenticated users can work in IBM Cloud before they must refresh their access.
identityProvider This property is required. String
(String) The URI of your identity provider. This is the SAML "entity ID" field, which is sometimes referred to as the issuer ID, for the identity provider as part of the federation configuration for onboarding with IBMID.
name This property is required. String
(String) The name of the dynamic rule.
ruleId This property is required. String
(String) The ID of the dynamic rule.

GetIamAccessGroupGroupRuleCondition

Claim This property is required. string
(String) The key value to evaluate the condition against. The key depends on what key-value pairs your identity provider provides. For example, your identity provider might include a key that is named blueGroups and that holds all the user groups that have access. To apply a condition for a specific user group within the blueGroups key, you specify blueGroups as your claim and add the value that you are looking for in value.
Operator This property is required. string
(String) The operation to perform on the claim. Supported values are EQUALS, QUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
Value This property is required. string
(String) The value that the claim is compared to by using the operator.
Claim This property is required. string
(String) The key value to evaluate the condition against. The key depends on what key-value pairs your identity provider provides. For example, your identity provider might include a key that is named blueGroups and that holds all the user groups that have access. To apply a condition for a specific user group within the blueGroups key, you specify blueGroups as your claim and add the value that you are looking for in value.
Operator This property is required. string
(String) The operation to perform on the claim. Supported values are EQUALS, QUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
Value This property is required. string
(String) The value that the claim is compared to by using the operator.
claim This property is required. String
(String) The key value to evaluate the condition against. The key depends on what key-value pairs your identity provider provides. For example, your identity provider might include a key that is named blueGroups and that holds all the user groups that have access. To apply a condition for a specific user group within the blueGroups key, you specify blueGroups as your claim and add the value that you are looking for in value.
operator This property is required. String
(String) The operation to perform on the claim. Supported values are EQUALS, QUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
value This property is required. String
(String) The value that the claim is compared to by using the operator.
claim This property is required. string
(String) The key value to evaluate the condition against. The key depends on what key-value pairs your identity provider provides. For example, your identity provider might include a key that is named blueGroups and that holds all the user groups that have access. To apply a condition for a specific user group within the blueGroups key, you specify blueGroups as your claim and add the value that you are looking for in value.
operator This property is required. string
(String) The operation to perform on the claim. Supported values are EQUALS, QUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
value This property is required. string
(String) The value that the claim is compared to by using the operator.
claim This property is required. str
(String) The key value to evaluate the condition against. The key depends on what key-value pairs your identity provider provides. For example, your identity provider might include a key that is named blueGroups and that holds all the user groups that have access. To apply a condition for a specific user group within the blueGroups key, you specify blueGroups as your claim and add the value that you are looking for in value.
operator This property is required. str
(String) The operation to perform on the claim. Supported values are EQUALS, QUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
value This property is required. str
(String) The value that the claim is compared to by using the operator.
claim This property is required. String
(String) The key value to evaluate the condition against. The key depends on what key-value pairs your identity provider provides. For example, your identity provider might include a key that is named blueGroups and that holds all the user groups that have access. To apply a condition for a specific user group within the blueGroups key, you specify blueGroups as your claim and add the value that you are looking for in value.
operator This property is required. String
(String) The operation to perform on the claim. Supported values are EQUALS, QUALS_IGNORE_CASE, IN, NOT_EQUALS_IGNORE_CASE, NOT_EQUALS, and CONTAINS.
value This property is required. String
(String) The value that the claim is compared to by using the operator.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm