PUT /api/users/{UserID}/status

Changes the status of the specified user (for example, enabled, disabled, locked).

Note: This operation is only for changing the status of a registered site member. If you need to activate a user's account after the user has signed up and before activation, use the PUT /api/users/{UserID}/registration/state operation.

Authorization Roles/Permissions: Must be logged in. Site Admin only.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/users/{UserID}/status

Sample Request

The example below shows a status change, locking the user account with a comment.

Sample Request URL

https://{hostname}/api/users/f57dd9cc-2608-456e-9dfa-300c85224a73.acmepaymentscorp/status

Sample request headers

Content-Type: application/json
Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "UserStatus" : "com.soa.user.status.locked",
  "Comments" : "Locking user account because account was compromised"
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml application/vnd.soa.v81+json or application/vnd.soa.v81+xml
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
UserID	Path	string	Required	The unique ID for a specific user.
ChangeUserStatusRequest	Body	ChangeUserStatusRequest	Required	Contains information about a user's change of status, with comments.

Response

If successful, this operation returns HTTP status code 200, with information about the user in JSON or XML format.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 04 Feb 2015 17:42:18 GMT

Sample response body: application/json

{
  "UserID" : "f57dd9cc-2608-456e-9dfa-300c85224a73.acmepaymentscorp",
  "UserName" : "PhilipPirrip",
  "FirstName" : "Philip",
  "LastName" : "Pirrip",
  "AuthIdentifier" : "",
  "Visibility" : "0",
  "Email" : "ppirrip@acmepaymentscorp.com",
  "Title" : "",
  "Industry" : "",
  "Favorites" : "",
  "HasPicture" : false,
  "State" : "registered",
  "Domain" : "Local Domain",
  "LastLoginDate" : "2015-02-04T22:30:36Z",
  "Disabled" : false,
  "ProfileName" : "PhilipPirrip",
  "ForcePasswordChangeOnLogin" : false,
  "Locked" : true
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/xml, application/vnd.soa.v71+json, application/vnd.soa.v71+xml, application/vnd.soa.v72+json, application/vnd.soa.v72+xml, application/vnd.soa.v80+json, application/vnd.soa.v80+xml, application/vnd.soa.v81+json, application/vnd.soa.v81+xml

Response Body

Name	Type	Description
User	User	Contains information about a platform user.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. You would also get this response if you hadn't completed login before running the operation, or if you were not a Site Admin.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics