PUT api/2.0/people/{userid}/password This function requires authentication

Description

Sets a new password to the user with the ID specified in the request.

Parameters

Name	Description	Type	Example
userid sent in url	User ID	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
Type sent in body	Employee type (All, RoomAdmin, User, DocSpaceAdmin, Collaborator)	All, RoomAdmin, User, DocSpaceAdmin, Collaborator	All
IsUser sent in body	Specifies if this is a guest or a user	Bool value	true
Email sent in body	Email	string	some text
Firstname sent in body	First name	string	some text
Lastname sent in body	Last name	string	some text
Department sent in body	List of user departments	Collection of Guids	9924256A-739C-462b-AF15-E652A3B1B6EB
Title sent in body	Title	string	some text
Location sent in body	Location	string	some text
Sex sent in body	Sex (male or female)	string	some text
Birthday sent in body	Birthday	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
Worksfrom sent in body	Registration date (if it is not specified, then the current date will be set)	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
Comment sent in body	Comment	string	some text
Contacts sent in body	List of user contacts	Collection of ASC.Web.Api.Models.Contacts collection
Files sent in body	Avatar photo URL	string	some text
Password sent in body	Password	string	some text
PasswordHash sent in body	Password hash	string	some text
FromInviteLink sent in body	Specifies if the user is added via the invitation link or not	Bool value	true
Key sent in body	Key	string	some text
CultureName sent in body	Language	string	some text
Target sent in body	Target	guid	9924256A-739C-462b-AF15-E652A3B1B6EB

Example

PUT api/2.0/people/%229924256A-739C-462b-AF15-E652A3B1B6EB%22/password
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "Type": "All",
  "IsUser": true,
  "Email": "some text",
  "Firstname": "some text",
  "Lastname": "some text",
  "Department": [
    "9924256a-739c-462b-af15-e652a3b1b6eb",
    "98777e9c-f2a7-4e97-b314-ba9f92c2e882"
  ],
  "Title": "some text",
  "Location": "some text",
  "Sex": "some text",
  "Birthday": "2008-04-10T06-30-00.000Z",
  "Worksfrom": "2008-04-10T06-30-00.000Z",
  "Comment": "some text",
  "Files": "some text",
  "Password": "some text",
  "PasswordHash": "some text",
  "FromInviteLink": true,
  "Key": "some text",
  "CultureName": "some text",
  "Target": "9924256A-739C-462b-AF15-E652A3B1B6EB"
}

Returns

Detailed user information

Example Response

{
  "status": 0,
  "response": {
    "FirstName": "some text",
    "LastName": "some text",
    "UserName": "some text",
    "Email": "some text",
    "Birthday": "2008-04-10T06-30-00.000Z",
    "Sex": "some text",
    "Status": "Active",
    "ActivationStatus": "NotActivated",
    "Terminated": "2008-04-10T06-30-00.000Z",
    "Department": "some text",
    "WorkFrom": "2008-04-10T06-30-00.000Z",
    "Location": "some text",
    "Notes": "some text",
    "AvatarOriginal": "some text",
    "AvatarMax": "some text",
    "AvatarMedium": "some text",
    "Avatar": "some text",
    "IsAdmin": true,
    "IsRoomAdmin": true,
    "IsLDAP": true,
    "ListAdminModules": [
      "some text"
    ],
    "IsOwner": true,
    "IsVisitor": true,
    "IsCollaborator": true,
    "CultureName": "some text",
    "MobilePhone": "some text",
    "MobilePhoneActivationStatus": "NotActivated",
    "IsSSO": true,
    "QuotaLimit": 1234,
    "UsedSpace": 1234,
    "IsCustomQuota": true
  }
}

PUT api/2.0/people/{userid}/password This function requires authentication

Get information

Get help