Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getIamIdpAccountSettings
Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

ibm.getIamIdpAccountSettings

Viewing docs for ibm 2.5.0
published on Wednesday, Aug 5, 2026 by ibm-cloud
Schema (JSON)
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source to list IAM Identity Provider (IdP) account settings for a given account. Depending on the type argument, this data source returns either the IdPs that the account can consume (consumable) or the IdPs that the account is already consuming (consumed).

    For more information, see the IAM Identity Services API documentation.

    Example Usage

    List IdPs available for an account to consume

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

const consumable = ibm.getIamIdpAccountSettings({
    accountId: accountId,
    type: "consumable",
});

    import pulumi
import pulumi_ibm as ibm

consumable = ibm.get_iam_idp_account_settings(account_id=account_id,
    type="consumable")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIamIdpAccountSettings(ctx, &ibm.GetIamIdpAccountSettingsArgs{
			AccountId: accountId,
			Type:      "consumable",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var consumable = Ibm.GetIamIdpAccountSettings.Invoke(new()
    {
        AccountId = accountId,
        Type = "consumable",
    });

});

    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.GetIamIdpAccountSettingsArgs;
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 consumable = IbmFunctions.getIamIdpAccountSettings(GetIamIdpAccountSettingsArgs.builder()
            .accountId(accountId)
            .type("consumable")
            .build());

    }
}

    variables:
  consumable:
    fn::invoke:
      function: ibm:getIamIdpAccountSettings
      arguments:
        accountId: ${accountId}
        type: consumable

    Example coming soon!

    List IdPs already bound to an account

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

const consumed = ibm.getIamIdpAccountSettings({
    accountId: accountId,
    type: "consumed",
});

    import pulumi
import pulumi_ibm as ibm

consumed = ibm.get_iam_idp_account_settings(account_id=account_id,
    type="consumed")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetIamIdpAccountSettings(ctx, &ibm.GetIamIdpAccountSettingsArgs{
			AccountId: accountId,
			Type:      "consumed",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var consumed = Ibm.GetIamIdpAccountSettings.Invoke(new()
    {
        AccountId = accountId,
        Type = "consumed",
    });

});

    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.GetIamIdpAccountSettingsArgs;
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 consumed = IbmFunctions.getIamIdpAccountSettings(GetIamIdpAccountSettingsArgs.builder()
            .accountId(accountId)
            .type("consumed")
            .build());

    }
}

    variables:
  consumed:
    fn::invoke:
      function: ibm:getIamIdpAccountSettings
      arguments:
        accountId: ${accountId}
        type: consumed

    Example coming soon!

    Output the names of all bound IdPs

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

export const boundIdpNames = .map(idp => (idp.idpName));

    import pulumi

pulumi.export("boundIdpNames", [idp["idpName"] for idp in consumed["idps"]])

    Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    return new Dictionary<string, object?>
    {
        ["boundIdpNames"] = .Select(idp => 
        {
            return idp.IdpName;
        }).ToList(),
    };
});

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Using getIamIdpAccountSettings

    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 getIamIdpAccountSettings(args: GetIamIdpAccountSettingsArgs, opts?: InvokeOptions): Promise<GetIamIdpAccountSettingsResult>
function getIamIdpAccountSettingsOutput(args: GetIamIdpAccountSettingsOutputArgs, opts?: InvokeOptions): Output<GetIamIdpAccountSettingsResult>
    def get_iam_idp_account_settings(account_id: Optional[str] = None,
                                 id: Optional[str] = None,
                                 type: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetIamIdpAccountSettingsResult
def get_iam_idp_account_settings_output(account_id: pulumi.Input[Optional[str]] = None,
                                 id: pulumi.Input[Optional[str]] = None,
                                 type: pulumi.Input[Optional[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetIamIdpAccountSettingsResult]
    func GetIamIdpAccountSettings(ctx *Context, args *GetIamIdpAccountSettingsArgs, opts ...InvokeOption) (*GetIamIdpAccountSettingsResult, error)
func GetIamIdpAccountSettingsOutput(ctx *Context, args *GetIamIdpAccountSettingsOutputArgs, opts ...InvokeOption) GetIamIdpAccountSettingsResultOutput

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

    public static class GetIamIdpAccountSettings 
{
    public static Task<GetIamIdpAccountSettingsResult> InvokeAsync(GetIamIdpAccountSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetIamIdpAccountSettingsResult> Invoke(GetIamIdpAccountSettingsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIamIdpAccountSettingsResult> getIamIdpAccountSettings(GetIamIdpAccountSettingsArgs args, InvokeOptions options)
public static Output<GetIamIdpAccountSettingsResult> getIamIdpAccountSettings(GetIamIdpAccountSettingsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIamIdpAccountSettings:getIamIdpAccountSettings
  arguments:
    # arguments dictionary
    data "ibm_get_iam_idp_account_settings" "name" {
    # arguments
}

    The following arguments are supported:

    AccountId string
    Account ID to retrieve IDP settings for.
    Type string
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    Id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    AccountId string
    Account ID to retrieve IDP settings for.
    Type string
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    Id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    account_id string
    Account ID to retrieve IDP settings for.
    type string
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    accountId String
    Account ID to retrieve IDP settings for.
    type String
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    id String
    The unique identifier of this data source, formed as <account_id>/<type>.
    accountId string
    Account ID to retrieve IDP settings for.
    type string
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    account_id str
    Account ID to retrieve IDP settings for.
    type str
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    id str
    The unique identifier of this data source, formed as <account_id>/<type>.
    accountId String
    Account ID to retrieve IDP settings for.
    type String
    The type of IDP settings to list.

    • Constraints: Allowed values are:
    id String
    The unique identifier of this data source, formed as <account_id>/<type>.

    getIamIdpAccountSettings Result

    The following output properties are available:

    AccountId string
    Id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    Idps List<GetIamIdpAccountSettingsIdp>
    (List) List of IDP account settings. Nested schema for idps:
    Type string
    AccountId string
    Id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    Idps []GetIamIdpAccountSettingsIdp
    (List) List of IDP account settings. Nested schema for idps:
    Type string
    account_id string
    id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    idps list(object)
    (List) List of IDP account settings. Nested schema for idps:
    type string
    accountId String
    id String
    The unique identifier of this data source, formed as <account_id>/<type>.
    idps List<GetIamIdpAccountSettingsIdp>
    (List) List of IDP account settings. Nested schema for idps:
    type String
    accountId string
    id string
    The unique identifier of this data source, formed as <account_id>/<type>.
    idps GetIamIdpAccountSettingsIdp[]
    (List) List of IDP account settings. Nested schema for idps:
    type string
    account_id str
    id str
    The unique identifier of this data source, formed as <account_id>/<type>.
    idps Sequence[GetIamIdpAccountSettingsIdp]
    (List) List of IDP account settings. Nested schema for idps:
    type str
    accountId String
    id String
    The unique identifier of this data source, formed as <account_id>/<type>.
    idps List<Property Map>
    (List) List of IDP account settings. Nested schema for idps:
    type String

    Supporting Types

    GetIamIdpAccountSettingsIdp

    Active bool
    (Boolean) Whether the IdP is enabled for usage in this account.
    CloudUserStrategy string
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    IdpId string
    (String) Identity provider ID.
    IdpName string
    (String) Display name of the Identity Provider.
    IdpType string
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    OwnerAccount string
    (String) ID of the account that owns (created) the IdP.
    OwnerAccountName string
    (String) Display name of the account that owns the IdP.
    UiDefault bool
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.
    Active bool
    (Boolean) Whether the IdP is enabled for usage in this account.
    CloudUserStrategy string
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    IdpId string
    (String) Identity provider ID.
    IdpName string
    (String) Display name of the Identity Provider.
    IdpType string
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    OwnerAccount string
    (String) ID of the account that owns (created) the IdP.
    OwnerAccountName string
    (String) Display name of the account that owns the IdP.
    UiDefault bool
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.
    active bool
    (Boolean) Whether the IdP is enabled for usage in this account.
    cloud_user_strategy string
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    idp_id string
    (String) Identity provider ID.
    idp_name string
    (String) Display name of the Identity Provider.
    idp_type string
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    owner_account string
    (String) ID of the account that owns (created) the IdP.
    owner_account_name string
    (String) Display name of the account that owns the IdP.
    ui_default bool
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.
    active Boolean
    (Boolean) Whether the IdP is enabled for usage in this account.
    cloudUserStrategy String
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    idpId String
    (String) Identity provider ID.
    idpName String
    (String) Display name of the Identity Provider.
    idpType String
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    ownerAccount String
    (String) ID of the account that owns (created) the IdP.
    ownerAccountName String
    (String) Display name of the account that owns the IdP.
    uiDefault Boolean
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.
    active boolean
    (Boolean) Whether the IdP is enabled for usage in this account.
    cloudUserStrategy string
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    idpId string
    (String) Identity provider ID.
    idpName string
    (String) Display name of the Identity Provider.
    idpType string
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    ownerAccount string
    (String) ID of the account that owns (created) the IdP.
    ownerAccountName string
    (String) Display name of the account that owns the IdP.
    uiDefault boolean
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.
    active bool
    (Boolean) Whether the IdP is enabled for usage in this account.
    cloud_user_strategy str
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    idp_id str
    (String) Identity provider ID.
    idp_name str
    (String) Display name of the Identity Provider.
    idp_type str
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    owner_account str
    (String) ID of the account that owns (created) the IdP.
    owner_account_name str
    (String) Display name of the account that owns the IdP.
    ui_default bool
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.
    active Boolean
    (Boolean) Whether the IdP is enabled for usage in this account.
    cloudUserStrategy String
    (String) Strategy for how Cloud User representatives are managed for users of this IdP. Possible values are DYNAMIC, STATIC, NEVER.
    idpId String
    (String) Identity provider ID.
    idpName String
    (String) Display name of the Identity Provider.
    idpType String
    (String) Type of the Identity Provider (e.g. saml, appid, ldap).
    ownerAccount String
    (String) ID of the account that owns (created) the IdP.
    ownerAccountName String
    (String) Display name of the account that owns the IdP.
    uiDefault Boolean
    (Boolean) Whether the IdP is the default login option shown in the IBM Cloud UI for this account.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    Viewing docs for ibm 2.5.0
    published on Wednesday, Aug 5, 2026 by ibm-cloud
    Schema (JSON)
    ibm-cloud/terraform-provider-ibm

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial