1. Registry
  2. Packages
  3. Rootly
  4. API Docs
  5. getUsers
Viewing docs for Rootly v4.0.0
published on Tuesday, Sep 15, 2026 by rootlyhq
rootly logo
Viewing docs for Rootly v4.0.0
published on Tuesday, Sep 15, 2026 by rootlyhq

    Lists Rootly users, optionally filtered to a set of emails. Emails that do not resolve to an existing user are omitted rather than causing an error.

    Example Usage

    data "rootly_users" "team" {
      emails = [
        "john@acme.com",
        "jane@acme.com",
      ]
    }
    

    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?: InvokeOutputOptions): Output<GetUsersResult>
    def get_users(emails: Optional[Sequence[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> GetUsersResult
    def get_users_output(emails: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                  opts: Optional[InvokeOutputOptions] = 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 Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
    public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
    public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: rootly:index/getUsers:getUsers
      arguments:
        # arguments dictionary
    data "rootly_get_users" "name" {
        # arguments
    }

    The following arguments are supported:

    Emails List<string>
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    Emails []string
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    emails list(string)
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    emails List<String>
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    emails string[]
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    emails Sequence[str]
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    emails List<String>
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.

    getUsers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Users List<GetUsersUser>
    The matching users.
    Emails List<string>
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    Id string
    The provider-assigned unique ID for this managed resource.
    Users []GetUsersUser
    The matching users.
    Emails []string
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    id string
    The provider-assigned unique ID for this managed resource.
    users list(object)
    The matching users.
    emails list(string)
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    id String
    The provider-assigned unique ID for this managed resource.
    users List<GetUsersUser>
    The matching users.
    emails List<String>
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    id string
    The provider-assigned unique ID for this managed resource.
    users GetUsersUser[]
    The matching users.
    emails string[]
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    id str
    The provider-assigned unique ID for this managed resource.
    users Sequence[GetUsersUser]
    The matching users.
    emails Sequence[str]
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.
    id String
    The provider-assigned unique ID for this managed resource.
    users List<Property Map>
    The matching users.
    emails List<String>
    Optional set of emails to filter by (case-insensitive). When omitted, all users are returned.

    Supporting Types

    GetUsersUser

    Email string
    Id string
    OnCallRoleId string
    RoleId string
    Email string
    Id string
    OnCallRoleId string
    RoleId string
    email string
    id string
    on_call_role_id string
    role_id string
    email String
    id String
    onCallRoleId String
    roleId String
    email string
    id string
    onCallRoleId string
    roleId string
    email String
    id String
    onCallRoleId String
    roleId String

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v4.0.0
    published on Tuesday, Sep 15, 2026 by rootlyhq

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial