Users.createProfile (Method)
Creates a new user profile.
Returns:
UserID (integer)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
userName | UserLoginName | Required | The user's login name; for example, ssmith. |
contributorType | ContributorType | Required | The type of contributor: 'None', 'Dedicated', or 'Shared'. |
company | PlainText_NonNull_255 | Required | The name of the user's company. |
organization | PlainText_NonNull_255 | Required | The name of the user's organization. |
EmailAddress | Optional. Defaults to an empty string. | The user's email address. | |
password | Password_EmptyString | Optional. Defaults to an empty string. | The user's password. If this string is set to 'nicetry!', CommonSpot does not update the password. |
lastName | PlainText_NonNull_50 | Required | The user's last name. |
firstName | PlainText_50 | Optional. Defaults to an empty string. | The user's first name. |
middleName | PlainText_50 | Optional. Defaults to an empty string. | The user's middle name or initial. Required if the combination of first and last name is not unique. Note that even if the name was unique when it was originally saved, once another user with the same first and last name exists, middle name will be required to save it again. |
title | PlainText_255 | Optional. Defaults to an empty string. | The user's title. |
address1 | PlainText_128 | Optional. Defaults to an empty string. | The first (or only) part of the user's address. |
address2 | PlainText_128 | Optional. Defaults to an empty string. | The second part of the user's address. |
city | PlainText_128 | Optional. Defaults to an empty string. | The user's city. |
state | PlainText_50 | Optional. Defaults to an empty string. | The user's state. |
zip | PlainText_20 | Optional. Defaults to an empty string. | The user's zip code. |
phone | PlainText_40 | Optional. Defaults to an empty string. | The user's phone number. |
fax | PlainText_40 | Optional. Defaults to an empty string. | The user's fax number. |
voiceMail | PlainText_40 | Optional. Defaults to an empty string. | The user's voice mail. |
homePage | PlainText_255 | Optional. Defaults to an empty string. | The user's home page. |
passwordExpirationDays | NonNegativeInteger | Optional. Defaults to '0'. | The number of days until the password expires. If this value is 0, the password does not expire. |
requirePasswordChange | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that users must change their passwords the next time they login. |
accountExpiration | Date_EmptyString | Optional. Defaults to an empty string. | The date and time when the user's account expires. This value's format is 'yyyy-mm-dd HH:mm:ss'. If this is an empty string, the account does not expire. |
limitAccessIPAddresses | IPAddressWildcardList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of IP addresses from which the user can access CommonSpot. An item on this list can contain a wild card; for example, 100.*. If this parameter's value is an empty string, no restrictions exist. |
sendUserEmailNotification | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that this user is sent an email massage notification indicating that that an account was created. This message contains the account's user name and password. |
canUpdateProfile | Boolean | Optional. Defaults to '1'. | |
ssoOnly | Boolean | Optional. Defaults to '0'. | True if this user must be authenticated by Single Sign-on - false otherwise. |
Context:
License Requirements | None |
Permission Requirements | Customer:CreateUsers |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the customer level, calls to this method will be logged |
Customization | Customization is not supported for this method. |
Error Codes:
Code | Error Message |
---|---|
66003 | The Password cannot be the same as the UserName. |
66009 | User '$1 $2 $3' already exists. |
66010 | User ID '$1' already exists. |
66046 | You do not have the permissions you need to create users as $1 contributors. |
Notes:
None