Merge pull request #242 from roymx/v170-api-doc

# OpenAPI Generator Ignore

# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.

# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.

# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:

#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):

#foo/*/qux

# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):

#foo/**/qux

# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).

# For example, you can ignore all files in a docs folder with the file extension .md:

#docs/*.md

# Then explicitly reverse the ignore rule for a single file:

#!docs/README.md

.openapi-generator-ignore

Apis/AuthApi.md

Models/Sandbox.md

README.md

5.0.0-beta2

 No newline at end of file

# AuthApi

All URIs are relative to *http://localhost/auth/v1*

Method | HTTP request | Description

------------- | ------------- | -------------

[**authenticate**](AuthApi.md#authenticate) | **GET** /authenticate | Authenticate service request

[**authorize**](AuthApi.md#authorize) | **GET** /authorize | OAuth authorization response endpoint

[**login**](AuthApi.md#login) | **GET** /login | Initiate OAuth login procedure

[**loginSupported**](AuthApi.md#loginSupported) | **GET** /loginSupported | Check if login is supported

[**loginUser**](AuthApi.md#loginUser) | **POST** /login | Start a session

[**logout**](AuthApi.md#logout) | **GET** /logout | Terminate a session

[**triggerWatchdog**](AuthApi.md#triggerWatchdog) | **POST** /watchdog | Send heartbeat to watchdog

<a name="authenticate"></a>

# **authenticate**

> authenticate(svc, sbox)

Authenticate service request

    Authenticate & authorize microservice endpoint access

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **svc** | **String**| Service requesting authentication | [optional] [default to null]

 **sbox** | **String**| Sandbox name | [optional] [default to null]

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: Not defined

<a name="authorize"></a>

# **authorize**

> authorize(code, state)

OAuth authorization response endpoint

    Redirect URI endpoint for OAuth authorization responses. Starts a user session.

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **code** | **String**| Temporary authorization code | [optional] [default to null]

 **state** | **String**| User-provided random state | [optional] [default to null]

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: Not defined

<a name="login"></a>

# **login**

> login(provider, sbox)

Initiate OAuth login procedure

    Start OAuth login procedure with provider

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **provider** | **String**| Oauth provider | [optional] [default to null] [enum: github, gitlab]

 **sbox** | **String**| Create Sandbox by default | [optional] [default to null] [enum: true, false]

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: Not defined

<a name="loginSupported"></a>

# **loginSupported**

> loginSupported()

Check if login is supported

    Check if login is supported and whether session exists

### Parameters

This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: Not defined

<a name="loginUser"></a>

# **loginUser**

> Sandbox loginUser(username, password)

Start a session

    Start a session after authenticating user

### Parameters

Name | Type | Description  | Notes

------------- | ------------- | ------------- | -------------

 **username** | **String**| User Name | [optional] [default to null]

 **password** | **String**| User Password | [optional] [default to null]

### Return type

[**Sandbox**](../Models/Sandbox.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded

- **Accept**: application/json

<a name="logout"></a>

# **logout**

> logout()

Terminate a session

    Terminate a session

### Parameters

This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: Not defined

<a name="triggerWatchdog"></a>

# **triggerWatchdog**

> triggerWatchdog()

Send heartbeat to watchdog

    Send heartbeat to watchdog to keep session alive

### Parameters

This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined

- **Accept**: Not defined

# Sandbox

## Properties

Name | Type | Description | Notes

------------ | ------------- | ------------- | -------------

**name** | [**String**](string.md) | Sandbox name | [optional] [default to null]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)