SpiraPlan: SoapService SOAP Web Service
See all operations
RemoteUser
Represents a single User in the system
Base Classes
This class extends the following base classes:
Properties
The following properties are provided directly by this class:
| Name | Type | Description | Required |
|---|---|---|---|
| Active | boolean | Whether the user is active in the system | Yes |
| Admin | boolean | Whether the user is a system administrator | Yes |
| Approved | boolean | Is this user approved by the system administrator | Yes |
| CustomProperties | ArrayOfRemoteSystemArtifactCustomProperty? | The list of associated custom properties/fields for this user ( Not currently used, but there for the future ) | |
| Department | string? | The department of the user | |
| EmailAddress | string? | The email address of the user | |
| EmailsEnabled | boolean | Whether or not a user has opted to recieve emails or not | Yes |
| FirstName | string? | The first (given) name of the user | |
| FullName | string? | The full name of the user concatenated (First + Middle + Last) | |
| LastActivityDate | dateTime? | Last date this users account did something | |
| LastLockoutDate | dateTime? | Last date this users account was locked out | |
| LastLoginDate | dateTime? | Last date this users account was logged in to | |
| LastName | string? | The last name (surname) of the user | |
| LastPasswordChange | dateTime? | Last date this users account password was changed | |
| LastUpdatedDate | dateTime? | ||
| LdapDn | string? | The LDAP Distinguished Name for the user (null for non-LDAP users) | |
| Locked | boolean | Is this user locked-out of their account | Yes |
| MiddleInitial | string? | The middle initials of the user | |
| MutliFactorAuthentication | boolean | Whether this user is using Spira's integrated MFA implementation. | Yes |
| OAuthProvider | string? | Name of the external OAuth provider being used to access this account | |
| OrganizationId | int? | ID of the organization this user belongs to | |
| OrganizationName | string? | Organization name of the user | |
| PortfolioViewer | boolean | Whether this user has permissions to view all portfolios | Yes |
| ReportAdmin | boolean | Whether the user is a report admin | Yes |
| RssToken | string? | This is the RSS token for this user ( For security reasons, you have to access the API as a system administrator to retrieve this field ) | |
| UserGuid | string? | The guid of the user | |
| UserId | int? | The id of the user | |
| UserName | string? | The login used by the user |