1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getUser
planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
planetscale logo
planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale

    User DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as planetscale from "@pulumi/planetscale";
    
    const myUser = planetscale.getUser({});
    
    import pulumi
    import pulumi_planetscale as planetscale
    
    my_user = planetscale.get_user()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := planetscale.GetUser(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Planetscale = Pulumi.Planetscale;
    
    return await Deployment.RunAsync(() => 
    {
        var myUser = Planetscale.GetUser.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.planetscale.PlanetscaleFunctions;
    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 myUser = PlanetscaleFunctions.getUser(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
        }
    }
    
    variables:
      myUser:
        fn::invoke:
          function: planetscale:getUser
          arguments: {}
    

    Using getUser

    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 getUser(opts?: InvokeOptions): Promise<GetUserResult>
    function getUserOutput(opts?: InvokeOptions): Output<GetUserResult>
    def get_user(opts: Optional[InvokeOptions] = None) -> GetUserResult
    def get_user_output(opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func GetUser(ctx *Context, opts ...InvokeOption) (*GetUserResult, error)
    func GetUserOutput(ctx *Context, opts ...InvokeOption) GetUserResultOutput

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

    public static class GetUser 
    {
        public static Task<GetUserResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetUserResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserResult> getUser(InvokeOptions options)
    public static Output<GetUserResult> getUser(InvokeOptions options)
    
    fn::invoke:
      function: planetscale:index/getUser:getUser
      arguments:
        # arguments dictionary

    getUser Result

    The following output properties are available:

    AvatarUrl string
    The URL source of the user's avatar
    CreatedAt string
    When the user was created
    DefaultOrganization GetUserDefaultOrganization
    DirectoryManaged bool
    Whether or not the user is managed by a SSO directory
    DisplayName string
    The display name of the user
    Email string
    The email of the user
    EmailVerified bool
    Whether or not the user is verified by email
    Id string
    The ID of the user
    Managed bool
    Whether or not the user is managed by an authentication provider
    Name string
    The name of the user
    Sso bool
    Whether or not the user is managed by SSO
    TwoFactorAuthConfigured bool
    Whether or not the user has configured two factor authentication
    UpdatedAt string
    When the user was last updated
    AvatarUrl string
    The URL source of the user's avatar
    CreatedAt string
    When the user was created
    DefaultOrganization GetUserDefaultOrganization
    DirectoryManaged bool
    Whether or not the user is managed by a SSO directory
    DisplayName string
    The display name of the user
    Email string
    The email of the user
    EmailVerified bool
    Whether or not the user is verified by email
    Id string
    The ID of the user
    Managed bool
    Whether or not the user is managed by an authentication provider
    Name string
    The name of the user
    Sso bool
    Whether or not the user is managed by SSO
    TwoFactorAuthConfigured bool
    Whether or not the user has configured two factor authentication
    UpdatedAt string
    When the user was last updated
    avatarUrl String
    The URL source of the user's avatar
    createdAt String
    When the user was created
    defaultOrganization GetUserDefaultOrganization
    directoryManaged Boolean
    Whether or not the user is managed by a SSO directory
    displayName String
    The display name of the user
    email String
    The email of the user
    emailVerified Boolean
    Whether or not the user is verified by email
    id String
    The ID of the user
    managed Boolean
    Whether or not the user is managed by an authentication provider
    name String
    The name of the user
    sso Boolean
    Whether or not the user is managed by SSO
    twoFactorAuthConfigured Boolean
    Whether or not the user has configured two factor authentication
    updatedAt String
    When the user was last updated
    avatarUrl string
    The URL source of the user's avatar
    createdAt string
    When the user was created
    defaultOrganization GetUserDefaultOrganization
    directoryManaged boolean
    Whether or not the user is managed by a SSO directory
    displayName string
    The display name of the user
    email string
    The email of the user
    emailVerified boolean
    Whether or not the user is verified by email
    id string
    The ID of the user
    managed boolean
    Whether or not the user is managed by an authentication provider
    name string
    The name of the user
    sso boolean
    Whether or not the user is managed by SSO
    twoFactorAuthConfigured boolean
    Whether or not the user has configured two factor authentication
    updatedAt string
    When the user was last updated
    avatar_url str
    The URL source of the user's avatar
    created_at str
    When the user was created
    default_organization GetUserDefaultOrganization
    directory_managed bool
    Whether or not the user is managed by a SSO directory
    display_name str
    The display name of the user
    email str
    The email of the user
    email_verified bool
    Whether or not the user is verified by email
    id str
    The ID of the user
    managed bool
    Whether or not the user is managed by an authentication provider
    name str
    The name of the user
    sso bool
    Whether or not the user is managed by SSO
    two_factor_auth_configured bool
    Whether or not the user has configured two factor authentication
    updated_at str
    When the user was last updated
    avatarUrl String
    The URL source of the user's avatar
    createdAt String
    When the user was created
    defaultOrganization Property Map
    directoryManaged Boolean
    Whether or not the user is managed by a SSO directory
    displayName String
    The display name of the user
    email String
    The email of the user
    emailVerified Boolean
    Whether or not the user is verified by email
    id String
    The ID of the user
    managed Boolean
    Whether or not the user is managed by an authentication provider
    name String
    The name of the user
    sso Boolean
    Whether or not the user is managed by SSO
    twoFactorAuthConfigured Boolean
    Whether or not the user has configured two factor authentication
    updatedAt String
    When the user was last updated

    Supporting Types

    GetUserDefaultOrganization

    CreatedAt string
    When the resource was created
    DeletedAt string
    When the resource was deleted, if deleted
    Id string
    The ID for the resource
    Name string
    The name for the resource
    UpdatedAt string
    When the resource was last updated
    CreatedAt string
    When the resource was created
    DeletedAt string
    When the resource was deleted, if deleted
    Id string
    The ID for the resource
    Name string
    The name for the resource
    UpdatedAt string
    When the resource was last updated
    createdAt String
    When the resource was created
    deletedAt String
    When the resource was deleted, if deleted
    id String
    The ID for the resource
    name String
    The name for the resource
    updatedAt String
    When the resource was last updated
    createdAt string
    When the resource was created
    deletedAt string
    When the resource was deleted, if deleted
    id string
    The ID for the resource
    name string
    The name for the resource
    updatedAt string
    When the resource was last updated
    created_at str
    When the resource was created
    deleted_at str
    When the resource was deleted, if deleted
    id str
    The ID for the resource
    name str
    The name for the resource
    updated_at str
    When the resource was last updated
    createdAt String
    When the resource was created
    deletedAt String
    When the resource was deleted, if deleted
    id String
    The ID for the resource
    name String
    The name for the resource
    updatedAt String
    When the resource was last updated

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
      Meet Neo: Your AI Platform Teammate