alfresco-js-api/src/alfresco-activiti-rest-api/docs/ProfileApi.md

JavaScript client library for the Alfresco REST API

# ActivitiPublicRestApi.ProfileApi

All URIs are relative to *https://localhost:8080/activiti-app*

Method | HTTP request | Description
------------- | ------------- | -------------
[**changePassword**](ProfileApi.md#changePassword) | **POST** /api/enterprise/profile-password | Change user password
[**getProfilePicture**](ProfileApi.md#getProfilePicture) | **GET** /api/enterprise/profile-picture | Retrieve user profile picture
[**getProfilePictureUrl**](ProfileApi.md#getProfile) | **GET** /app/rest/admin/profile-picture | Retrieve Url user profile picture
[**getProfile**](ProfileApi.md#getProfile) | **GET** /api/enterprise/profile | Retrieve user information
[**updateProfile**](ProfileApi.md#updateProfile) | **POST** /api/enterprise/profile | Update user information
[**uploadProfilePicture**](ProfileApi.md#uploadProfilePicture) | **POST** /api/enterprise/profile-picture | Change user profile picture


<a name="changePassword"></a>
# **changePassword**
> changePassword(changePasswordRepresentation)

Change user password

### Example
```javascript

var changePasswordRepresentation = new this.alfrescoJsApi.activiti.ChangePasswordRepresentation(); // ChangePasswordRepresentation | changePasswordRepresentation

this.alfrescoJsApi.activiti.profileApi.changePassword(changePasswordRepresentation);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **changePasswordRepresentation** | [**ChangePasswordRepresentation**](ChangePasswordRepresentation.md)| changePasswordRepresentation | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="getProfilePicture"></a>
# **getProfilePicture**
> File getProfilePicture()

Retrieve user profile buffered array picture

Generally returns an image file

### Example
```javascript

this.alfrescoJsApi.activiti.profileApi.getProfilePicture();
```

### Parameters
This endpoint does not need any parameter.

### Return type

**File**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="getProfilePictureUrl"></a>
# **getProfilePictureUrl**
> File getProfilePictureUrl()

Retrieve user url profile picture

Generally returns an URL image file

### Example
```javascript

this.alfrescoJsApi.activiti.profileApi.getProfilePictureUrl();
```

### Parameters
This endpoint does not need any parameter.

### Return type

**String**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json
 
<a name="getProfile"></a>
# **getProfile**
> UserRepresentation getProfile()

Retrieve user information

 This is useful to get the name, email, the groups that the user is part of, the user picture, etc.

### Example
```javascript

this.alfrescoJsApi.activiti.profileApi.getProfile();
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**UserRepresentation**](UserRepresentation.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="updateProfile"></a>
# **updateProfile**
> UserRepresentation updateProfile(userRepresentation)

Update user information

Only a first name, last name, email and company can be updated

### Example
```javascript

var userRepresentation = new this.alfrescoJsApi.activiti.UserRepresentation(); // UserRepresentation | userRepresentation

this.alfrescoJsApi.activiti.profileApi.updateProfile(userRepresentation);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userRepresentation** | [**UserRepresentation**](UserRepresentation.md)| userRepresentation | 

### Return type

[**UserRepresentation**](UserRepresentation.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="uploadProfilePicture"></a>
# **uploadProfilePicture**
> ImageUploadRepresentation uploadProfilePicture(file)

Change user profile picture

### Example
```javascript

var file = "/path/to/file.txt"; // File | file

this.alfrescoJsApi.activiti.profileApi.uploadProfilePicture(file);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **file** | **File**| file | 

### Return type

[**ImageUploadRepresentation**](ImageUploadRepresentation.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: application/json