User.lock - REST API

Overview

Lock a user specified by user_id. A locked user cannot log in to the system. Input UST must belong to a logged in super-user.

Use User.unlock to unlock an already locked user.

  • HTTP method: POST
  • URL path: /zato/sso/user/lock

Request

NameDatatypeOptionalNotes
uststring---Current user's session token (UST)
current_appstring---Name of application that the call is attempted from
user_idstring---ID of the user to lock

Response

NameDatatypeOptionalNotes
cidstring---Correlation ID assigned to request
statusstring---Overall status code
sub_statuslistYesReturned only if status is not "ok", a list of error or warning codes

Usage

$ curl -XPOST localhost:17010/zato/sso/user/lock -d '
  {
    "ust": "gAAAAABaluMOuV63skky-6ZZzlaPs...",
    "current_app": "CRM",
    "user_id": "zusr20ksc6vzb29fvbg8zympcnqdm9"
  }
  '

  {
      "cid": "de00deb0471188dcdd9913a8",
      "status": "ok"
  }