PUT api/users/{userId}

Updates a specific User.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

The id of the User to update.

globally unique identifier

Required



Body Parameters

A model describing the state to update the User to.

UpdateUserViewModel
NameDescriptionTypeAdditional information
Email

string

None.

IsNew

boolean

None.

IsPortalUser

boolean

None.

Permissions

Collection of UserPermissionViewModel

None.

PortalEntityInstanceId

integer

None.

RoleId

globally unique identifier

None.

UserId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "Email": "sample string 1",
  "IsNew": true,
  "IsPortalUser": true,
  "Permissions": [
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "Id": 1,
      "PermissionId": 2
    },
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "Id": 1,
      "PermissionId": 2
    }
  ],
  "PortalEntityInstanceId": 1,
  "RoleId": "c0dd9a1d-d7bd-444c-8758-1e6738517609",
  "UserId": "769650d3-2f87-4dfd-8810-218c81253087"
}

application/xml, text/xml

Sample:
<UpdateUserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <Email>sample string 1</Email>
  <IsNew>true</IsNew>
  <IsPortalUser>true</IsPortalUser>
  <Permissions>
    <UserPermissionViewModel>
      <EntityAttributeId>1</EntityAttributeId>
      <EntityCategoryId>1</EntityCategoryId>
      <EntityDefinitionId>1</EntityDefinitionId>
      <FileDirectoryId>1</FileDirectoryId>
      <Id>1</Id>
      <PermissionId>2</PermissionId>
    </UserPermissionViewModel>
    <UserPermissionViewModel>
      <EntityAttributeId>1</EntityAttributeId>
      <EntityCategoryId>1</EntityCategoryId>
      <EntityDefinitionId>1</EntityDefinitionId>
      <FileDirectoryId>1</FileDirectoryId>
      <Id>1</Id>
      <PermissionId>2</PermissionId>
    </UserPermissionViewModel>
  </Permissions>
  <PortalEntityInstanceId>1</PortalEntityInstanceId>
  <RoleId>c0dd9a1d-d7bd-444c-8758-1e6738517609</RoleId>
  <UserId>769650d3-2f87-4dfd-8810-218c81253087</UserId>
</UpdateUserViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

A ReadUserViewModel representing the updated User.

ReadUserViewModel

NameDescriptionTypeAdditional information
CanBeModified

boolean

None.

Email

string

None.

IsPortalUser

boolean

None.

Permissions

Collection of UserPermissionViewModel

None.

PortalEntityInstanceId

integer

None.

RoleId

globally unique identifier

None.

RoleName

string

None.

UserGroupId

integer

None.

UserId

globally unique identifier

None.

UserName

string

None.