PUT /api/users/{UserID}/domains/{DomainID}

Updates the login domain for a user, from the current login domain to a different, valid login domain.

Note: When the Site Admin changes the user's login domain from another domain to the local domain, password reset is needed, since the user's password information isn't accessible to the local domain. To reset the user's password, use the PUT /api/users/{UserID}/password operation.

Authorization Roles/Permissions: Must be logged in. Site Admin. Note that the Site Admin cannot change himself/herself to a different domain.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/users/{UserID}/domains/{DomainID}

Back to top

Sample Request

The example below shows a request to change the user's domain from LDAP to Local Domain.

Request URL

https://{hostname}/api/users/b339a885-3bb5-4c4b-87cd-834cac68eacd.acmepaymentscorp/domains/LDAP

Sample request headers

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

Sample request body

{
  "UserDomain":"Local Domain",
  "Comments":"changing user from LDAP to Local Domain"
}

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.v84+json, application/vnd.soa.v84+xml
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/xml, application/vnd.soa.v84+json, application/vnd.soa.v84+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.
DomainID Path string Required

The unique ID for a specific login domain.

In this case it is the ID for the user's current domain.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

content-type: application/json
date: Wed, 14 Feb 2018 16:29:47 GMT

Sample response body: application/json

{
    "classifiers": {},
    "artifacts": {},
    "UserID": "b339a885-3bb5-4c4b-87cd-834cac68eacd.acmepaymentscorp",
    "UserName": "eng1",
    "FirstName": "Engineering1",
    "LastName": "User1",
    "AuthIdentifier": "eng1",
    "Visibility": "0",
    "Email": "eng1@example.com",
    "Title": "",
    "Industry": "",
    "Favorites": "",
    "AvatarProvider": "com.soa.imageprovider.type.default",
    "HasPicture": false,
    "State": "registered",
    "Updated": "2018-02-14T16:28:25Z",
    "Domain": "Local Domain",
    "LastLoginDate": "2018-02-14T16:28:25Z",
    "Disabled": false,
    "ProfileName": "Engineering1User1",
    "ForcePasswordChangeOnLogin": false,
    "Locked": false,
    "UserPhones": {
        "UserPhone": []
    }
}

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.v84+json, application/vnd.soa.v84+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
400 Bad request: Returned if the client sends invalid parameters or body content. For example, you might get this response if you send an incorrect JSON object in the request, or included incorrect values; for example, if one of the domains was invalid.
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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics