pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/GitlabFunctions/getUsers

getUsers

suspend fun getUsers(argument: GetUsersPlainArgs): GetUsersResult

The gitlab.getUsers data source allows details of multiple users to be retrieved given some optional filter criteria.

Some attributes might not be returned depending on if you're an admin or not. Some available options require administrator privileges. Upstream API: GitLab REST API docs

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.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 example = GitlabFunctions.getUsers(GetUsersArgs.builder()
            .createdBefore("2019-01-01")
            .orderBy("name")
            .sort("desc")
            .build());
        final var example-two = GitlabFunctions.getUsers(GetUsersArgs.builder()
            .search("username")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getUsers.

Parameters

argument

A collection of arguments for invoking getUsers.

suspend fun getUsers(active: Boolean? = null, blocked: Boolean? = null, createdAfter: String? = null, createdBefore: String? = null, externProvider: String? = null, externUid: String? = null, orderBy: String? = null, search: String? = null, sort: String? = null): GetUsersResult

Return

A collection of values returned by getUsers.

Parameters

active

Filter users that are active.

blocked

Filter users that are blocked.

createdAfter

Search for users created after a specific date. (Requires administrator privileges)

createdBefore

Search for users created before a specific date. (Requires administrator privileges)

externProvider

Lookup users by external provider. (Requires administrator privileges)

externUid

Lookup users by external UID. (Requires administrator privileges)

orderBy

Order the users' list by id, name, username, created_at or updated_at. (Requires administrator privileges)

search

Search users by username, name or email.

sort

Sort users' list in asc or desc order. (Requires administrator privileges)

See also

.

suspend fun getUsers(argument: suspend GetUsersPlainArgsBuilder.() -> Unit): GetUsersResult

Return

A collection of values returned by getUsers.

Parameters

argument

Builder for com.pulumi.gitlab.kotlin.inputs.GetUsersPlainArgs.

See also

.