snowflake.getUsers

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

Data source used to get details of filtered users. Filtering is aligned with the current possibilities for SHOW USERS query. The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection. Important note is that when querying users you don’t have permissions to, the querying options are limited. You won’t get almost any field in show_output (only empty or default values), the DESCRIBE command will return error when called, so you have to set with_describe = false; the SHOW PARAMETERS command will return error when called too, so you have to set with_parameters = false.

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.

TypeScript
Python
Go
C#
Java
YAML

function getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>

def get_users(like: Optional[str] = None,
              limit: Optional[GetUsersLimit] = None,
              starts_with: Optional[str] = None,
              with_describe: Optional[bool] = None,
              with_parameters: Optional[bool] = None,
              opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(like: Optional[pulumi.Input[str]] = None,
              limit: Optional[pulumi.Input[GetUsersLimitArgs]] = None,
              starts_with: Optional[pulumi.Input[str]] = None,
              with_describe: Optional[pulumi.Input[bool]] = None,
              with_parameters: Optional[pulumi.Input[bool]] = 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: snowflake:index/getUsers:getUsers
  arguments:
    # arguments dictionary

The following arguments are supported:

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

getUsers Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Users List<GetUsersUser>: Holds the aggregated output of all user details queries.
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
Users []GetUsersUser: Holds the aggregated output of all user details queries.
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
Limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
StartsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
WithDescribe bool: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
users List<GetUsersUser>: Holds the aggregated output of all user details queries.
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
users GetUsersUser[]: Holds the aggregated output of all user details queries.
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith string: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe boolean: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
users Sequence[GetUsersUser]: Holds the aggregated output of all user details queries.
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit GetUsersLimit: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
starts_with str: Filters the output with case-sensitive characters indicating the beginning of the object name.
with_describe bool: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
users List<Property Map>: Holds the aggregated output of all user details queries.
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
limit Property Map: Limits the number of rows returned. If the limit.from is set, then the limit wll start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
startsWith String: Filters the output with case-sensitive characters indicating the beginning of the object name.
withDescribe Boolean: Runs DESC USER for each user returned by SHOW USERS. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR USER for each user returned by SHOW USERS. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Supporting Types

GetUsersLimit

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

Rows int: The maximum number of rows to return.
From string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Integer: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows number: The maximum number of rows to return.
from string: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows int: The maximum number of rows to return.
from_ str: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

rows Number: The maximum number of rows to return.
from String: Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.