1. Packages
  2. Volcengine
  3. API Docs
  4. iam
  5. getUsers
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.iam.getUsers

volcengine logo
Viewing docs for Volcengine v0.0.47
published on Friday, Mar 13, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of iam users

    Example Usage

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

const default = volcengine.iam.getUsers({
    query: "jonny",
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.iam.get_users(query="jonny")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/iam"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.GetUsers(ctx, &iam.GetUsersArgs{
			Query: pulumi.StringRef("jonny"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Iam.GetUsers.Invoke(new()
    {
        Query = "jonny",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.iam.IamFunctions;
import com.pulumi.volcengine.iam.inputs.GetUsersArgs;
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 default = IamFunctions.getUsers(GetUsersArgs.builder()
            .query("jonny")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:iam:getUsers
      Arguments:
        query: jonny

    Using getUsers

    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 getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>
    def get_users(output_file: Optional[str] = None,
              query: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(output_file: Optional[pulumi.Input[str]] = None,
              query: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]
    func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

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

    public static class GetUsers 
{
    public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:iam/getUsers:getUsers
  arguments:
    # arguments dictionary

    The following arguments are supported:

    OutputFile string
    File name where to save data source results.
    Query string
    Fuzzy query. Can query by user name, display name or description.
    OutputFile string
    File name where to save data source results.
    Query string
    Fuzzy query. Can query by user name, display name or description.
    outputFile String
    File name where to save data source results.
    query String
    Fuzzy query. Can query by user name, display name or description.
    outputFile string
    File name where to save data source results.
    query string
    Fuzzy query. Can query by user name, display name or description.
    output_file str
    File name where to save data source results.
    query str
    Fuzzy query. Can query by user name, display name or description.
    outputFile String
    File name where to save data source results.
    query String
    Fuzzy query. Can query by user name, display name or description.

    getUsers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of user query.
    Users List<GetUsersUser>
    The collection of user.
    OutputFile string
    Query string
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of user query.
    Users []GetUsersUser
    The collection of user.
    OutputFile string
    Query string
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of user query.
    users List<GetUsersUser>
    The collection of user.
    outputFile String
    query String
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of user query.
    users GetUsersUser[]
    The collection of user.
    outputFile string
    query string
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of user query.
    users Sequence[GetUsersUser]
    The collection of user.
    output_file str
    query str
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of user query.
    users List<Property Map>
    The collection of user.
    outputFile String
    query String

    Supporting Types

    GetUsersUser

    AccountId string
    Main account ID to which the sub-user belongs.
    CreateDate string
    The create date of the user.
    Description string
    The description of the user.
    DisplayName string
    The display name of the user.
    Email string
    The email of the user.
    EmailIsVerify bool
    Whether the email has been verified.
    MobilePhone string
    The mobile phone of the user.
    MobilePhoneIsVerify bool
    Whether the phone number has been verified.
    Trn string
    The trn of the user.
    UpdateDate string
    The update date of the user.
    UserId string
    The id of the user.
    UserName string
    The name of the user.
    Tags List<GetUsersUserTag>
    Tags.
    AccountId string
    Main account ID to which the sub-user belongs.
    CreateDate string
    The create date of the user.
    Description string
    The description of the user.
    DisplayName string
    The display name of the user.
    Email string
    The email of the user.
    EmailIsVerify bool
    Whether the email has been verified.
    MobilePhone string
    The mobile phone of the user.
    MobilePhoneIsVerify bool
    Whether the phone number has been verified.
    Trn string
    The trn of the user.
    UpdateDate string
    The update date of the user.
    UserId string
    The id of the user.
    UserName string
    The name of the user.
    Tags []GetUsersUserTag
    Tags.
    accountId String
    Main account ID to which the sub-user belongs.
    createDate String
    The create date of the user.
    description String
    The description of the user.
    displayName String
    The display name of the user.
    email String
    The email of the user.
    emailIsVerify Boolean
    Whether the email has been verified.
    mobilePhone String
    The mobile phone of the user.
    mobilePhoneIsVerify Boolean
    Whether the phone number has been verified.
    trn String
    The trn of the user.
    updateDate String
    The update date of the user.
    userId String
    The id of the user.
    userName String
    The name of the user.
    tags List<GetUsersUserTag>
    Tags.
    accountId string
    Main account ID to which the sub-user belongs.
    createDate string
    The create date of the user.
    description string
    The description of the user.
    displayName string
    The display name of the user.
    email string
    The email of the user.
    emailIsVerify boolean
    Whether the email has been verified.
    mobilePhone string
    The mobile phone of the user.
    mobilePhoneIsVerify boolean
    Whether the phone number has been verified.
    trn string
    The trn of the user.
    updateDate string
    The update date of the user.
    userId string
    The id of the user.
    userName string
    The name of the user.
    tags GetUsersUserTag[]
    Tags.
    account_id str
    Main account ID to which the sub-user belongs.
    create_date str
    The create date of the user.
    description str
    The description of the user.
    display_name str
    The display name of the user.
    email str
    The email of the user.
    email_is_verify bool
    Whether the email has been verified.
    mobile_phone str
    The mobile phone of the user.
    mobile_phone_is_verify bool
    Whether the phone number has been verified.
    trn str
    The trn of the user.
    update_date str
    The update date of the user.
    user_id str
    The id of the user.
    user_name str
    The name of the user.
    tags Sequence[GetUsersUserTag]
    Tags.
    accountId String
    Main account ID to which the sub-user belongs.
    createDate String
    The create date of the user.
    description String
    The description of the user.
    displayName String
    The display name of the user.
    email String
    The email of the user.
    emailIsVerify Boolean
    Whether the email has been verified.
    mobilePhone String
    The mobile phone of the user.
    mobilePhoneIsVerify Boolean
    Whether the phone number has been verified.
    trn String
    The trn of the user.
    updateDate String
    The update date of the user.
    userId String
    The id of the user.
    userName String
    The name of the user.
    tags List<Property Map>
    Tags.

    GetUsersUserTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Viewing docs for Volcengine v0.0.47
    published on Friday, Mar 13, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Try Pulumi Cloud free. Your team will thank you.