Users.getProfile (Method)
Returns a structure containing information about a user's profile. The Users.getUserInfo() method returns additional information.
Returns:
Users_GetProfile_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| AccountExpiration | Date_EmptyString | The date the user's account expires. An empty string indicates that there is no expiration. |
| Address1 | PlainText_128 | The first line of the user's address. |
| Address2 | PlainText_128 | The second line of the user's address. |
| CanUpdateProfile | Boolean | If false, updates to this profile may not be made by this user. |
| City | PlainText_128 | The user's city. |
| Company | PlainText_125 | The name of the user's company. |
| CompanyID | CompanyID | The company's ID. |
| ContributorType | ContributorType | String identifying a contributor's type, as follows: 'Dedicated', 'None', and 'Shared'. |
| EmailAddress | The user's email address. | |
| Fax | PlainText_40 | The user's fax number. |
| FirstName | PlainText_50 | The user's first name. |
| HomePage | PlainText_255 | The home page URL. |
| LastName | PlainText_50 | The user's last name. |
| LimitAccessIPAddresses | IPAddressWildcardList_EmptyString | A comma-delimited list of IP addresses or an IP address wildcard naming the systems from which the user can access this CommonSpot site. An empty string indicates the user can access this CommonSpot site from any system. |
| MiddleName | PlainText_50 | The user's middle name. |
| Organization | PlainText_125 | The user's organization. |
| OrganizationID | OrganizationID | The organization's ID. |
| PasswordExpirationDays | NonNegativeInteger | The number of days until the user's password expires. |
| Phone | Any | The user's phone number. |
| RequirePasswordChange | Boolean | A Boolean flag which if set to true indicates the user must change the password when next logging in. |
| ssoOnly | Boolean | True if the user can only be validate by Single Sign-on, false otherwise. |
| State | PlainText_50 | The user's state or province. |
| Title | PlainText_255 | The user's title. |
| UserID | UserID_0 | The user's integer ID, or 0 if asking about the current user and they're not logged in. |
| UserName | UserName | The user name (for example, ssmith) of the user. |
| VoiceMail | PlainText_40 | The user's voice mail number. |
| Zip | PlainText_20 | The user's zipcode. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| userID | UserID_NEG1 | Optional. Defaults to '-1'. | A user's ID or -1 for the current user. |
Context:
| License Requirements | None |
| Permission Requirements | User:Current |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 66000 |
Notes:
None