alfresco-js-api/src/alfresco-auth-rest-api/docs/AuthenticationApi.md

JavaScript client library for the Alfresco REST API

# AlfrescoAuthRestApi.AuthenticationApi

All URIs are relative to *https://localhost/alfresco/api/-default-/public/authentication/versions/1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createTicket**](AuthenticationApi.md#createTicket) | **POST** /tickets | Create ticket (login)
[**deleteTicket**](AuthenticationApi.md#deleteTicket) | **DELETE** /tickets/-me- | Delete ticket (logout)
[**validateTicket**](AuthenticationApi.md#validateTicket) | **GET** /tickets/-me- | Validate ticket


<a name="createTicket"></a>
# **createTicket**
> LoginTicketEntry createTicket(loginRequest)

Create ticket (login)

Logs in and returns the new authentication ticket.
The userId and password properties are mandatory in the request body. For example:
```JSON
{
    "userId": "jbloggs",
    "password": "password"
}
```
To use the ticket in future requests you should pass it in the request header.
For example using Javascript:
  ```Javascript
    request.setRequestHeader ("Authorization", "Basic " + btoa(ticket));
  ```


### Example
```javascript
var AlfrescoAuthRestApi = require('alfresco-auth-rest-api');
var defaultClient = AlfrescoAuthRestApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var apiInstance = new AlfrescoAuthRestApi.AuthenticationApi()

var loginRequest = new AlfrescoAuthRestApi.LoginRequest(); // {LoginRequest} The user credential.

apiInstance.createTicket(loginRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **loginRequest** | [**LoginRequest**](LoginRequest.md)| The user credential. |

### Return type

[**LoginTicketEntry**](LoginTicketEntry.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

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

<a name="deleteTicket"></a>
# **deleteTicket**
> deleteTicket

Delete ticket (logout)

Deletes logged in ticket (logout).


### Example
```javascript

this.alfrescoJsApi.ecmAuth.deleteTicket().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

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

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

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

<a name="validateTicket"></a>
# **validateTicket**
> ValidateTicketEntry validateTicket

Validate ticket

Validates the specified ticket (derived from Authorization header) is still valid.

For example, you can pass the Authorization request header using Javascript:
  ```Javascript
    request.setRequestHeader ("Authorization", "Basic " + btoa(ticket));
  ```


### Example
```javascript
      
this.alfrescoJsApi.ecmAuth.validateTicket().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

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

### Return type

[**ValidateTicketEntry**](ValidateTicketEntry.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

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