1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIamUsers
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getIamUsers

Explore with Pulumi AI

Retrieve information about an IAM user profile on IBM Cloud as a read-only data source. For more information, about IAM users profile information, see assigning access to account management services.

Example Usage

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

const usersProfiles = ibm.getIamUsers({});
Copy
import pulumi
import pulumi_ibm as ibm

users_profiles = ibm.get_iam_users()
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.GetIamUsers(ctx, &ibm.GetIamUsersArgs{}, 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 usersProfiles = Ibm.GetIamUsers.Invoke();

});
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.GetIamUsersArgs;
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 usersProfiles = IbmFunctions.getIamUsers();

    }
}
Copy
variables:
  usersProfiles:
    fn::invoke:
      function: ibm:getIamUsers
      arguments: {}
Copy

Using getIamUsers

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 getIamUsers(args: GetIamUsersArgs, opts?: InvokeOptions): Promise<GetIamUsersResult>
function getIamUsersOutput(args: GetIamUsersOutputArgs, opts?: InvokeOptions): Output<GetIamUsersResult>
Copy
def get_iam_users(id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetIamUsersResult
def get_iam_users_output(id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetIamUsersResult]
Copy
func GetIamUsers(ctx *Context, args *GetIamUsersArgs, opts ...InvokeOption) (*GetIamUsersResult, error)
func GetIamUsersOutput(ctx *Context, args *GetIamUsersOutputArgs, opts ...InvokeOption) GetIamUsersResultOutput
Copy

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

public static class GetIamUsers 
{
    public static Task<GetIamUsersResult> InvokeAsync(GetIamUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetIamUsersResult> Invoke(GetIamUsersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIamUsersResult> getIamUsers(GetIamUsersArgs args, InvokeOptions options)
public static Output<GetIamUsersResult> getIamUsers(GetIamUsersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIamUsers:getIamUsers
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
(String) The unique identifier user.
Id string
(String) The unique identifier user.
id String
(String) The unique identifier user.
id string
(String) The unique identifier user.
id str
(String) The unique identifier user.
id String
(String) The unique identifier user.

getIamUsers Result

The following output properties are available:

Id string
(String) The unique identifier user.
Users List<GetIamUsersUser>
(String) List of all IAM users. Each user profile has following list of arguments.
Id string
(String) The unique identifier user.
Users []GetIamUsersUser
(String) List of all IAM users. Each user profile has following list of arguments.
id String
(String) The unique identifier user.
users List<GetIamUsersUser>
(String) List of all IAM users. Each user profile has following list of arguments.
id string
(String) The unique identifier user.
users GetIamUsersUser[]
(String) List of all IAM users. Each user profile has following list of arguments.
id str
(String) The unique identifier user.
users Sequence[GetIamUsersUser]
(String) List of all IAM users. Each user profile has following list of arguments.
id String
(String) The unique identifier user.
users List<Property Map>
(String) List of all IAM users. Each user profile has following list of arguments.

Supporting Types

GetIamUsersUser

AccountId This property is required. string
(String) The account ID of the user.
AltPhonenumber This property is required. string
Email This property is required. string
(String) The email of the user.
FirstName This property is required. string
IamId This property is required. string
(String) The ID of the IAM user.
LastName This property is required. string
Phonenumber This property is required. string
(String) The phone for the user.
Realm This property is required. string
(String) The realm of the user.
State This property is required. string
(String) The state of the user.
UserId This property is required. string
(String) The user ID used for log in.
AccountId This property is required. string
(String) The account ID of the user.
AltPhonenumber This property is required. string
Email This property is required. string
(String) The email of the user.
FirstName This property is required. string
IamId This property is required. string
(String) The ID of the IAM user.
LastName This property is required. string
Phonenumber This property is required. string
(String) The phone for the user.
Realm This property is required. string
(String) The realm of the user.
State This property is required. string
(String) The state of the user.
UserId This property is required. string
(String) The user ID used for log in.
accountId This property is required. String
(String) The account ID of the user.
altPhonenumber This property is required. String
email This property is required. String
(String) The email of the user.
firstName This property is required. String
iamId This property is required. String
(String) The ID of the IAM user.
lastName This property is required. String
phonenumber This property is required. String
(String) The phone for the user.
realm This property is required. String
(String) The realm of the user.
state This property is required. String
(String) The state of the user.
userId This property is required. String
(String) The user ID used for log in.
accountId This property is required. string
(String) The account ID of the user.
altPhonenumber This property is required. string
email This property is required. string
(String) The email of the user.
firstName This property is required. string
iamId This property is required. string
(String) The ID of the IAM user.
lastName This property is required. string
phonenumber This property is required. string
(String) The phone for the user.
realm This property is required. string
(String) The realm of the user.
state This property is required. string
(String) The state of the user.
userId This property is required. string
(String) The user ID used for log in.
account_id This property is required. str
(String) The account ID of the user.
alt_phonenumber This property is required. str
email This property is required. str
(String) The email of the user.
first_name This property is required. str
iam_id This property is required. str
(String) The ID of the IAM user.
last_name This property is required. str
phonenumber This property is required. str
(String) The phone for the user.
realm This property is required. str
(String) The realm of the user.
state This property is required. str
(String) The state of the user.
user_id This property is required. str
(String) The user ID used for log in.
accountId This property is required. String
(String) The account ID of the user.
altPhonenumber This property is required. String
email This property is required. String
(String) The email of the user.
firstName This property is required. String
iamId This property is required. String
(String) The ID of the IAM user.
lastName This property is required. String
phonenumber This property is required. String
(String) The phone for the user.
realm This property is required. String
(String) The realm of the user.
state This property is required. String
(String) The state of the user.
userId This property is required. String
(String) The user ID used for log in.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.