Users

# You can also use wget
curl -X GET /v1/users \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/users";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X POST /v1/users \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

const inputBody = '{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/users";
      
      string json = @"{
  ""user"": {
    ""id"": ""string"",
    ""userName"": ""string"",
    ""email"": ""string"",
    ""phoneNumber"": ""string"",
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""department"": ""string"",
    ""birthDate"": ""2019-08-24T14:15:22Z"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""lastDismissMessages"": ""2019-08-24T14:15:22Z"",
    ""lastLogIn"": ""2019-08-24T14:15:22Z"",
    ""rank"": 0,
    ""image"": ""string"",
    ""address"": ""string"",
    ""postalCode"": ""string"",
    ""region"": ""string"",
    ""city"": ""string"",
    ""country"": ""string"",
    ""countryCode"": ""string"",
    ""mobile"": ""string"",
    ""notes"": ""string"",
    ""customerId"": 0,
    ""roles"": [
      ""string""
    ],
    ""apiKeys"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""key"": ""string"",
        ""clientSecret"": ""string"",
        ""createdDate"": ""2019-08-24T14:15:22Z"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""ownerId"": ""string"",
        ""revoked"": true,
        ""permissions"": 0,
        ""description"": ""string""
      }
    ],
    ""settings"": [
      {
        ""id"": 0,
        ""category"": ""string"",
        ""group"": ""string"",
        ""name"": ""string"",
        ""value"": ""string"",
        ""type"": ""string"",
        ""description"": ""string"",
        ""readOnly"": true,
        ""userId"": ""string""
      }
    ]
  },
  ""password"": ""string""
}";
      Management.InsertUserRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertUserRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertUserRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X PUT /v1/users \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

const inputBody = '{
  "user": {
    "id": "string",
    "userName": "string",
    "email": "string",
    "phoneNumber": "string",
    "title": "string",
    "firstName": "string",
    "lastName": "string",
    "department": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "lastDismissMessages": "2019-08-24T14:15:22Z",
    "lastLogIn": "2019-08-24T14:15:22Z",
    "rank": 0,
    "image": "string",
    "address": "string",
    "postalCode": "string",
    "region": "string",
    "city": "string",
    "country": "string",
    "countryCode": "string",
    "mobile": "string",
    "notes": "string",
    "customerId": 0,
    "roles": [
      "string"
    ],
    "apiKeys": [
      {
        "id": 0,
        "name": "string",
        "key": "string",
        "clientSecret": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "expireDate": "2019-08-24T14:15:22Z",
        "ownerId": "string",
        "revoked": true,
        "permissions": 0,
        "description": "string"
      }
    ],
    "settings": [
      {
        "id": 0,
        "category": "string",
        "group": "string",
        "name": "string",
        "value": "string",
        "type": "string",
        "description": "string",
        "readOnly": true,
        "userId": "string"
      }
    ]
  },
  "currentPassword": "string",
  "newPassword": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/users";
 
      
      string json = @"{
  ""user"": {
    ""id"": ""string"",
    ""userName"": ""string"",
    ""email"": ""string"",
    ""phoneNumber"": ""string"",
    ""title"": ""string"",
    ""firstName"": ""string"",
    ""lastName"": ""string"",
    ""department"": ""string"",
    ""birthDate"": ""2019-08-24T14:15:22Z"",
    ""createdAt"": ""2019-08-24T14:15:22Z"",
    ""updatedAt"": ""2019-08-24T14:15:22Z"",
    ""lastDismissMessages"": ""2019-08-24T14:15:22Z"",
    ""lastLogIn"": ""2019-08-24T14:15:22Z"",
    ""rank"": 0,
    ""image"": ""string"",
    ""address"": ""string"",
    ""postalCode"": ""string"",
    ""region"": ""string"",
    ""city"": ""string"",
    ""country"": ""string"",
    ""countryCode"": ""string"",
    ""mobile"": ""string"",
    ""notes"": ""string"",
    ""customerId"": 0,
    ""roles"": [
      ""string""
    ],
    ""apiKeys"": [
      {
        ""id"": 0,
        ""name"": ""string"",
        ""key"": ""string"",
        ""clientSecret"": ""string"",
        ""createdDate"": ""2019-08-24T14:15:22Z"",
        ""expireDate"": ""2019-08-24T14:15:22Z"",
        ""ownerId"": ""string"",
        ""revoked"": true,
        ""permissions"": 0,
        ""description"": ""string""
      }
    ],
    ""settings"": [
      {
        ""id"": 0,
        ""category"": ""string"",
        ""group"": ""string"",
        ""name"": ""string"",
        ""value"": ""string"",
        ""type"": ""string"",
        ""description"": ""string"",
        ""readOnly"": true,
        ""userId"": ""string""
      }
    ]
  },
  ""currentPassword"": ""string"",
  ""newPassword"": ""string""
}";
      Management.UpdateUserRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateUserRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateUserRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X DELETE /v1/users/{userId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X GET /v1/users/{userId}/settings \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings',
{
  method: 'GET',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/v1/users/{userId}/settings";
      var result = await GetAsync(url);
    }
 
    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);
 
        //Validate result
        response.EnsureSuccessStatusCode();
 
    }
    
    
    
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X POST /v1/users/{userId}/settings \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

const inputBody = '{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/v1/users/{userId}/settings";
      
      string json = @"{
  ""setting"": {
    ""id"": 0,
    ""category"": ""string"",
    ""group"": ""string"",
    ""name"": ""string"",
    ""value"": ""string"",
    ""type"": ""string"",
    ""description"": ""string"",
    ""readOnly"": true,
    ""userId"": ""string""
  }
}";
      Management.InsertUserSettingRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.InsertUserSettingRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }
    
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.InsertUserSettingRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X PUT /v1/users/{userId}/settings \
  -H 'Content-Type: application/json-patch+json' \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

const inputBody = '{
  "setting": {
    "id": 0,
    "category": "string",
    "group": "string",
    "name": "string",
    "value": "string",
    "type": "string",
    "description": "string",
    "readOnly": true,
    "userId": "string"
  }
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}/settings";
 
      
      string json = @"{
  ""setting"": {
    ""id"": 0,
    ""category"": ""string"",
    ""group"": ""string"",
    ""name"": ""string"",
    ""value"": ""string"",
    ""type"": ""string"",
    ""description"": ""string"",
    ""readOnly"": true,
    ""userId"": ""string""
  }
}";
      Management.UpdateUserSettingRequest content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);
      
          
    }
 
    /// Performs a PUT Request
    public async Task PutAsync(int id, Management.UpdateUserSettingRequest content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);
 
        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);
 
        //Return response
        return await DeserializeObject(response);
    }
    
    
    /// Serialize an object to Json
    private StringContent SerializeObject(Management.UpdateUserSettingRequest content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);
 
        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}
 

# You can also use wget
curl -X DELETE /v1/users/{userId}/settings/{settingId} \
  -H 'Accept: text/plain' \
  -H 'x-api-key: API_KEY'
 

 
const headers = {
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/settings/{settingId}',
{
  method: 'DELETE',
 
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
 

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
 
/// <summary>
/// Example of Http Client
/// </summary>
public class HttpExample
{
    private HttpClient Client { get; set; }
 
    /// <summary>
    /// Setup http client
    /// </summary>
    public HttpExample()
    {
      Client = new HttpClient();
    }
    
    
    
    
    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/v1/users/{userId}/settings/{settingId}";
 
      await DeleteAsync(id, url);
    }
 
    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");
 
        //Return response
        await DeserializeObject(response);
    }
    
    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body 
        string responseBody = await response.Content.ReadAsStringAsync();
 
        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}