On this page

    ConfluencePS.User

    SYNOPSIS

    Defines an object for Users in Confluence.

    SYNTAX

    New-Object -TypeName ConfluencePS.User [-Property @{}]

[ConfluencePS.User]@{}

    DESCRIPTION

    fixThe User is an object that describes users in Confluence.

    REFERENCES

    The following classes use User for their properties:

    CONSTRUCTORS

    This class does not have a constructor.

    PROPERTIES

    UserKey

    The UserKey is the identifier of a User used by the Confluence server internally.

    This value can’t be changed and is assigned by the server.

    It is recommended to use UserName as identifier when using this object.

    Type: String
Required: True
Default value: None

    UserName

    The UserName is the “public” identifier of a User.

    This value can be changed by an administrator.

    Type: String
Required: True
Default value: None

    DisplayName

    The DisplayName is the chosen name that is display for the User.

    This value can be changed by the user himself.

    Type: String
Required: True
Default value: None

    ProfilePicture

    The ProfilePicture contains the information about the Users profile picture / avatar.

    This value can be changed by the user himself.

    Type: ConfluencePS.Icon
Required: True
Default value: None

    METHODS

    ToString()

    The method for casting an object of this class to string is overwritten.

    When cast to string, this will return the DisplayName property’s value.