PUT /api/users/{UserID}/registration/state

Changes the signup state for the specified user. This operation allows the site administrator to activate a new user's account by changing the user's signup state from pending_validation to registered. This completes the user registration process without the user having to complete signup using the activation code.

Note: This operation is only for initial account activation. To make further changes to a user's account once it's been activated, such as to disable it or to re-enable it, use the PUT /api/users/{UserID}/status operation.

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

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/users/{UserID}/registration/state

Back to top

Sample Request

The example below shows a request to change the signup state for the specified user.

Request URL

http://soa.local.com/api/users/user10027.acmepaymentscorp/registration/state

Sample request headers

PUT /api/users/user10027.acmepaymentscorp/registration/state HTTP/1.1
Host: {hostname}
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
"SignupState":"registered"
}

Back to top

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

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.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
UserID Path string Required The unique ID for a specific user. You can get the specific UserID from the response message to the POST /api/users/signupUser[/{InvitationCode}] operation when the user signs up for the platform.
ChangeSignupStateRequest Body ChangeSignupStateRequest Required Contains information about a request to change a user's signup state.

Back to top

Response

If successful, this operation returns HTTP status code 200, with updated information about the user.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Wed, 26 Jun 2013 19:16:06 GMT
Content-Type: application/json

Sample response body: application/json

{
  "UserID" : "user10030.acmepaymentscorp",
  "UserName" : "JonathanSwift",
  "FirstName" : "Jonathan",
  "LastName" : "Swift",
  "AuthIdentifier" : "",
  "Visibility" : "0",
  "Email" : "jswift@acmepaymentscorp.com",
  "Title" : "",
  "Industry" : "",
  "Favorites" : "",
  "HasPicture" : false,
  "State" : "registered",
  "Domain" : "Local Domain",
  "Disabled" : true,
  "ProfileName" : "JonathanSwift"
}

Back to top

Sample response headers: application/xml

HTTP/1.1 200 OK
Date: Wed, 26 Jun 2013 18:41:25 GMT
Content-Type: application/xml

Sample response body: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<User xmlns="http://soa.com/xsd/user/1.0" xmlns:ns2="http://soa.com/xsd/business/1.0">
  <UserID>user10027.acmepaymentscorp</UserID>
  <UserName>JaneSaoirse</UserName>
  <FirstName>Jane</FirstName>
  <LastName>Saoirse</LastName>
  <AuthIdentifier></AuthIdentifier>
  <Visibility>0</Visibility>
  <Email>jane.saoirse@acmepaymentscorp.com</Email>
  <Title></Title>
  <Industry></Industry>
  <Favorites></Favorites>
  <HasPicture>false</HasPicture>
  <State>registered</State>
  <Domain>Local Domain</Domain>
  <Disabled>true</Disabled>
  <ProfileName>JaneSaoirse</ProfileName>
</User>

Back to top

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

Back to top

Response Body

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

Back to top

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.

Back to top

Related Topics