1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getUser
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.getUser

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    This datasource is used to query the existing Users from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale User allows you to authenticate through a local authentication provider. Remote users are restricted to read-only operations.

    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(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
    function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
    def get_user(filter: Optional[GetUserFilter] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUserResult
    def get_user_output(filter: Optional[pulumi.Input[GetUserFilterArgs]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
    func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

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

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

    The following arguments are supported:

    getUser Result

    The following output properties are available:

    Id string
    Unique identifier of the user instance.
    Users List<GetUserUser>
    List of users.
    Filter GetUserFilter
    Id string
    Unique identifier of the user instance.
    Users []GetUserUser
    List of users.
    Filter GetUserFilter
    id String
    Unique identifier of the user instance.
    users List<GetUserUser>
    List of users.
    filter GetUserFilter
    id string
    Unique identifier of the user instance.
    users GetUserUser[]
    List of users.
    filter GetUserFilter
    id str
    Unique identifier of the user instance.
    users Sequence[GetUserUser]
    List of users.
    filter GetUserFilter
    id String
    Unique identifier of the user instance.
    users List<Property Map>
    List of users.
    filter Property Map

    Supporting Types

    GetUserFilter

    Cached bool
    If true, only return cached objects.
    Domain string
    Filter users by domain.
    MemberOf bool
    Enumerate all users that a group is a member of.
    NamePrefix string
    Filter users by name prefix.
    Names List<GetUserFilterName>
    List of user identity.
    Provider string
    Filter users by provider.
    Zone string
    Filter users by zone.
    Cached bool
    If true, only return cached objects.
    Domain string
    Filter users by domain.
    MemberOf bool
    Enumerate all users that a group is a member of.
    NamePrefix string
    Filter users by name prefix.
    Names []GetUserFilterName
    List of user identity.
    Provider string
    Filter users by provider.
    Zone string
    Filter users by zone.
    cached Boolean
    If true, only return cached objects.
    domain String
    Filter users by domain.
    memberOf Boolean
    Enumerate all users that a group is a member of.
    namePrefix String
    Filter users by name prefix.
    names List<GetUserFilterName>
    List of user identity.
    provider String
    Filter users by provider.
    zone String
    Filter users by zone.
    cached boolean
    If true, only return cached objects.
    domain string
    Filter users by domain.
    memberOf boolean
    Enumerate all users that a group is a member of.
    namePrefix string
    Filter users by name prefix.
    names GetUserFilterName[]
    List of user identity.
    provider string
    Filter users by provider.
    zone string
    Filter users by zone.
    cached bool
    If true, only return cached objects.
    domain str
    Filter users by domain.
    member_of bool
    Enumerate all users that a group is a member of.
    name_prefix str
    Filter users by name prefix.
    names Sequence[GetUserFilterName]
    List of user identity.
    provider str
    Filter users by provider.
    zone str
    Filter users by zone.
    cached Boolean
    If true, only return cached objects.
    domain String
    Filter users by domain.
    memberOf Boolean
    Enumerate all users that a group is a member of.
    namePrefix String
    Filter users by name prefix.
    names List<Property Map>
    List of user identity.
    provider String
    Filter users by provider.
    zone String
    Filter users by zone.

    GetUserFilterName

    Name string
    Specifies a user name.
    Sid string
    Specifies a numeric security identifier.
    Uid double
    Specifies a numeric user identifier.
    Name string
    Specifies a user name.
    Sid string
    Specifies a numeric security identifier.
    Uid float64
    Specifies a numeric user identifier.
    name String
    Specifies a user name.
    sid String
    Specifies a numeric security identifier.
    uid Double
    Specifies a numeric user identifier.
    name string
    Specifies a user name.
    sid string
    Specifies a numeric security identifier.
    uid number
    Specifies a numeric user identifier.
    name str
    Specifies a user name.
    sid str
    Specifies a numeric security identifier.
    uid float
    Specifies a numeric user identifier.
    name String
    Specifies a user name.
    sid String
    Specifies a numeric security identifier.
    uid Number
    Specifies a numeric user identifier.

    GetUserUser

    Roles List<string>
    List of roles.
    Dn string
    Specifies a principal name for the user.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of.
    Email string
    Specifies an email address.
    Enabled bool
    If true, the authenticated user is enabled.
    Expired bool
    If true, the authenticated user has expired.
    Expiry double
    Specifies the Unix Epoch time at which the authenticated user will expire.
    Gecos string
    Specifies the GECOS value, which is usually the full name.
    GeneratedGid bool
    If true, the GID was generated.
    GeneratedUid bool
    If true, the UID was generated.
    GeneratedUpn bool
    If true, the UPN was generated.
    Gid string
    Specifies a group identifier.
    HomeDirectory string
    Specifies a home directory for the user.
    Id string
    Specifies the user ID.
    Locked bool
    If true, indicates that the account is locked.
    MaxPasswordAge double
    Specifies the maximum time in seconds allowed before the password expires.
    Name string
    Specifies a user name.
    PasswordExpired bool
    If true, the password has expired.
    PasswordExpires bool
    If true, the password is allowed to expire.
    PasswordExpiry double
    Specifies the time in Unix Epoch seconds that the password will expire.
    PasswordLastSet double
    Specifies the last time the password was set.
    PrimaryGroupSid string
    Specifies the persona of the primary group.
    PromptPasswordChange bool
    If true, Prompts the user to change their password at the next login.
    Provider string
    Specifies the authentication provider that the object belongs to.
    SamAccountName string
    Specifies a user name.
    Shell string
    Specifies a path to the shell for the user.
    Sid string
    Specifies a security identifier.
    Type string
    Specifies the object type.
    Uid string
    Specifies a user identifier.
    Upn string
    Specifies a principal name for the user.
    UserCanChangePassword bool
    Specifies whether the password for the user can be changed.
    Roles []string
    List of roles.
    Dn string
    Specifies a principal name for the user.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of.
    Email string
    Specifies an email address.
    Enabled bool
    If true, the authenticated user is enabled.
    Expired bool
    If true, the authenticated user has expired.
    Expiry float64
    Specifies the Unix Epoch time at which the authenticated user will expire.
    Gecos string
    Specifies the GECOS value, which is usually the full name.
    GeneratedGid bool
    If true, the GID was generated.
    GeneratedUid bool
    If true, the UID was generated.
    GeneratedUpn bool
    If true, the UPN was generated.
    Gid string
    Specifies a group identifier.
    HomeDirectory string
    Specifies a home directory for the user.
    Id string
    Specifies the user ID.
    Locked bool
    If true, indicates that the account is locked.
    MaxPasswordAge float64
    Specifies the maximum time in seconds allowed before the password expires.
    Name string
    Specifies a user name.
    PasswordExpired bool
    If true, the password has expired.
    PasswordExpires bool
    If true, the password is allowed to expire.
    PasswordExpiry float64
    Specifies the time in Unix Epoch seconds that the password will expire.
    PasswordLastSet float64
    Specifies the last time the password was set.
    PrimaryGroupSid string
    Specifies the persona of the primary group.
    PromptPasswordChange bool
    If true, Prompts the user to change their password at the next login.
    Provider string
    Specifies the authentication provider that the object belongs to.
    SamAccountName string
    Specifies a user name.
    Shell string
    Specifies a path to the shell for the user.
    Sid string
    Specifies a security identifier.
    Type string
    Specifies the object type.
    Uid string
    Specifies a user identifier.
    Upn string
    Specifies a principal name for the user.
    UserCanChangePassword bool
    Specifies whether the password for the user can be changed.
    roles List<String>
    List of roles.
    dn String
    Specifies a principal name for the user.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of.
    email String
    Specifies an email address.
    enabled Boolean
    If true, the authenticated user is enabled.
    expired Boolean
    If true, the authenticated user has expired.
    expiry Double
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos String
    Specifies the GECOS value, which is usually the full name.
    generatedGid Boolean
    If true, the GID was generated.
    generatedUid Boolean
    If true, the UID was generated.
    generatedUpn Boolean
    If true, the UPN was generated.
    gid String
    Specifies a group identifier.
    homeDirectory String
    Specifies a home directory for the user.
    id String
    Specifies the user ID.
    locked Boolean
    If true, indicates that the account is locked.
    maxPasswordAge Double
    Specifies the maximum time in seconds allowed before the password expires.
    name String
    Specifies a user name.
    passwordExpired Boolean
    If true, the password has expired.
    passwordExpires Boolean
    If true, the password is allowed to expire.
    passwordExpiry Double
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet Double
    Specifies the last time the password was set.
    primaryGroupSid String
    Specifies the persona of the primary group.
    promptPasswordChange Boolean
    If true, Prompts the user to change their password at the next login.
    provider String
    Specifies the authentication provider that the object belongs to.
    samAccountName String
    Specifies a user name.
    shell String
    Specifies a path to the shell for the user.
    sid String
    Specifies a security identifier.
    type String
    Specifies the object type.
    uid String
    Specifies a user identifier.
    upn String
    Specifies a principal name for the user.
    userCanChangePassword Boolean
    Specifies whether the password for the user can be changed.
    roles string[]
    List of roles.
    dn string
    Specifies a principal name for the user.
    dnsDomain string
    Specifies the DNS domain.
    domain string
    Specifies the domain that the object is part of.
    email string
    Specifies an email address.
    enabled boolean
    If true, the authenticated user is enabled.
    expired boolean
    If true, the authenticated user has expired.
    expiry number
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos string
    Specifies the GECOS value, which is usually the full name.
    generatedGid boolean
    If true, the GID was generated.
    generatedUid boolean
    If true, the UID was generated.
    generatedUpn boolean
    If true, the UPN was generated.
    gid string
    Specifies a group identifier.
    homeDirectory string
    Specifies a home directory for the user.
    id string
    Specifies the user ID.
    locked boolean
    If true, indicates that the account is locked.
    maxPasswordAge number
    Specifies the maximum time in seconds allowed before the password expires.
    name string
    Specifies a user name.
    passwordExpired boolean
    If true, the password has expired.
    passwordExpires boolean
    If true, the password is allowed to expire.
    passwordExpiry number
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet number
    Specifies the last time the password was set.
    primaryGroupSid string
    Specifies the persona of the primary group.
    promptPasswordChange boolean
    If true, Prompts the user to change their password at the next login.
    provider string
    Specifies the authentication provider that the object belongs to.
    samAccountName string
    Specifies a user name.
    shell string
    Specifies a path to the shell for the user.
    sid string
    Specifies a security identifier.
    type string
    Specifies the object type.
    uid string
    Specifies a user identifier.
    upn string
    Specifies a principal name for the user.
    userCanChangePassword boolean
    Specifies whether the password for the user can be changed.
    roles Sequence[str]
    List of roles.
    dn str
    Specifies a principal name for the user.
    dns_domain str
    Specifies the DNS domain.
    domain str
    Specifies the domain that the object is part of.
    email str
    Specifies an email address.
    enabled bool
    If true, the authenticated user is enabled.
    expired bool
    If true, the authenticated user has expired.
    expiry float
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos str
    Specifies the GECOS value, which is usually the full name.
    generated_gid bool
    If true, the GID was generated.
    generated_uid bool
    If true, the UID was generated.
    generated_upn bool
    If true, the UPN was generated.
    gid str
    Specifies a group identifier.
    home_directory str
    Specifies a home directory for the user.
    id str
    Specifies the user ID.
    locked bool
    If true, indicates that the account is locked.
    max_password_age float
    Specifies the maximum time in seconds allowed before the password expires.
    name str
    Specifies a user name.
    password_expired bool
    If true, the password has expired.
    password_expires bool
    If true, the password is allowed to expire.
    password_expiry float
    Specifies the time in Unix Epoch seconds that the password will expire.
    password_last_set float
    Specifies the last time the password was set.
    primary_group_sid str
    Specifies the persona of the primary group.
    prompt_password_change bool
    If true, Prompts the user to change their password at the next login.
    provider str
    Specifies the authentication provider that the object belongs to.
    sam_account_name str
    Specifies a user name.
    shell str
    Specifies a path to the shell for the user.
    sid str
    Specifies a security identifier.
    type str
    Specifies the object type.
    uid str
    Specifies a user identifier.
    upn str
    Specifies a principal name for the user.
    user_can_change_password bool
    Specifies whether the password for the user can be changed.
    roles List<String>
    List of roles.
    dn String
    Specifies a principal name for the user.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of.
    email String
    Specifies an email address.
    enabled Boolean
    If true, the authenticated user is enabled.
    expired Boolean
    If true, the authenticated user has expired.
    expiry Number
    Specifies the Unix Epoch time at which the authenticated user will expire.
    gecos String
    Specifies the GECOS value, which is usually the full name.
    generatedGid Boolean
    If true, the GID was generated.
    generatedUid Boolean
    If true, the UID was generated.
    generatedUpn Boolean
    If true, the UPN was generated.
    gid String
    Specifies a group identifier.
    homeDirectory String
    Specifies a home directory for the user.
    id String
    Specifies the user ID.
    locked Boolean
    If true, indicates that the account is locked.
    maxPasswordAge Number
    Specifies the maximum time in seconds allowed before the password expires.
    name String
    Specifies a user name.
    passwordExpired Boolean
    If true, the password has expired.
    passwordExpires Boolean
    If true, the password is allowed to expire.
    passwordExpiry Number
    Specifies the time in Unix Epoch seconds that the password will expire.
    passwordLastSet Number
    Specifies the last time the password was set.
    primaryGroupSid String
    Specifies the persona of the primary group.
    promptPasswordChange Boolean
    If true, Prompts the user to change their password at the next login.
    provider String
    Specifies the authentication provider that the object belongs to.
    samAccountName String
    Specifies a user name.
    shell String
    Specifies a path to the shell for the user.
    sid String
    Specifies a security identifier.
    type String
    Specifies the object type.
    uid String
    Specifies a user identifier.
    upn String
    Specifies a principal name for the user.
    userCanChangePassword Boolean
    Specifies whether the password for the user can be changed.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell