User Object

Contains information about a platform user.

This object is used by the following operations:

The properties included in the User object are listed below. All values are optional.

Property Type Description
UserID string The unique ID for a specific user.
UserName string The user's name, as set up by the user in the Akana API Platform. For a Facebook user, the user name is a numeric ID. For a Google user it is a URL.
FirstName string The user's first name.
LarstName string The user's last name.
AuthIdentifier string The identifier for the user, as provided by the identify store. If the user signed up using Facebook, this value is a numeric ID; for Google, it is the URI of the user on Google. If the user signed up on the platform, it is a unique identifier for the platform.
Password string The user's password.
Description string A text description for the user, if there is one.
Link string The URL to an external webpage for the user, if one is set up.
Visibility string

The visibility setting for this resource. For a list of valid values, see Visibility Settings.

Currently, the visibility of all users is Public.

Phone string Phone number for the user.
Email string The user's email address.
BusinessID string The unique ID for a specific business organization on the platform.
Title string The user's job title. In the user interface, this information is set up on the Your Personal Info page.
Industry string The user's industry. In the user interface, this information is set up on the Your Personal Info page.
Language string[ ] A list of the user's favorite computer languages, separated by commas. In the user interface, this information is set up on the Your Personal Info page.
Technology string[ ] A list of technologies the user is interested in, separated by commas. In the user interface, this information is set up on the Your Personal Info page, in the Frameworks section.
Favorites string A list of the user's favorite APIs. In the user interface, this information is set up on the Your Personal Info page.
PictureID long The unique ID for the picture uploaded for the user, if applicable.
AvatarProvider string The avatar provider, such as Gravatar, if applicable.
HasPicture boolean A value indicating whether the user's profile includes a picture (defaults to false indicating there is no picture).
State string The current signup state of the user; for example, pending_validation. For a list of valid values, see User Signup State Values.
Created dateTime The date/time stamp when the resource was first created. Used only in response messages.
Updated dateTime The date/time stamp when the resource was last updated. Used only in response messages.
AvatarURL anyURI URL for the avatar uploaded for the resource, if any. Used only in response messages.
Domain string The user's domain.
LastLoginDate dateTime The date/time stamp that the user last logged in.
Disabled boolean Indicates whether the user's status has been changed to disabled.
ProfileName string The user's profile name.
AcceptedAgreementID string[ ]

One or more unique IDs for platform legal agreements that the user has accepted.

Note: The  Site Admin can add a user, but cannot accept the legal agreement on behalf of the user.

UserIdentificationChallenges UserIdentificationChallenges Contains information about one or more user identification challenge questions applicable to a specific user, and in some cases the answers also.
LoginDomainID LoginDomainID The unique ID for a user's login domain; either the platform, for a local account, or an additional login domain such as Google or Facebook. The login domains supported by a specific platform version are configured by the Site Admin.
ForcePasswordChangeOnLogin boolean Indicates whether the user must change password on first login. When the user is added by the Site Admin using the POST /api/users operation, this defaults to true to force the user to change from the default password.
Locked boolean Indicates whether the user's account is locked.
LockExpirationDate dateTime Indicates the expiration date of the lock, if the user's account is locked.
ExpirationDate dateTime

Indicates the expiration date for the user account. If a user account includes an expiration date, and the date expires, the account is no longer active and the user cannot log in.

By default, an expiration date is set on a new account for new users who have not yet logged in. Accounts that are not activated expire and can be purged periodically. Once a user logs in, the expiration date is removed from the user account. Specific implementations might use this field differently.

UserPhones UserPhones Contains information about one or more phone numbers associated with the user.
classifiers classifiers

Applicable with Lifecycle Repository integration only. Contains a property name and an array of one or more values for the property. For an example, see POST /api/users/completeSignup.

The user interface shows custom properties as a single concept, but on the API, app, or user they exist as classifiers and artifacts. The artifacts have URLs ("by-ref" artifacts). Classifiers and artifacts are only applicable if the Repository Extension is enabled and custom properties configured.

artifacts artifacts

Applicable with Lifecycle Repository integration only. Contains entries with an artifact name and value. The value is always a URL. For an example, see POST /api/users/completeSignup.

The user interface shows custom properties as a single concept, but on the API, app, or user they exist as classifiers and artifacts. The artifacts have URLs ("by-ref" artifacts). Classifiers and artifacts are only applicable if the Repository Extension is enabled and custom properties configured.

Back to top

Related Topics