# MetashopApiV1.AuthenticationApi

All URIs are relative to *https://localhost/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**authDelete**](AuthenticationApi.md#authDelete) | **DELETE** /auth/ | Account Delete
[**authPasswordGet**](AuthenticationApi.md#authPasswordGet) | **GET** /auth/password | Confirm Reset Password Token
[**authPasswordPost**](AuthenticationApi.md#authPasswordPost) | **POST** /auth/password | Get Link Reset Password From Email
[**authPasswordPut**](AuthenticationApi.md#authPasswordPut) | **PUT** /auth/password | Change Password
[**authPost**](AuthenticationApi.md#authPost) | **POST** /auth/ | Create User
[**authPut**](AuthenticationApi.md#authPut) | **PUT** /auth/ | Upadate User
[**authSignInPost**](AuthenticationApi.md#authSignInPost) | **POST** /auth/sign_in | Login User
[**authSignOutDelete**](AuthenticationApi.md#authSignOutDelete) | **DELETE** /auth/sign_out | Logout User
[**authValidateTokenGet**](AuthenticationApi.md#authValidateTokenGet) | **GET** /auth/validate_token | Validate Token User


<a name="authDelete"></a>
# **authDelete**
> authDelete()

Account Delete

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');
var defaultClient = MetashopApiV1.ApiClient.instance;

// Configure API key authorization: access-token
var access-token = defaultClient.authentications['access-token'];
access-token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access-token.apiKeyPrefix = 'Token';

// Configure API key authorization: client
var client = defaultClient.authentications['client'];
client.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client.apiKeyPrefix = 'Token';

// Configure API key authorization: uid
var uid = defaultClient.authentications['uid'];
uid.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uid.apiKeyPrefix = 'Token';

var apiInstance = new MetashopApiV1.AuthenticationApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authDelete(callback);
```

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

### Return type

null (empty response body)

### Authorization

[access-token](../README.md#access-token), [client](../README.md#client), [uid](../README.md#uid)

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authPasswordGet"></a>
# **authPasswordGet**
> authPasswordGet(opts)

Confirm Reset Password Token

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');

var apiInstance = new MetashopApiV1.AuthenticationApi();

var opts = { 
  'resetPasswordToken': "resetPasswordToken_example", // String | 
  'redirectUrl': "redirectUrl_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authPasswordGet(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **resetPasswordToken** | **String**|  | [optional] 
 **redirectUrl** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authPasswordPost"></a>
# **authPasswordPost**
> authPasswordPost(opts)

Get Link Reset Password From Email

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');

var apiInstance = new MetashopApiV1.AuthenticationApi();

var opts = { 
  'email': "email_example", // String | 
  'redirectUrl': "redirectUrl_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authPasswordPost(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email** | **String**|  | [optional] 
 **redirectUrl** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authPasswordPut"></a>
# **authPasswordPut**
> authPasswordPut(uid, client, accessToken, opts)

Change Password

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');
var defaultClient = MetashopApiV1.ApiClient.instance;

// Configure API key authorization: access-token
var access-token = defaultClient.authentications['access-token'];
access-token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access-token.apiKeyPrefix = 'Token';

// Configure API key authorization: client
var client = defaultClient.authentications['client'];
client.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client.apiKeyPrefix = 'Token';

// Configure API key authorization: uid
var uid = defaultClient.authentications['uid'];
uid.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uid.apiKeyPrefix = 'Token';

var apiInstance = new MetashopApiV1.AuthenticationApi();

var uid = "uid_example"; // String | 

var client = "client_example"; // String | 

var accessToken = "accessToken_example"; // String | 

var opts = { 
  'password': "password_example", // String | 
  'passwordConfirmation': "passwordConfirmation_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authPasswordPut(uid, client, accessToken, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uid** | **String**|  | 
 **client** | **String**|  | 
 **accessToken** | **String**|  | 
 **password** | **String**|  | [optional] 
 **passwordConfirmation** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

[access-token](../README.md#access-token), [client](../README.md#client), [uid](../README.md#uid)

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authPost"></a>
# **authPost**
> authPost(opts)

Create User

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');

var apiInstance = new MetashopApiV1.AuthenticationApi();

var opts = { 
  'email': "email_example", // String | 
  'password': "password_example", // String | 
  'passwordConfirmation': "passwordConfirmation_example", // String | 
  'confirmSuccessUrl': "confirmSuccessUrl_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authPost(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email** | **String**|  | [optional] 
 **password** | **String**|  | [optional] 
 **passwordConfirmation** | **String**|  | [optional] 
 **confirmSuccessUrl** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authPut"></a>
# **authPut**
> authPut(uid, client, accessToken, opts)

Upadate User

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');
var defaultClient = MetashopApiV1.ApiClient.instance;

// Configure API key authorization: access-token
var access-token = defaultClient.authentications['access-token'];
access-token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access-token.apiKeyPrefix = 'Token';

// Configure API key authorization: client
var client = defaultClient.authentications['client'];
client.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client.apiKeyPrefix = 'Token';

// Configure API key authorization: uid
var uid = defaultClient.authentications['uid'];
uid.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uid.apiKeyPrefix = 'Token';

var apiInstance = new MetashopApiV1.AuthenticationApi();

var uid = "uid_example"; // String | 

var client = "client_example"; // String | 

var accessToken = "accessToken_example"; // String | 

var opts = { 
  'user': new MetashopApiV1.User() // User | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authPut(uid, client, accessToken, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **uid** | **String**|  | 
 **client** | **String**|  | 
 **accessToken** | **String**|  | 
 **user** | [**User**](User.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[access-token](../README.md#access-token), [client](../README.md#client), [uid](../README.md#uid)

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authSignInPost"></a>
# **authSignInPost**
> authSignInPost(opts)

Login User

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');

var apiInstance = new MetashopApiV1.AuthenticationApi();

var opts = { 
  'email': "email_example", // String | 
  'password': "password_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authSignInPost(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email** | **String**|  | [optional] 
 **password** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authSignOutDelete"></a>
# **authSignOutDelete**
> authSignOutDelete()

Logout User

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');
var defaultClient = MetashopApiV1.ApiClient.instance;

// Configure API key authorization: access-token
var access-token = defaultClient.authentications['access-token'];
access-token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access-token.apiKeyPrefix = 'Token';

// Configure API key authorization: client
var client = defaultClient.authentications['client'];
client.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client.apiKeyPrefix = 'Token';

// Configure API key authorization: uid
var uid = defaultClient.authentications['uid'];
uid.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uid.apiKeyPrefix = 'Token';

var apiInstance = new MetashopApiV1.AuthenticationApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authSignOutDelete(callback);
```

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

### Return type

null (empty response body)

### Authorization

[access-token](../README.md#access-token), [client](../README.md#client), [uid](../README.md#uid)

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined

<a name="authValidateTokenGet"></a>
# **authValidateTokenGet**
> authValidateTokenGet()

Validate Token User

### Example
```javascript
var MetashopApiV1 = require('metashop_api_v1');
var defaultClient = MetashopApiV1.ApiClient.instance;

// Configure API key authorization: access-token
var access-token = defaultClient.authentications['access-token'];
access-token.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access-token.apiKeyPrefix = 'Token';

// Configure API key authorization: client
var client = defaultClient.authentications['client'];
client.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//client.apiKeyPrefix = 'Token';

// Configure API key authorization: uid
var uid = defaultClient.authentications['uid'];
uid.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//uid.apiKeyPrefix = 'Token';

var apiInstance = new MetashopApiV1.AuthenticationApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.authValidateTokenGet(callback);
```

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

### Return type

null (empty response body)

### Authorization

[access-token](../README.md#access-token), [client](../README.md#client), [uid](../README.md#uid)

### HTTP request headers

 - **Content-Type**: application/json, application/xml
 - **Accept**: Not defined