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

ibm.IamIdpAccountSetting

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

    Create, update, and delete the binding of a shared IAM Identity Provider (IdP) to a consuming IBM Cloud account. This resource uses the IDP sharing feature — the IdP must first exist in an owner account (created via ibm.IamIdp) and its share_scope must include the target account before it can be bound.

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

    Example Usage

    Bind a shared IdP to a consumer account

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

// The IdP is created in the owner account and shared with the consumer
const sharedIdp = new ibm.IamIdp("shared_idp", {
    accountId: ownerAccountId,
    name: "shared-saml-idp",
    type: "saml",
    active: true,
    shareScopes: [{
        id: consumerAccountId,
        type: "account",
    }],
});
// Bind the shared IdP to the consumer account
const consumerBinding = new ibm.IamIdpAccountSetting("consumer_binding", {
    accountId: consumerAccountId,
    idpId: sharedIdp.idpId,
    cloudUserStrategy: "DYNAMIC",
    active: true,
    uiDefault: true,
});

    import pulumi
import pulumi_ibm as ibm

# The IdP is created in the owner account and shared with the consumer
shared_idp = ibm.IamIdp("shared_idp",
    account_id=owner_account_id,
    name="shared-saml-idp",
    type="saml",
    active=True,
    share_scopes=[{
        "id": consumer_account_id,
        "type": "account",
    }])
# Bind the shared IdP to the consumer account
consumer_binding = ibm.IamIdpAccountSetting("consumer_binding",
    account_id=consumer_account_id,
    idp_id=shared_idp.idp_id,
    cloud_user_strategy="DYNAMIC",
    active=True,
    ui_default=True)

    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 {
		// The IdP is created in the owner account and shared with the consumer
		sharedIdp, err := ibm.NewIamIdp(ctx, "shared_idp", &ibm.IamIdpArgs{
			AccountId: pulumi.Any(ownerAccountId),
			Name:      pulumi.String("shared-saml-idp"),
			Type:      pulumi.String("saml"),
			Active:    pulumi.Bool(true),
			ShareScopes: ibm.IamIdpShareScopeArray{
				&ibm.IamIdpShareScopeArgs{
					Id:   pulumi.Any(consumerAccountId),
					Type: pulumi.String("account"),
				},
			},
		})
		if err != nil {
			return err
		}
		// Bind the shared IdP to the consumer account
		_, err = ibm.NewIamIdpAccountSetting(ctx, "consumer_binding", &ibm.IamIdpAccountSettingArgs{
			AccountId:         pulumi.Any(consumerAccountId),
			IdpId:             sharedIdp.IdpId,
			CloudUserStrategy: pulumi.String("DYNAMIC"),
			Active:            pulumi.Bool(true),
			UiDefault:         pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // The IdP is created in the owner account and shared with the consumer
    var sharedIdp = new Ibm.IamIdp("shared_idp", new()
    {
        AccountId = ownerAccountId,
        Name = "shared-saml-idp",
        Type = "saml",
        Active = true,
        ShareScopes = new[]
        {
            new Ibm.Inputs.IamIdpShareScopeArgs
            {
                Id = consumerAccountId,
                Type = "account",
            },
        },
    });

    // Bind the shared IdP to the consumer account
    var consumerBinding = new Ibm.IamIdpAccountSetting("consumer_binding", new()
    {
        AccountId = consumerAccountId,
        IdpId = sharedIdp.IdpId,
        CloudUserStrategy = "DYNAMIC",
        Active = true,
        UiDefault = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IamIdp;
import com.pulumi.ibm.IamIdpArgs;
import com.pulumi.ibm.inputs.IamIdpShareScopeArgs;
import com.pulumi.ibm.IamIdpAccountSetting;
import com.pulumi.ibm.IamIdpAccountSettingArgs;
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) {
        // The IdP is created in the owner account and shared with the consumer
        var sharedIdp = new IamIdp("sharedIdp", IamIdpArgs.builder()
            .accountId(ownerAccountId)
            .name("shared-saml-idp")
            .type("saml")
            .active(true)
            .shareScopes(IamIdpShareScopeArgs.builder()
                .id(consumerAccountId)
                .type("account")
                .build())
            .build());

        // Bind the shared IdP to the consumer account
        var consumerBinding = new IamIdpAccountSetting("consumerBinding", IamIdpAccountSettingArgs.builder()
            .accountId(consumerAccountId)
            .idpId(sharedIdp.idpId())
            .cloudUserStrategy("DYNAMIC")
            .active(true)
            .uiDefault(true)
            .build());

    }
}

    resources:
  # The IdP is created in the owner account and shared with the consumer
  sharedIdp:
    type: ibm:IamIdp
    name: shared_idp
    properties:
      accountId: ${ownerAccountId}
      name: shared-saml-idp
      type: saml
      active: true
      shareScopes:
        - id: ${consumerAccountId}
          type: account
  # Bind the shared IdP to the consumer account
  consumerBinding:
    type: ibm:IamIdpAccountSetting
    name: consumer_binding
    properties:
      accountId: ${consumerAccountId}
      idpId: ${sharedIdp.idpId}
      cloudUserStrategy: DYNAMIC
      active: true
      uiDefault: true

    Example coming soon!

    Bind with static user strategy

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

const staticBinding = new ibm.IamIdpAccountSetting("static_binding", {
    accountId: accountId,
    idpId: sharedIdpId,
    cloudUserStrategy: "STATIC",
    active: true,
    uiDefault: false,
});

    import pulumi
import pulumi_ibm as ibm

static_binding = ibm.IamIdpAccountSetting("static_binding",
    account_id=account_id,
    idp_id=shared_idp_id,
    cloud_user_strategy="STATIC",
    active=True,
    ui_default=False)

    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.NewIamIdpAccountSetting(ctx, "static_binding", &ibm.IamIdpAccountSettingArgs{
			AccountId:         pulumi.Any(accountId),
			IdpId:             pulumi.Any(sharedIdpId),
			CloudUserStrategy: pulumi.String("STATIC"),
			Active:            pulumi.Bool(true),
			UiDefault:         pulumi.Bool(false),
		})
		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 staticBinding = new Ibm.IamIdpAccountSetting("static_binding", new()
    {
        AccountId = accountId,
        IdpId = sharedIdpId,
        CloudUserStrategy = "STATIC",
        Active = true,
        UiDefault = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IamIdpAccountSetting;
import com.pulumi.ibm.IamIdpAccountSettingArgs;
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 staticBinding = new IamIdpAccountSetting("staticBinding", IamIdpAccountSettingArgs.builder()
            .accountId(accountId)
            .idpId(sharedIdpId)
            .cloudUserStrategy("STATIC")
            .active(true)
            .uiDefault(false)
            .build());

    }
}

    resources:
  staticBinding:
    type: ibm:IamIdpAccountSetting
    name: static_binding
    properties:
      accountId: ${accountId}
      idpId: ${sharedIdpId}
      cloudUserStrategy: STATIC
      active: true
      uiDefault: false

    Example coming soon!

    Create IamIdpAccountSetting Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IamIdpAccountSetting(name: string, args: IamIdpAccountSettingArgs, opts?: CustomResourceOptions);
    @overload
def IamIdpAccountSetting(resource_name: str,
                         args: IamIdpAccountSettingArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def IamIdpAccountSetting(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_id: Optional[str] = None,
                         active: Optional[bool] = None,
                         cloud_user_strategy: Optional[str] = None,
                         idp_id: Optional[str] = None,
                         ui_default: Optional[bool] = None,
                         iam_idp_account_setting_id: Optional[str] = None)
    func NewIamIdpAccountSetting(ctx *Context, name string, args IamIdpAccountSettingArgs, opts ...ResourceOption) (*IamIdpAccountSetting, error)
    public IamIdpAccountSetting(string name, IamIdpAccountSettingArgs args, CustomResourceOptions? opts = null)
    public IamIdpAccountSetting(String name, IamIdpAccountSettingArgs args)
public IamIdpAccountSetting(String name, IamIdpAccountSettingArgs args, CustomResourceOptions options)

    type: ibm:IamIdpAccountSetting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "ibm_iam_idp_account_setting" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IamIdpAccountSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IamIdpAccountSettingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IamIdpAccountSettingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamIdpAccountSettingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamIdpAccountSettingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var iamIdpAccountSettingResource = new Ibm.IamIdpAccountSetting("iamIdpAccountSettingResource", new()
{
    AccountId = "string",
    Active = false,
    CloudUserStrategy = "string",
    IdpId = "string",
    UiDefault = false,
    IamIdpAccountSettingId = "string",
});

    example, err := ibm.NewIamIdpAccountSetting(ctx, "iamIdpAccountSettingResource", &ibm.IamIdpAccountSettingArgs{
	AccountId:              pulumi.String("string"),
	Active:                 pulumi.Bool(false),
	CloudUserStrategy:      pulumi.String("string"),
	IdpId:                  pulumi.String("string"),
	UiDefault:              pulumi.Bool(false),
	IamIdpAccountSettingId: pulumi.String("string"),
})

    resource "ibm_iam_idp_account_setting" "iamIdpAccountSettingResource" {
  lifecycle {
    create_before_destroy = true
  }
  account_id                 = "string"
  active                     = false
  cloud_user_strategy        = "string"
  idp_id                     = "string"
  ui_default                 = false
  iam_idp_account_setting_id = "string"
}

    var iamIdpAccountSettingResource = new IamIdpAccountSetting("iamIdpAccountSettingResource", IamIdpAccountSettingArgs.builder()
    .accountId("string")
    .active(false)
    .cloudUserStrategy("string")
    .idpId("string")
    .uiDefault(false)
    .iamIdpAccountSettingId("string")
    .build());

    iam_idp_account_setting_resource = ibm.IamIdpAccountSetting("iamIdpAccountSettingResource",
    account_id="string",
    active=False,
    cloud_user_strategy="string",
    idp_id="string",
    ui_default=False,
    iam_idp_account_setting_id="string")

    const iamIdpAccountSettingResource = new ibm.IamIdpAccountSetting("iamIdpAccountSettingResource", {
    accountId: "string",
    active: false,
    cloudUserStrategy: "string",
    idpId: "string",
    uiDefault: false,
    iamIdpAccountSettingId: "string",
});

    type: ibm:IamIdpAccountSetting
properties:
    accountId: string
    active: false
    cloudUserStrategy: string
    iamIdpAccountSettingId: string
    idpId: string
    uiDefault: false

    IamIdpAccountSetting Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IamIdpAccountSetting resource accepts the following input properties:

    AccountId string
    Account to bind the IdP to. Changing this value creates a new resource.
    Active bool
    Specifies if the IdP is enabled for usage in the given account context.
    CloudUserStrategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    IdpId string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    UiDefault bool
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    IamIdpAccountSettingId string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    AccountId string
    Account to bind the IdP to. Changing this value creates a new resource.
    Active bool
    Specifies if the IdP is enabled for usage in the given account context.
    CloudUserStrategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    IdpId string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    UiDefault bool
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    IamIdpAccountSettingId string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    account_id string
    Account to bind the IdP to. Changing this value creates a new resource.
    active bool
    Specifies if the IdP is enabled for usage in the given account context.
    cloud_user_strategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    idp_id string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    ui_default bool
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    iam_idp_account_setting_id string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    accountId String
    Account to bind the IdP to. Changing this value creates a new resource.
    active Boolean
    Specifies if the IdP is enabled for usage in the given account context.
    cloudUserStrategy String
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    idpId String
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    uiDefault Boolean
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    iamIdpAccountSettingId String
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    accountId string
    Account to bind the IdP to. Changing this value creates a new resource.
    active boolean
    Specifies if the IdP is enabled for usage in the given account context.
    cloudUserStrategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    idpId string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    uiDefault boolean
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    iamIdpAccountSettingId string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    account_id str
    Account to bind the IdP to. Changing this value creates a new resource.
    active bool
    Specifies if the IdP is enabled for usage in the given account context.
    cloud_user_strategy str
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    idp_id str
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    ui_default bool
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    iam_idp_account_setting_id str
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    accountId String
    Account to bind the IdP to. Changing this value creates a new resource.
    active Boolean
    Specifies if the IdP is enabled for usage in the given account context.
    cloudUserStrategy String
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    idpId String
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    uiDefault Boolean
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    iamIdpAccountSettingId String
    The unique identifier of the binding, formed as <account_id>/<idp_id>.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IamIdpAccountSetting resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing IamIdpAccountSetting Resource

    Get an existing IamIdpAccountSetting resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IamIdpAccountSettingState, opts?: CustomResourceOptions): IamIdpAccountSetting
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        active: Optional[bool] = None,
        cloud_user_strategy: Optional[str] = None,
        iam_idp_account_setting_id: Optional[str] = None,
        idp_id: Optional[str] = None,
        idp_name: Optional[str] = None,
        idp_type: Optional[str] = None,
        owner_account: Optional[str] = None,
        owner_account_name: Optional[str] = None,
        ui_default: Optional[bool] = None) -> IamIdpAccountSetting
    func GetIamIdpAccountSetting(ctx *Context, name string, id IDInput, state *IamIdpAccountSettingState, opts ...ResourceOption) (*IamIdpAccountSetting, error)
    public static IamIdpAccountSetting Get(string name, Input<string> id, IamIdpAccountSettingState? state, CustomResourceOptions? opts = null)
    public static IamIdpAccountSetting get(String name, Output<String> id, IamIdpAccountSettingState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IamIdpAccountSetting    get:      id: ${id}
    import {
  to = ibm_iam_idp_account_setting.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Account to bind the IdP to. Changing this value creates a new resource.
    Active bool
    Specifies if the IdP is enabled for usage in the given account context.
    CloudUserStrategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    IamIdpAccountSettingId string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    IdpId string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    AccountId string
    Account to bind the IdP to. Changing this value creates a new resource.
    Active bool
    Specifies if the IdP is enabled for usage in the given account context.
    CloudUserStrategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    IamIdpAccountSettingId string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    IdpId string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    account_id string
    Account to bind the IdP to. Changing this value creates a new resource.
    active bool
    Specifies if the IdP is enabled for usage in the given account context.
    cloud_user_strategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    iam_idp_account_setting_id string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    idp_id string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    accountId String
    Account to bind the IdP to. Changing this value creates a new resource.
    active Boolean
    Specifies if the IdP is enabled for usage in the given account context.
    cloudUserStrategy String
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    iamIdpAccountSettingId String
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    idpId String
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    accountId string
    Account to bind the IdP to. Changing this value creates a new resource.
    active boolean
    Specifies if the IdP is enabled for usage in the given account context.
    cloudUserStrategy string
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    iamIdpAccountSettingId string
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    idpId string
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    account_id str
    Account to bind the IdP to. Changing this value creates a new resource.
    active bool
    Specifies if the IdP is enabled for usage in the given account context.
    cloud_user_strategy str
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    iam_idp_account_setting_id str
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    idp_id str
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.
    accountId String
    Account to bind the IdP to. Changing this value creates a new resource.
    active Boolean
    Specifies if the IdP is enabled for usage in the given account context.
    cloudUserStrategy String
    Strategy for how Cloud User representatives are managed for the IdP users.

    • Constraints: Allowed values are:
    • DYNAMIC - Cloud User records are created automatically on first login.
    • STATIC - Cloud User records must be pre-provisioned.
    • NEVER - No Cloud User records are created; users cannot log in to IBM Cloud resources.
    iamIdpAccountSettingId String
    The unique identifier of the binding, formed as <account_id>/<idp_id>.
    idpId String
    Identity provider ID to bind to the account. The IdP must be shared with this account via its share_scope. Changing this value creates a new resource.
    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
    Specifies if the IdP is presented as the default login option in the IBM Cloud UI for this account.

    Import

    You can import the ibm_iam_idp_account_setting resource by using id.

    The id property is formed from account_id and idp_id in the following format:

    
<account_id>/<idp_id>

    • account_id: A string. Account bound to the IDP.

    • idp_id: A string. Identity provider ID.

    Syntax

    
```sh
$ pulumi import ibm:index/iamIdpAccountSetting:IamIdpAccountSetting my_binding <account_id>/<idp_id>
```

    Example

    
```sh
$ pulumi import ibm:index/iamIdpAccountSetting:IamIdpAccountSetting my_binding abc123def456/a1b2c3d4-e5f6-7890-abcd-ef1234567890
```

    To learn more about importing existing cloud resources, see Importing resources.

    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