All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| graph_radius_server_associations_list | GET /radiusservers/{radiusserver_id}/associations | List the associations of a RADIUS Server |
| graph_radius_server_associations_post | POST /radiusservers/{radiusserver_id}/associations | Manage the associations of a RADIUS Server |
| graph_radius_server_traverse_user | GET /radiusservers/{radiusserver_id}/users | List the Users bound to a RADIUS Server |
| graph_radius_server_traverse_user_group | GET /radiusservers/{radiusserver_id}/usergroups | List the User Groups bound to a RADIUS Server |
Array<GraphConnection> graph_radius_server_associations_list(radiusserver_id, targets, content_type, accept, opts)
List the associations of a RADIUS Server
This endpoint returns the direct associations of a Radius Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations?targets=user_group \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'
# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
# Configure API key authorization: x-api-key
config.api_key['x-api-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = JCAPIv2::RADIUSServersApi.new
radiusserver_id = "radiusserver_id_example" # String | ObjectID of the Radius Server.
targets = ["targets_example"] # Array<String> |
content_type = "application/json" # String |
accept = "application/json" # String |
opts = {
limit: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
x_org_id: "" # String |
}
begin
#List the associations of a RADIUS Server
result = api_instance.graph_radius_server_associations_list(radiusserver_id, targets, content_type, accept, opts)
p result
rescue JCAPIv2::ApiError => e
puts "Exception when calling RADIUSServersApi->graph_radius_server_associations_list: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| radiusserver_id | String | ObjectID of the Radius Server. | |
| targets | Array<String> | ||
| content_type | String | [default to application/json] | |
| accept | String | [default to application/json] | |
| limit | Integer | The number of records to return at once. Limited to 100. | [optional] [default to 10] |
| skip | Integer | The offset into the records to return. | [optional] [default to 0] |
| x_org_id | String | [optional] [default to ] |
- Content-Type: application/json
- Accept: application/json
graph_radius_server_associations_post(radiusserver_id, content_type, accept, opts)
Manage the associations of a RADIUS Server
This endpoint allows you to manage the direct associations of a Radius Server. A direct association can be a non-homogeneous relationship between 2 different objects, for example Radius Servers and Users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"type\":\"user\", \"id\":\"{USER_ID}\", \"op\":\"add\" }'
# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
# Configure API key authorization: x-api-key
config.api_key['x-api-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = JCAPIv2::RADIUSServersApi.new
radiusserver_id = "radiusserver_id_example" # String | ObjectID of the Radius Server.
content_type = "application/json" # String |
accept = "application/json" # String |
opts = {
body: JCAPIv2::GraphManagementReq.new, # GraphManagementReq |
x_org_id: "" # String |
}
begin
#Manage the associations of a RADIUS Server
api_instance.graph_radius_server_associations_post(radiusserver_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
puts "Exception when calling RADIUSServersApi->graph_radius_server_associations_post: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| radiusserver_id | String | ObjectID of the Radius Server. | |
| content_type | String | [default to application/json] | |
| accept | String | [default to application/json] | |
| body | GraphManagementReq | [optional] | |
| x_org_id | String | [optional] [default to ] |
nil (empty response body)
- Content-Type: application/json
- Accept: application/json
Array<GraphObjectWithPaths> graph_radius_server_traverse_user(radiusserver_id, content_type, accept, opts)
List the Users bound to a RADIUS Server
This endpoint will return all Users bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the type, id, attributes and paths. The attributes object is a key/value hash of compiled graph attributes for all paths followed. The paths array enumerates each path from this RADIUS server instance to the corresponding User; this array represents all grouping and/or associations that would have to be removed to deprovision the User from this RADIUS server instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/ldapservers/{LDAP_ID}/users \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'
# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
# Configure API key authorization: x-api-key
config.api_key['x-api-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = JCAPIv2::RADIUSServersApi.new
radiusserver_id = "radiusserver_id_example" # String | ObjectID of the Radius Server.
content_type = "application/json" # String |
accept = "application/json" # String |
opts = {
limit: 10, # Integer | The number of records to return at once. Limited to 100.
x_org_id: "" # String |
skip: 0, # Integer | The offset into the records to return.
filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
}
begin
#List the Users bound to a RADIUS Server
result = api_instance.graph_radius_server_traverse_user(radiusserver_id, content_type, accept, opts)
p result
rescue JCAPIv2::ApiError => e
puts "Exception when calling RADIUSServersApi->graph_radius_server_traverse_user: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| radiusserver_id | String | ObjectID of the Radius Server. | |
| content_type | String | [default to application/json] | |
| accept | String | [default to application/json] | |
| limit | Integer | The number of records to return at once. Limited to 100. | [optional] [default to 10] |
| x_org_id | String | [optional] [default to ] | |
| skip | Integer | The offset into the records to return. | [optional] [default to 0] |
| filter | Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [optional] |
- Content-Type: application/json
- Accept: application/json
Array<GraphObjectWithPaths> graph_radius_server_traverse_user_group(radiusserver_id, content_type, accept, opts)
List the User Groups bound to a RADIUS Server
This endpoint will return all Users Groups bound to a RADIUS Server, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. Each element will contain the group's type, id, attributes and paths. The attributes object is a key/value hash of compiled graph attributes for all paths followed. The paths array enumerates each path from this RADIUS server instance to the corresponding User Group; this array represents all grouping and/or associations that would have to be removed to deprovision the User Group from this RADIUS server instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/radiusservers/{RADIUS_ID}/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'
# load the gem
require 'jcapiv2'
# setup authorization
JCAPIv2.configure do |config|
# Configure API key authorization: x-api-key
config.api_key['x-api-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = JCAPIv2::RADIUSServersApi.new
radiusserver_id = "radiusserver_id_example" # String | ObjectID of the Radius Server.
content_type = "application/json" # String |
accept = "application/json" # String |
opts = {
limit: 10, # Integer | The number of records to return at once. Limited to 100.
x_org_id: "" # String |
skip: 0, # Integer | The offset into the records to return.
filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
}
begin
#List the User Groups bound to a RADIUS Server
result = api_instance.graph_radius_server_traverse_user_group(radiusserver_id, content_type, accept, opts)
p result
rescue JCAPIv2::ApiError => e
puts "Exception when calling RADIUSServersApi->graph_radius_server_traverse_user_group: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| radiusserver_id | String | ObjectID of the Radius Server. | |
| content_type | String | [default to application/json] | |
| accept | String | [default to application/json] | |
| limit | Integer | The number of records to return at once. Limited to 100. | [optional] [default to 10] |
| x_org_id | String | [optional] [default to ] | |
| skip | Integer | The offset into the records to return. | [optional] [default to 0] |
| filter | Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in | [optional] |
- Content-Type: application/json
- Accept: application/json