Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: User.StateChange

Scoped Name

APIServer.User.StateChange

Interface

Field Variable ...as Description
UserSurrogate Data Input The unique identification for a user.
UserStatus Data Input The new status for the user. Valid values are: Active (A), Inactive (I), TooManyFailedLogins (F).
ErrorMessage Error Output If an error occurs this field can contain a text describing the error.

Description

The API offers the possibility to change the state of the user without having to consider any other values for the user (e.g. reactivate a user, who has been deactivated because of too many failed login attempts).

The API calls the API UserStateChangeValidation before doing the update.

If an error occurs, a text describing the error is written to the ErrorMessage output field.

Events

Universal events