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

ibm.getIamAccountSettings

Explore with Pulumi AI

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

    Retrieve information about an existing iam_account_settings data sources. For more information, about IAM account settings, refer to setting up your IBM Cloud.

    Example Usage

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

const iamAccountSettings = ibm.getIamAccountSettings({});

    import pulumi
import pulumi_ibm as ibm

iam_account_settings = ibm.get_iam_account_settings()

    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.LookupIamAccountSettings(ctx, &ibm.LookupIamAccountSettingsArgs{}, 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 iamAccountSettings = Ibm.GetIamAccountSettings.Invoke();

});

    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.GetIamAccountSettingsArgs;
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 iamAccountSettings = IbmFunctions.getIamAccountSettings();

    }
}

    variables:
  iamAccountSettings:
    fn::invoke:
      function: ibm:getIamAccountSettings
      arguments: {}

    Using getIamAccountSettings

    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 getIamAccountSettings(args: GetIamAccountSettingsArgs, opts?: InvokeOptions): Promise<GetIamAccountSettingsResult>
function getIamAccountSettingsOutput(args: GetIamAccountSettingsOutputArgs, opts?: InvokeOptions): Output<GetIamAccountSettingsResult>
    def get_iam_account_settings(id: Optional[str] = None,
                             include_history: Optional[bool] = None,
                             opts: Optional[InvokeOptions] = None) -> GetIamAccountSettingsResult
def get_iam_account_settings_output(id: Optional[pulumi.Input[str]] = None,
                             include_history: Optional[pulumi.Input[bool]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetIamAccountSettingsResult]
    func LookupIamAccountSettings(ctx *Context, args *LookupIamAccountSettingsArgs, opts ...InvokeOption) (*LookupIamAccountSettingsResult, error)
func LookupIamAccountSettingsOutput(ctx *Context, args *LookupIamAccountSettingsOutputArgs, opts ...InvokeOption) LookupIamAccountSettingsResultOutput

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

    public static class GetIamAccountSettings 
{
    public static Task<GetIamAccountSettingsResult> InvokeAsync(GetIamAccountSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetIamAccountSettingsResult> Invoke(GetIamAccountSettingsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIamAccountSettingsResult> getIamAccountSettings(GetIamAccountSettingsArgs args, InvokeOptions options)
public static Output<GetIamAccountSettingsResult> getIamAccountSettings(GetIamAccountSettingsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    (String) The unique identifier of an iam_account_settings.
    IncludeHistory bool
    Defines if the entity history is included in the response.
    Id string
    (String) The unique identifier of an iam_account_settings.
    IncludeHistory bool
    Defines if the entity history is included in the response.
    id String
    (String) The unique identifier of an iam_account_settings.
    includeHistory Boolean
    Defines if the entity history is included in the response.
    id string
    (String) The unique identifier of an iam_account_settings.
    includeHistory boolean
    Defines if the entity history is included in the response.
    id str
    (String) The unique identifier of an iam_account_settings.
    include_history bool
    Defines if the entity history is included in the response.
    id String
    (String) The unique identifier of an iam_account_settings.
    includeHistory Boolean
    Defines if the entity history is included in the response.

    getIamAccountSettings Result

    The following output properties are available:

    AccountId string
    (String) The unique ID of an account.
    AllowedIpAddresses string
    (String) Defines the IP addresses and subnets from which IAM tokens is created for an account.
    EntityTag string
    (String) The version of an account settings.
    Histories List<GetIamAccountSettingsHistory>
    (String) The history of an account settings. Nested history blocks have the following structure. Nested scheme for history:
    Id string
    (String) The unique identifier of an iam_account_settings.
    MaxSessionsPerIdentity string
    (Integer) Defines the maximum allowed sessions per identity required by an account.
    Mfa string
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    RestrictCreatePlatformApikey string
    (String) Defines whether creating platform API keys is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    RestrictCreateServiceId string
    (String) Defines whether creating a service ID is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    SessionExpirationInSeconds string
    (String) Defines the session expiration in seconds for the account. Valid values are Any whole number between between 900 and 86400, and NOT_SET to unset account setting and use the service default.
    SessionInvalidationInSeconds string
    (String) Defines the period of time in seconds in which a session is invalid due to inactivity. Valid values are Any whole number between 900 and 7200, and NOT_SET to unset account setting and use the service default.
    SystemAccessTokenExpirationInSeconds string
    (String) Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 3600.
    SystemRefreshTokenExpirationInSeconds string
    (String) Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 2592000.
    UserMfas List<GetIamAccountSettingsUserMfa>
    (List) List of users that are exempted from the MFA requirement of the account. Nested scheme for user_mfa:
    IncludeHistory bool
    AccountId string
    (String) The unique ID of an account.
    AllowedIpAddresses string
    (String) Defines the IP addresses and subnets from which IAM tokens is created for an account.
    EntityTag string
    (String) The version of an account settings.
    Histories []GetIamAccountSettingsHistory
    (String) The history of an account settings. Nested history blocks have the following structure. Nested scheme for history:
    Id string
    (String) The unique identifier of an iam_account_settings.
    MaxSessionsPerIdentity string
    (Integer) Defines the maximum allowed sessions per identity required by an account.
    Mfa string
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    RestrictCreatePlatformApikey string
    (String) Defines whether creating platform API keys is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    RestrictCreateServiceId string
    (String) Defines whether creating a service ID is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    SessionExpirationInSeconds string
    (String) Defines the session expiration in seconds for the account. Valid values are Any whole number between between 900 and 86400, and NOT_SET to unset account setting and use the service default.
    SessionInvalidationInSeconds string
    (String) Defines the period of time in seconds in which a session is invalid due to inactivity. Valid values are Any whole number between 900 and 7200, and NOT_SET to unset account setting and use the service default.
    SystemAccessTokenExpirationInSeconds string
    (String) Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 3600.
    SystemRefreshTokenExpirationInSeconds string
    (String) Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 2592000.
    UserMfas []GetIamAccountSettingsUserMfa
    (List) List of users that are exempted from the MFA requirement of the account. Nested scheme for user_mfa:
    IncludeHistory bool
    accountId String
    (String) The unique ID of an account.
    allowedIpAddresses String
    (String) Defines the IP addresses and subnets from which IAM tokens is created for an account.
    entityTag String
    (String) The version of an account settings.
    histories List<GetIamAccountSettingsHistory>
    (String) The history of an account settings. Nested history blocks have the following structure. Nested scheme for history:
    id String
    (String) The unique identifier of an iam_account_settings.
    maxSessionsPerIdentity String
    (Integer) Defines the maximum allowed sessions per identity required by an account.
    mfa String
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    restrictCreatePlatformApikey String
    (String) Defines whether creating platform API keys is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    restrictCreateServiceId String
    (String) Defines whether creating a service ID is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    sessionExpirationInSeconds String
    (String) Defines the session expiration in seconds for the account. Valid values are Any whole number between between 900 and 86400, and NOT_SET to unset account setting and use the service default.
    sessionInvalidationInSeconds String
    (String) Defines the period of time in seconds in which a session is invalid due to inactivity. Valid values are Any whole number between 900 and 7200, and NOT_SET to unset account setting and use the service default.
    systemAccessTokenExpirationInSeconds String
    (String) Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 3600.
    systemRefreshTokenExpirationInSeconds String
    (String) Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 2592000.
    userMfas List<GetIamAccountSettingsUserMfa>
    (List) List of users that are exempted from the MFA requirement of the account. Nested scheme for user_mfa:
    includeHistory Boolean
    accountId string
    (String) The unique ID of an account.
    allowedIpAddresses string
    (String) Defines the IP addresses and subnets from which IAM tokens is created for an account.
    entityTag string
    (String) The version of an account settings.
    histories GetIamAccountSettingsHistory[]
    (String) The history of an account settings. Nested history blocks have the following structure. Nested scheme for history:
    id string
    (String) The unique identifier of an iam_account_settings.
    maxSessionsPerIdentity string
    (Integer) Defines the maximum allowed sessions per identity required by an account.
    mfa string
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    restrictCreatePlatformApikey string
    (String) Defines whether creating platform API keys is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    restrictCreateServiceId string
    (String) Defines whether creating a service ID is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    sessionExpirationInSeconds string
    (String) Defines the session expiration in seconds for the account. Valid values are Any whole number between between 900 and 86400, and NOT_SET to unset account setting and use the service default.
    sessionInvalidationInSeconds string
    (String) Defines the period of time in seconds in which a session is invalid due to inactivity. Valid values are Any whole number between 900 and 7200, and NOT_SET to unset account setting and use the service default.
    systemAccessTokenExpirationInSeconds string
    (String) Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 3600.
    systemRefreshTokenExpirationInSeconds string
    (String) Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 2592000.
    userMfas GetIamAccountSettingsUserMfa[]
    (List) List of users that are exempted from the MFA requirement of the account. Nested scheme for user_mfa:
    includeHistory boolean
    account_id str
    (String) The unique ID of an account.
    allowed_ip_addresses str
    (String) Defines the IP addresses and subnets from which IAM tokens is created for an account.
    entity_tag str
    (String) The version of an account settings.
    histories Sequence[GetIamAccountSettingsHistory]
    (String) The history of an account settings. Nested history blocks have the following structure. Nested scheme for history:
    id str
    (String) The unique identifier of an iam_account_settings.
    max_sessions_per_identity str
    (Integer) Defines the maximum allowed sessions per identity required by an account.
    mfa str
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    restrict_create_platform_apikey str
    (String) Defines whether creating platform API keys is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    restrict_create_service_id str
    (String) Defines whether creating a service ID is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    session_expiration_in_seconds str
    (String) Defines the session expiration in seconds for the account. Valid values are Any whole number between between 900 and 86400, and NOT_SET to unset account setting and use the service default.
    session_invalidation_in_seconds str
    (String) Defines the period of time in seconds in which a session is invalid due to inactivity. Valid values are Any whole number between 900 and 7200, and NOT_SET to unset account setting and use the service default.
    system_access_token_expiration_in_seconds str
    (String) Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 3600.
    system_refresh_token_expiration_in_seconds str
    (String) Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 2592000.
    user_mfas Sequence[GetIamAccountSettingsUserMfa]
    (List) List of users that are exempted from the MFA requirement of the account. Nested scheme for user_mfa:
    include_history bool
    accountId String
    (String) The unique ID of an account.
    allowedIpAddresses String
    (String) Defines the IP addresses and subnets from which IAM tokens is created for an account.
    entityTag String
    (String) The version of an account settings.
    histories List<Property Map>
    (String) The history of an account settings. Nested history blocks have the following structure. Nested scheme for history:
    id String
    (String) The unique identifier of an iam_account_settings.
    maxSessionsPerIdentity String
    (Integer) Defines the maximum allowed sessions per identity required by an account.
    mfa String
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    restrictCreatePlatformApikey String
    (String) Defines whether creating platform API keys is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    restrictCreateServiceId String
    (String) Defines whether creating a service ID is access controlled. Valid values are RESTRICTED to apply access control. NOT_RESTRICTED to remove access control. NOT_SET to unset a previous set value.
    sessionExpirationInSeconds String
    (String) Defines the session expiration in seconds for the account. Valid values are Any whole number between between 900 and 86400, and NOT_SET to unset account setting and use the service default.
    sessionInvalidationInSeconds String
    (String) Defines the period of time in seconds in which a session is invalid due to inactivity. Valid values are Any whole number between 900 and 7200, and NOT_SET to unset account setting and use the service default.
    systemAccessTokenExpirationInSeconds String
    (String) Defines the access token expiration in seconds. Valid values: * Any whole number between '900' and '3600' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 3600.
    systemRefreshTokenExpirationInSeconds String
    (String) Defines the refresh token expiration in seconds. Valid values: * Any whole number between '900' and '2592000' * NOT_SET - To unset account setting and use service default.

    • Constraints: The default value is 2592000.
    userMfas List<Property Map>
    (List) List of users that are exempted from the MFA requirement of the account. Nested scheme for user_mfa:
    includeHistory Boolean

    Supporting Types

    GetIamAccountSettingsHistory

    Action string
    (String) The action of the history entry.
    IamId string
    (String) The iam_id of the user.
    IamIdAccount string
    (String) The account of an identity that trigger an action.- params - (String) The parameters of the history entry.
    Message string
    (String) The message that summarizes the executed action.
    Params List<string>
    (String) Params of the history entry.
    Timestamp string
    (String) The timestamp when an action is triggered.
    Action string
    (String) The action of the history entry.
    IamId string
    (String) The iam_id of the user.
    IamIdAccount string
    (String) The account of an identity that trigger an action.- params - (String) The parameters of the history entry.
    Message string
    (String) The message that summarizes the executed action.
    Params []string
    (String) Params of the history entry.
    Timestamp string
    (String) The timestamp when an action is triggered.
    action String
    (String) The action of the history entry.
    iamId String
    (String) The iam_id of the user.
    iamIdAccount String
    (String) The account of an identity that trigger an action.- params - (String) The parameters of the history entry.
    message String
    (String) The message that summarizes the executed action.
    params List<String>
    (String) Params of the history entry.
    timestamp String
    (String) The timestamp when an action is triggered.
    action string
    (String) The action of the history entry.
    iamId string
    (String) The iam_id of the user.
    iamIdAccount string
    (String) The account of an identity that trigger an action.- params - (String) The parameters of the history entry.
    message string
    (String) The message that summarizes the executed action.
    params string[]
    (String) Params of the history entry.
    timestamp string
    (String) The timestamp when an action is triggered.
    action str
    (String) The action of the history entry.
    iam_id str
    (String) The iam_id of the user.
    iam_id_account str
    (String) The account of an identity that trigger an action.- params - (String) The parameters of the history entry.
    message str
    (String) The message that summarizes the executed action.
    params Sequence[str]
    (String) Params of the history entry.
    timestamp str
    (String) The timestamp when an action is triggered.
    action String
    (String) The action of the history entry.
    iamId String
    (String) The iam_id of the user.
    iamIdAccount String
    (String) The account of an identity that trigger an action.- params - (String) The parameters of the history entry.
    message String
    (String) The message that summarizes the executed action.
    params List<String>
    (String) Params of the history entry.
    timestamp String
    (String) The timestamp when an action is triggered.

    GetIamAccountSettingsUserMfa

    IamId string
    (String) The iam_id of the user.
    Mfa string
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    IamId string
    (String) The iam_id of the user.
    Mfa string
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    iamId String
    (String) The iam_id of the user.
    mfa String
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    iamId string
    (String) The iam_id of the user.
    mfa string
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    iam_id str
    (String) The iam_id of the user.
    mfa str
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.
    iamId String
    (String) The iam_id of the user.
    mfa String
    (String) Defines the MFA requirement for the user. Valid values are NONE No MFA trait set. TOTP For all non-federated IBMID users TOTP4ALL For all users. LEVEL1 The Email based MFA for all users. LEVEL2 TOTP based MFA for all users. LEVEL3 U2F MFA for all users.

    Package Details

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