Method Detail

• createPerson

  @Headers(value = {Content-Type: application/json})@POST(value = alfresco/versions/1/people) abstract PersonEntry createPerson(@Body() PersonBodyCreate personBodyCreate, @Query(value = fields) List<String> fields)

  Create person Note: this endpoint is available in Alfresco 5.2 and newer versions. Create a person. If applicable, the given person's login access can also be optionally disabled. You must have admin rights to create a person. You can set custom properties when you create a person: ``JSON { \"id\": \"abeecher\", \"firstName\": \"Alice\", \"lastName\": \"Beecher\", \"displayName\": \"Alice Beecher\", \"email\": \"abeecher@example.com\", \"password\": \"secret\", \"properties\": { \"my:property\": \"The value\" } } ``Note: setting properties of type d:content and d:category are not supported. The endpoint is owned by defaultname service owner @param personBodyCreate The person details. (required) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)

• deleteAvatarImage

  @Headers(value = {Content-Type: application/json})@DELETE(value = alfresco/versions/1/people/{personId}/avatar) abstract Unit deleteAvatarImage(@Path(value = personId) String personId)

  Delete avatar image Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Deletes the avatar image related to person personId. You must be the person or have admin rights to update a person's avatar. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

  Parameters:

  personId - The identifier of a person.

• getAvatarImage

  @Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/people/{personId}/avatar) abstract ResponseBody getAvatarImage(@Path(value = personId) String personId, @Query(value = attachment) Boolean attachment, @Header(value = If-Modified-Since) ZonedDateTime ifModifiedSince, @Query(value = placeholder) Boolean placeholder)

  Get avatar image Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Gets the avatar image related to the person personId. If the person has no related avatar then the placeholder query parameter can be optionally used to request a placeholder image to be returned. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

  Parameters:

  personId - The identifier of a person.

  attachment - true enables a web browser to download the file as an attachment.

  ifModifiedSince - Only returns the content if it has been modified since the date provided.

  placeholder - If true and there is no avatar for this personId then the placeholder image is returned, rather than a 404 response.

• getPerson

  @Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/people/{personId}) abstract PersonEntry getPerson(@Path(value = personId) String personId, @Query(value = fields) List<String> fields)

  Get a person Gets information for the person personId. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

  Parameters:

  personId - The identifier of a person.

  fields - A list of field names.

• listPeople

  @Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/people) abstract PersonPaging listPeople(@Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = orderBy) List<String> orderBy, @Query(value = include) List<String> include, @Query(value = fields) List<String> fields)

  List people Note: this endpoint is available in Alfresco 5.2 and newer versions. List people. You can use the include parameter to return any additional information. The default sort order for the returned list is for people to be sorted by ascending id. You can override the default by using the orderBy parameter. You can use any of the following fields to order the results: * id * firstName * lastName The endpoint is owned by defaultname service owner

  Parameters:

  skipCount - The number of entities that exist in the collection before those included in this list.

  maxItems - The maximum number of items to return in the list.

  orderBy - A string to control the order of the entities returned in a list.

  include - Returns additional information about the person.

  fields - A list of field names.

• requestPasswordReset

  @Headers(value = {Content-Type: application/json})@POST(value = alfresco/versions/1/people/{personId}/request-password-reset) abstract Unit requestPasswordReset(@Path(value = personId) String personId, @Body() ClientBody clientBody)

  Request password reset Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Initiates the reset password workflow to send an email with reset password instruction to the user's registered email. The client is mandatory in the request body. For example: ``JSON { \"client\": \"myClient\" } ``Note: The client must be registered before this API can send an email. See server documentation. However, out-of-the-box share is registered as a default client, so you could pass share as the client name: ``JSON { \"client\": \"share\" } ``Note: No authentication is required to call this endpoint. The endpoint is owned by defaultname service owner @param personId The identifier of a person. (required) @param clientBody The client name to send email with app-specific url. (required)

• resetPassword

  @Headers(value = {Content-Type: application/json})@POST(value = alfresco/versions/1/people/{personId}/reset-password) abstract Unit resetPassword(@Path(value = personId) String personId, @Body() PasswordResetBody passwordResetBody)

  Reset password Note: this endpoint is available in Alfresco 5.2.1 and newer versions. Resets user's password The password, id and key properties are mandatory in the request body. For example: ``JSON { \"password\":\"newPassword\", \"id\":\"activiti$10\", \"key\":\"4dad6d00-0daf-413a-b200-f64af4e12345\" } ``Note: No authentication is required to call this endpoint. The endpoint is owned by defaultname service owner @param personId The identifier of a person. (required) @param passwordResetBody The reset password details (required)

• updateAvatarImage

  @Headers(value = {Content-Type: application/octet-stream})@PUT(value = alfresco/versions/1/people/{personId}/avatar) abstract Unit updateAvatarImage(@Path(value = personId) String personId, @Body() List<Byte> contentBodyUpdate)

  Update avatar image Note: this endpoint is available in Alfresco 5.2.2 and newer versions. Updates the avatar image related to the person personId. The request body should be the binary stream for the avatar image. The content type of the file should be an image file. This will be used to generate an \"avatar\" thumbnail rendition. You must be the person or have admin rights to update a person's avatar. You can use the -me- string in place of <personId> to specify the currently authenticated user. The endpoint is owned by defaultname service owner

  Parameters:

  personId - The identifier of a person.

  contentBodyUpdate - The binary content (required)

• updatePerson

  @Headers(value = {Content-Type: application/json})@PUT(value = alfresco/versions/1/people/{personId}) abstract PersonEntry updatePerson(@Path(value = personId) String personId, @Body() PersonBodyUpdate personBodyUpdate, @Query(value = fields) List<String> fields)

  Update person Note: this endpoint is available in Alfresco 5.2 and newer versions. Update the given person's details. You can use the -me- string in place of <personId> to specify the currently authenticated user. If applicable, the given person's login access can also be optionally disabled or re-enabled. You must have admin rights to update a person — unless updating your own details. If you are changing your password, as a non-admin user, then the existing password must also be supplied (using the oldPassword field in addition to the new password value). Admin users cannot be disabled by setting enabled to false. Non-admin users may not disable themselves. You can set custom properties when you update a person: ``JSON { \"firstName\": \"Alice\", \"properties\": { \"my:property\": \"The value\" } } ``Note: setting properties of type d:content and d:category are not supported. The endpoint is owned by defaultname service owner @param personId The identifier of a person. (required) @param personBodyUpdate The person details. (required) @param fields A list of field names. You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. The list applies to a returned individual entity or entries within a collection. If the API method also supports the include parameter, then the fields specified in the include parameter are returned in addition to those specified in the fields parameter. (optional)