yousign_client 1.0.0

data/docs/SignatureUiInput.md

@@ -0,0 +1,28 @@
+# YousignClient::SignatureUiInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Signature UI's name | 
+**description** | **String** | Signature UI's description | [optional] 
+**enable_header_bar** | **BOOLEAN** | Toggle header bar of the app view | [optional] [default to true]
+**enable_header_bar_sign_as** | **BOOLEAN** | Toggle \"Sign as\" band on the top of the app view | [optional] [default to true]
+**enable_sidebar** | **BOOLEAN** | Toggle sidebar of the app view | [optional] [default to true]
+**enable_member_list** | **BOOLEAN** | Toggle list of members in the procedure | [optional] [default to true]
+**enable_document_list** | **BOOLEAN** | Toggle list of documents in the procedure | [optional] [default to true]
+**enable_document_download** | **BOOLEAN** | Toggle downloads buttons for documents | [optional] [default to true]
+**enable_activities** | **BOOLEAN** | Toggle activity feed | [optional] [default to true]
+**authentication_popup** | **BOOLEAN** | True for use a popup to enter the SMS code, false for use a fullscreen view. | [optional] [default to false]
+**default_zoom** | **Float** | Default value for zoom of the PDF viewer. Default value is the adapted to the resolution of your screen. | [optional] 
+**logo** | **String** | Base64 of your logo | [optional] 
+**sign_image_types_available** | **Array<String>** | Allow sign images types available for signature. The first type of the list will be selected as default for the signer. | [optional] 
+**default_language** | **String** | Default selected language of the interface. Must be present in \"languages\" field. | [optional] 
+**languages** | **Array<String>** | Array of allowed languages, use country code | [optional] 
+**labels** | [**Array<SignatureUiLabelInputIncluded>**](SignatureUiLabelInputIncluded.md) |  | [optional] 
+**fonts** | **Array<String>** | List of fonts to load on the view. (Loaded via Google fonts) | [optional] 
+**style** | **String** | CSS for customize the view | [optional] 
+**redirect_cancel** | [**SignatureUiInputRedirectCancel**](SignatureUiInputRedirectCancel.md) |  | [optional] 
+**redirect_error** | [**SignatureUiInputRedirectError**](SignatureUiInputRedirectError.md) |  | [optional] 
+**redirect_success** | [**SignatureUiInputRedirectSuccess**](SignatureUiInputRedirectSuccess.md) |  | [optional] 
+
+

data/docs/SignatureUiInputRedirectCancel.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiInputRedirectCancel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of redirect | [optional] 
+**target** | **String** | Target of the redirection | [optional] [default to '_top']
+**auto** | **BOOLEAN** | Don't redirect the user directly, send to our detail of the procedure view. But invite the user to click on a button for use this redirection. | [optional] [default to true]
+
+

data/docs/SignatureUiInputRedirectError.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiInputRedirectError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of redirect | 
+**target** | **String** | Target of the redirection | [optional] 
+**auto** | **BOOLEAN** | Don't redirect the user directly, send to our detail of the procedure view. But invite the user to click on a button for use this redirection. | [optional] [default to true]
+
+

data/docs/SignatureUiInputRedirectSuccess.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiInputRedirectSuccess
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of redirect | [optional] 
+**target** | **String** | Target of the redirection | [optional] 
+**auto** | **BOOLEAN** | Don't redirect the user directly, send to our detail of the procedure view. But invite the user to click on a button for use this redirection. | [optional] [default to true]
+
+

data/docs/SignatureUiInputUpdate.md

@@ -0,0 +1,27 @@
+# YousignClient::SignatureUiInputUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Resource's name | 
+**description** | **String** | Signature UI's description | [optional] 
+**enable_header_bar** | **BOOLEAN** | Toggle header bar of the app view | [optional] [default to true]
+**enable_header_bar_sign_as** | **BOOLEAN** | Toggle \"Sign as\" band on the top of the app view | [optional] [default to true]
+**enable_sidebar** | **BOOLEAN** | Toggle sidebar of the app view | [optional] [default to true]
+**enable_member_list** | **BOOLEAN** | Toggle list of members in the procedure | [optional] [default to true]
+**enable_document_list** | **BOOLEAN** | Toggle list of documents in the procedure | [optional] [default to true]
+**enable_document_download** | **BOOLEAN** | Toggle downloads buttons for documents | [optional] [default to true]
+**enable_activities** | **BOOLEAN** | Toggle activity feed | [optional] [default to true]
+**authentication_popup** | **BOOLEAN** | True for use a popup for enter the SMS code, false for use a fullscreen view. | [optional] [default to false]
+**default_zoom** | **Float** | Default zoom of the pdf viewer. Default is the adapted to the resolution of your screen. | [optional] 
+**logo** | **String** | Base64 of your logo | [optional] 
+**sign_image_types_available** | **Array<String>** | Allow sign images types available for signature. | [optional] 
+**default_language** | **String** | Default language of the view. Must be in \"languages\" field. | [optional] 
+**languages** | **Array<String>** | Array of allowed languages, use country code | [optional] 
+**fonts** | **Array<String>** | List of fonts to load on the view. (Loaded via google fonts) | [optional] 
+**style** | **String** | CSS for customize the view | [optional] 
+**redirect_cancel** | [**SignatureUiOutputRedirectCancel**](SignatureUiOutputRedirectCancel.md) |  | [optional] 
+**redirect_error** | [**SignatureUiOutputRedirectError**](SignatureUiOutputRedirectError.md) |  | [optional] 
+**redirect_success** | [**SignatureUiOutputRedirectSuccess**](SignatureUiOutputRedirectSuccess.md) |  | [optional] 
+
+

data/docs/SignatureUiLabelInput.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiLabelInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the label. If the name is not used in the view, nothing will appear. | 
+**languages** | **Object** | Translation of the label per language | [optional] 
+**signature_ui** | **String** | Associated Signature UI's ID | [optional] 
+
+

data/docs/SignatureUiLabelInputIncluded.md

@@ -0,0 +1,9 @@
+# YousignClient::SignatureUiLabelInputIncluded
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the label. If the name is not used in the view, nothing will appear. | 
+**languages** | **Object** | Translation of the label per language | [optional] 
+
+

data/docs/SignatureUiLabelOutput.md

@@ -0,0 +1,14 @@
+# YousignClient::SignatureUiLabelOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Resource's ID | [optional] 
+**name** | **String** | Name of the label. If the name is not used in the view, nothing will appear. | [optional] 
+**languages** | **Object** | Translation of the label per language | [optional] 
+**signature_ui** | **String** | Associated signature UI's ID | [optional] 
+**creator** | **String** | Creator's ID | [optional] 
+**created_at** | **DateTime** | Date of creation | [optional] 
+**updated_at** | **DateTime** | Date of last update | [optional] 
+
+

data/docs/SignatureUiOutput.md

@@ -0,0 +1,33 @@
+# YousignClient::SignatureUiOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Resource's ID | [optional] 
+**name** | **String** | Resource's name | 
+**description** | **String** |  | [optional] 
+**enable_header_bar** | **BOOLEAN** | Toggle header bar of the app view | [optional] [default to true]
+**enable_header_bar_sign_as** | **BOOLEAN** | Toggle \"Sign as\" band on the top of the app view | [optional] [default to true]
+**enable_sidebar** | **BOOLEAN** | Toggle sidebar of the app view | [optional] [default to true]
+**enable_member_list** | **BOOLEAN** | Toggle list of members in the procedure | [optional] [default to true]
+**enable_document_list** | **BOOLEAN** | Toggle list of documents in the procedure | [optional] [default to true]
+**enable_document_download** | **BOOLEAN** | Toggle downloads buttons for documents | [optional] [default to true]
+**enable_activities** | **BOOLEAN** | Toggle activity feed | [optional] [default to true]
+**authentication_popup** | **BOOLEAN** | True for use a popup for enter the SMS code, false for use a fullscreen view. | [optional] [default to false]
+**default_zoom** | **Float** | Default value for zoom of the PDF viewer. Default value is the adapted to the resolution of your screen. | [optional] 
+**logo** | **String** | Base64 of your logo | [optional] 
+**sign_image_types_available** | **Array<String>** | Allow sign images types available for signature. | [optional] 
+**default_language** | **String** | Default language of the view. Must be in \"languages\" field. | [optional] 
+**languages** | **Array<String>** | Array of allowed languages, use country code | [optional] 
+**labels** | [**Array<SignatureUiLabelOutput>**](SignatureUiLabelOutput.md) |  | [optional] 
+**fonts** | **Array<String>** | List of fonts to load on the view. (Loaded via google fonts) | [optional] 
+**style** | **String** | CSS for customize the view | [optional] 
+**redirect_cancel** | [**SignatureUiOutputRedirectCancel**](SignatureUiOutputRedirectCancel.md) |  | [optional] 
+**redirect_error** | [**SignatureUiOutputRedirectError**](SignatureUiOutputRedirectError.md) |  | [optional] 
+**redirect_success** | [**SignatureUiOutputRedirectSuccess**](SignatureUiOutputRedirectSuccess.md) |  | [optional] 
+**creator** | **String** | Creator's ID | [optional] 
+**workspace** | **String** | Associated Workspace's ID | [optional] 
+**created_at** | **DateTime** | Date of creation | [optional] 
+**updated_at** | **DateTime** | Date of last update | [optional] 
+
+

data/docs/SignatureUiOutputRedirectCancel.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiOutputRedirectCancel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Url of redirect | [optional] 
+**target** | **String** | target of the redirection | [optional] [default to '_top']
+**auto** | **BOOLEAN** | Don't redirect the user directly, send to our detail of the procedure view. But invite the user to click on a button for use this redirection. | [optional] 
+
+

data/docs/SignatureUiOutputRedirectError.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiOutputRedirectError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Url of redirect | 
+**target** | **String** | target of the redirection | [optional] 
+**auto** | **BOOLEAN** | Don't redirect the user directly, send to our detail of the procedure view. But invite the user to click on a button for use this redirection. | [optional] [default to false]
+
+

data/docs/SignatureUiOutputRedirectSuccess.md

@@ -0,0 +1,10 @@
+# YousignClient::SignatureUiOutputRedirectSuccess
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | Url of redirect | [optional] 
+**target** | **String** | Target of the redirection | [optional] 
+**auto** | **BOOLEAN** | Don't redirect the user directly, send to our detail of the procedure view. But invite the user to click on a button for use this redirection. | [optional] [default to false]
+
+

data/docs/UserGroup.md

@@ -0,0 +1,10 @@
+# YousignClient::UserGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the object | [optional] 
+**name** | **String** | Name of the UserGroup | 
+**permissions** | **Array<String>** | Permissions of UserGroup | [optional] 
+
+

data/docs/UserGroupsApi.md

@@ -0,0 +1,103 @@
+# YousignClient::UserGroupsApi
+
+All URIs are relative to *https://api.yousign.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**user_groups_get**](UserGroupsApi.md#user_groups_get) | **GET** /user_groups | Get User Group list
+[**user_groups_id_get**](UserGroupsApi.md#user_groups_id_get) | **GET** /user_groups/{id} | Find a User Group by ID
+
+
+# **user_groups_get**
+> Array<UserGroup> user_groups_get(authorization)
+
+Get User Group list
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UserGroupsApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Get User Group list
+  result = api_instance.user_groups_get(authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UserGroupsApi->user_groups_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**Array<UserGroup>**](UserGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **user_groups_id_get**
+> UserGroup user_groups_id_get(id, authorization)
+
+Find a User Group by ID
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UserGroupsApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Find a User Group by ID
+  result = api_instance.user_groups_id_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UserGroupsApi->user_groups_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**UserGroup**](UserGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UserInput.md

@@ -0,0 +1,17 @@
+# YousignClient::UserInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**firstname** | **String** | User's firstname | 
+**lastname** | **String** | User's lastname | 
+**email** | **String** | User's email address (This field is allowed only during creation) | 
+**title** | **String** | User's job title | [optional] 
+**phone** | **String** | User's phone number (mobiles and landline telephones are supported). Phone number must be formatted to E164 (https://en.wikipedia.org/wiki/E.164) which includes the symbol '+' and the country code. For example : +33612131315. All countries are supported. | [optional] 
+**permission** | **Array<String>** |  | [optional] 
+**group** | **String** | User's UserGroup | [optional] 
+**config** | **Object** |  | [optional] 
+**default_sign_image** | **String** | ID of file image | [optional] 
+**notifications** | [**UserInputNotifications**](UserInputNotifications.md) |  | [optional] 
+
+

data/docs/UserInputNotifications.md

@@ -0,0 +1,8 @@
+# YousignClient::UserInputNotifications
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**procedure** | **BOOLEAN** |  | [optional] 
+
+

data/docs/UserOutput.md

@@ -0,0 +1,29 @@
+# YousignClient::UserOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Object's ID | [optional] 
+**firstname** | **String** | User's firstname | 
+**lastname** | **String** | User's lastname | 
+**email** | **String** | User's email address | 
+**title** | **String** | User's title | [optional] 
+**phone** | **String** | User's phone number (mobiles and landline telephones are supported). Phone number must be formatted to E164 (https://en.wikipedia.org/wiki/E.164) which includes the symbol '+' and the country code. For example : +33612131315. All countries are supported. | [optional] 
+**status** | **String** | User's status | [optional] 
+**organization** | **String** | ID of the organization the user belongs to | [optional] 
+**workspaces** | [**Array<UserWorkspaceOutput>**](UserWorkspaceOutput.md) | List of workspaces to which the user is connected and has access | [optional] 
+**permission** | **String** |  | [optional] 
+**group** | [**UserGroup**](UserGroup.md) |  | [optional] 
+**created_at** | **DateTime** | Created date of the object | [optional] 
+**updated_at** | **DateTime** | Updated date of the object | [optional] 
+**deleted** | **BOOLEAN** | Defines if the User is deleted or not | [optional] 
+**deleted_at** | **DateTime** | Defines the date where the user has been deleted | [optional] 
+**config** | **Object** |  | [optional] 
+**inwebo_user_request** | **String** | Internal usage, should not be used | [optional] 
+**saml_name_id** | **String** | ID of SAML | [optional] 
+**default_sign_image** | **String** | ID of the default sign image. | [optional] 
+**notifications** | [**UserOutputNotifications**](UserOutputNotifications.md) |  | [optional] 
+**fast_sign** | **BOOLEAN** | Defines if the fast signature is available for the user on the Yousign application | [optional] 
+**full_name** | **String** | User's full name | [optional] 
+
+

data/docs/UserOutputNotifications.md

@@ -0,0 +1,8 @@
+# YousignClient::UserOutputNotifications
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**procedure** | **BOOLEAN** |  | [optional] 
+
+

data/docs/UserWorkspaceOutput.md

@@ -0,0 +1,9 @@
+# YousignClient::UserWorkspaceOutput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Object's ID | [optional] 
+**name** | **String** | Workspace name | [optional] 
+
+

data/docs/UsersApi.md

@@ -0,0 +1,258 @@
+# YousignClient::UsersApi
+
+All URIs are relative to *https://api.yousign.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**users_get**](UsersApi.md#users_get) | **GET** /users | List all Users
+[**users_id_delete**](UsersApi.md#users_id_delete) | **DELETE** /users/{id} | Delete a User
+[**users_id_get**](UsersApi.md#users_id_get) | **GET** /users/{id} | Find a User by ID
+[**users_id_put**](UsersApi.md#users_id_put) | **PUT** /users/{id} | Update a User
+[**users_post**](UsersApi.md#users_post) | **POST** /users | Create a new User on Yousign application
+
+
+# **users_get**
+> Array<UserOutput> users_get(authorization)
+
+List all Users
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UsersApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #List all Users
+  result = api_instance.users_get(authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UsersApi->users_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**Array<UserOutput>**](UserOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **users_id_delete**
+> users_id_delete(id, authorization)
+
+Delete a User
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UsersApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Delete a User
+  api_instance.users_id_delete(id, authorization)
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UsersApi->users_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **users_id_get**
+> UserOutput users_id_get(id, authorization)
+
+Find a User by ID
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UsersApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+
+begin
+  #Find a User by ID
+  result = api_instance.users_id_get(id, authorization)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UsersApi->users_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+
+### Return type
+
+[**UserOutput**](UserOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **users_id_put**
+> UserOutput users_id_put(id, authorization, content_type, body)
+
+Update a User
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UsersApi.new
+
+id = 'id_example' # String | 
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::UserInput.new # UserInput | 
+
+
+begin
+  #Update a User
+  result = api_instance.users_id_put(id, authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UsersApi->users_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**UserInput**](UserInput.md)|  | 
+
+### Return type
+
+[**UserOutput**](UserOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **users_post**
+> UserOutput users_post(authorization, content_type, body)
+
+Create a new User on Yousign application
+
+### Example
+```ruby
+# load the gem
+require 'yousign_client'
+
+api_instance = YousignClient::UsersApi.new
+
+authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
+
+content_type = 'application/json' # String | The MIME type of the body of the request
+
+body = YousignClient::UserInput.new # UserInput | 
+
+
+begin
+  #Create a new User on Yousign application
+  result = api_instance.users_post(authorization, content_type, body)
+  p result
+rescue YousignClient::ApiError => e
+  puts "Exception when calling UsersApi->users_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authentication credentials for HTTP authentication | 
+ **content_type** | **String**| The MIME type of the body of the request | 
+ **body** | [**UserInput**](UserInput.md)|  | 
+
+### Return type
+
+[**UserOutput**](UserOutput.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+