Roles

GET`/v1/roles`GET /v1/roles

Code samples

cURL


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

JavaScript


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

C#


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/roles";
      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);
    }
}

GET /v1/roles

Retrieves roles based on the provided request.

Parameters

Name	In	Type	Required	Description
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","roles":[{"id":"string","name":"string","description":"string"}],"totalRolesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "totalRolesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetRolesResponse

Authentication: API key (x-api-key).

GET`/v1/users/{userId}/roles`GET /v1/users/{userId}/roles

Code samples

cURL


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

JavaScript


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

C#


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}/roles";
      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);
    }
}

GET /v1/users/\{userId\}/roles

Retrieves the roles of a specific user based on the provided request.

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
select	query	string	false	none
filter	query	string	false	none
sort	query	string	false	none
take	query	integer(int32)	false	none
skip	query	integer(int32)	false	none

Example responses

200 Response


{"success":true,"code":0,"message":"string","roles":[{"id":"string","name":"string","description":"string"}],"totalRolesCount":0}


{
  "success": true,
  "code": 0,
  "message": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "totalRolesCount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.GetUserRolesResponse

Authentication: API key (x-api-key).

POST`/v1/users/{userId}/roles`POST /v1/users/{userId}/roles

Code samples

cURL


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

JavaScript


const inputBody = '{
  "roles": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/roles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


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}/roles";
      
      string json = @"{
  ""roles"": ""string""
}";
      Management.AddUserToRoleRequest content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);
      
      
    }
 
    /// Performs a POST Request
    public async Task PostAsync(Management.AddUserToRoleRequest 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.AddUserToRoleRequest 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);
    }
}

POST /v1/users/\{userId\}/roles

Adds a user to the specified roles.

Body parameter


{
  "roles": "string"
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
body	body	Management.AddUserToRoleRequest	false	The request containing the user ID and the roles to add.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.AddUserToRoleResponse

Authentication: API key (x-api-key).

DELETE`/v1/users/{userId}/roles`DELETE /v1/users/{userId}/roles

Code samples

cURL


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

JavaScript


const inputBody = '{
  "roles": "string"
}';
const headers = {
  'Content-Type':'application/json-patch+json',
  'Accept':'text/plain',
  'x-api-key':'API_KEY'
};
 
fetch('/v1/users/{userId}/roles',
{
  method: 'DELETE',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

C#


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}/roles";
 
      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);
    }
}

DELETE /v1/users/\{userId\}/roles

Removes a user from the specified roles.

Body parameter


{
  "roles": "string"
}

Parameters

Name	In	Type	Required	Description
userId	path	string	true	The user ID.
body	body	Management.RemoveUserFromRoleRequest	false	The request containing the user ID and the roles to remove.

Example responses

200 Response


{"success":true,"code":0,"message":"string"}


{
  "success": true,
  "code": 0,
  "message": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Management.RemoveUserFromRoleResponse

Authentication: API key (x-api-key).

Roles

GET/v1/rolesGET /v1/roles

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET/v1/users/{userId}/rolesGET /v1/users/{userId}/roles

Code samples

cURL

JavaScript

C#

Parameters

Responses

POST/v1/users/{userId}/rolesPOST /v1/users/{userId}/roles

Code samples

cURL

JavaScript

C#

Parameters

Responses

DELETE/v1/users/{userId}/rolesDELETE /v1/users/{userId}/roles

Code samples

cURL

JavaScript

C#

Parameters

Responses

GET`/v1/roles`GET /v1/roles

GET`/v1/users/{userId}/roles`GET /v1/users/{userId}/roles

POST`/v1/users/{userId}/roles`POST /v1/users/{userId}/roles

DELETE`/v1/users/{userId}/roles`DELETE /v1/users/{userId}/roles