Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

Latest commit

 

History

History
1465 lines (1042 loc) · 57 KB

UserGroupsApi.md

File metadata and controls

1465 lines (1042 loc) · 57 KB

JCAPIv2::UserGroupsApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
graph_user_group_associations_list GET /usergroups/{group_id}/associations List the associations of a User Group.
graph_user_group_associations_post POST /usergroups/{group_id}/associations Manage the associations of a User Group
graph_user_group_member_of GET /usergroups/{group_id}/memberof List the User Group's parents
graph_user_group_members_list GET /usergroups/{group_id}/members List the members of a User Group
graph_user_group_members_post POST /usergroups/{group_id}/members Manage the members of a User Group
graph_user_group_membership GET /usergroups/{group_id}/membership List the User Group's membership
graph_user_group_traverse_active_directory GET /usergroups/{group_id}/activedirectories List the Active Directories bound to a User Group
graph_user_group_traverse_application GET /usergroups/{group_id}/applications List the Applications bound to a User Group
graph_user_group_traverse_directory GET /usergroups/{group_id}/directories List the Directories bound to a User Group
graph_user_group_traverse_g_suite GET /usergroups/{group_id}/gsuites List the G Suite instances bound to a User Group
graph_user_group_traverse_ldap_server GET /usergroups/{group_id}/ldapservers List the LDAP Servers bound to a User Group
graph_user_group_traverse_office365 GET /usergroups/{group_id}/office365s List the Office 365 instances bound to a User Group
graph_user_group_traverse_radius_server GET /usergroups/{group_id}/radiusservers List the RADIUS Servers bound to a User Group
graph_user_group_traverse_system GET /usergroups/{group_id}/systems List the Systems bound to a User Group
graph_user_group_traverse_system_group GET /usergroups/{group_id}/systemgroups List the System Groups bound to User Groups
groups_user_delete DELETE /usergroups/{id} Delete a User Group
groups_user_get GET /usergroups/{id} View an individual User Group details
groups_user_list GET /usergroups List all User Groups
groups_user_patch PATCH /usergroups/{id} Partial update a User Group
groups_user_post POST /usergroups Create a new User Group
groups_user_put PUT /usergroups/{id} Update a User Group

graph_user_group_associations_list

Array<GraphConnection> graph_user_group_associations_list(group_id, content_type, accepttargets, opts)

List the associations of a User Group.

This endpoint returns the direct associations of this User Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations?targets=system \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

targets = ["targets_example"] # Array<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 User Group.
  result = api_instance.graph_user_group_associations_list(group_id, content_type, accepttargets, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_associations_list: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
targets Array<String>
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 ]

Return type

Array<GraphConnection>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_associations_post

graph_user_group_associations_post(group_id, content_type, accept, opts)

Manage the associations of a User Group

This endpoint manages the direct associations of this User Group. A direct association can be a non-homogeneous relationship between 2 different objects, for example User Groups and Users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"system\", \"id\": \"{SystemID}\" }'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::UserGroupGraphManagementReq.new, # UserGroupGraphManagementReq | 
  x_org_id: "" # String | 
}

begin
  #Manage the associations of a User Group
  api_instance.graph_user_group_associations_post(group_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_associations_post: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
body UserGroupGraphManagementReq [optional]
x_org_id String [optional] [default to ]

Return type

nil (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_member_of

Array<GraphObjectWithPaths> graph_user_group_member_of(group_id, content_type, accept, opts)

List the User Group's parents

This endpoint returns all User Groups a User Group is a member of. #### Sample Request https://console.jumpcloud.com/api/v2/usergroups/{group_id}/memberof Not public yet, as the code is not finished,

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  x_org_id: "" # String | 
}

begin
  #List the User Group's parents
  result = api_instance.graph_user_group_member_of(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_member_of: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
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]
sort Array<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
x_org_id String [optional] [default to ]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_members_list

Array<GraphConnection> graph_user_group_members_list(group_id, content_type, accept, opts)

List the members of a User Group

This endpoint returns the user members of a User Group. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 members of a User Group
  result = api_instance.graph_user_group_members_list(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_members_list: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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 ]

Return type

Array<GraphConnection>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_members_post

graph_user_group_members_post(group_id, content_type, accept, opts)

Manage the members of a User Group

This endpoint allows you to manage the user members of a User Group. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/members \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"user\", \"id\": \"{User_ID}\" }'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::UserGroupMembersReq.new, # UserGroupMembersReq | 
  x_org_id: "" # String | 
}

begin
  #Manage the members of a User Group
  api_instance.graph_user_group_members_post(group_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_members_post: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
body UserGroupMembersReq [optional]
x_org_id String [optional] [default to ]

Return type

nil (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_membership

Array<GraphObjectWithPaths> graph_user_group_membership(group_id, content_type, accept, opts)

List the User Group's membership

This endpoint returns all users members that are a member of this User Group. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/membership \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  x_org_id: "" # String | 
}

begin
  #List the User Group's membership
  result = api_instance.graph_user_group_membership(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_membership: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
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]
sort Array<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
x_org_id String [optional] [default to ]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_active_directory

Array<GraphObjectWithPaths> graph_user_group_traverse_active_directory(group_id, content_type, accept, opts)

List the Active Directories bound to a User Group

This endpoint will return all Active Directory Instances bound to a User Group, either directly or indirectly, essentially traversing the JumpCloud Graph for your Organization. The attributes object is a key/value hash of compiled graph attributes for all paths followed. The paths array enumerates each path from this User Group to the corresponding Active Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Active Directory from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/activedirectories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 Active Directories bound to a User Group
  result = api_instance.graph_user_group_traverse_active_directory(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_active_directory: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_application

Array<GraphObjectWithPaths> graph_user_group_traverse_application(group_id, content_type, accept, opts)

List the Applications bound to a User Group

This endpoint will return all Applications bound to a User Group, 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 User Group to the corresponding Application; this array represents all grouping and/or associations that would have to be removed to deprovision the Application from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/applications \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 Applications bound to a User Group
  result = api_instance.graph_user_group_traverse_application(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_application: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_directory

Array<GraphObjectWithPaths> graph_user_group_traverse_directory(group_id, content_type, accept, opts)

List the Directories bound to a User Group

This endpoint will return all Directories bound to a User Group, 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 User Group to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directories from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/directories \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 Directories bound to a User Group
  result = api_instance.graph_user_group_traverse_directory(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_directory: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_g_suite

Array<GraphObjectWithPaths> graph_user_group_traverse_g_suite(group_id, content_type, accept, opts)

List the G Suite instances bound to a User Group

This endpoint will return all G Suite Instances bound to a User Group, 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 User Group to the corresponding G Suite instance; this array represents all grouping and/or associations that would have to be removed to deprovision the G Suite instance from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID/gsuites \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 G Suite instances bound to a User Group
  result = api_instance.graph_user_group_traverse_g_suite(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_g_suite: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_ldap_server

Array<GraphObjectWithPaths> graph_user_group_traverse_ldap_server(group_id, content_type, accept, opts)

List the LDAP Servers bound to a User Group

This endpoint will return all LDAP Servers bound to a User Group, 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 User Group to the corresponding LDAP Server; this array represents all grouping and/or associations that would have to be removed to deprovision the LDAP Server from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/ldapservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 LDAP Servers bound to a User Group
  result = api_instance.graph_user_group_traverse_ldap_server(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_ldap_server: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_office365

Array<GraphObjectWithPaths> graph_user_group_traverse_office365(group_id, content_type, accept, opts)

List the Office 365 instances bound to a User Group

This endpoint will return all Office 365 instances bound to a User Group, 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 User Group to the corresponding Office 365 instance; this array represents all grouping and/or associations that would have to be removed to deprovision the Office 365 instance from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/office365s \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 Office 365 instances bound to a User Group
  result = api_instance.graph_user_group_traverse_office365(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_office365: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_radius_server

Array<GraphObjectWithPaths> graph_user_group_traverse_radius_server(group_id, content_type, accept, opts)

List the RADIUS Servers bound to a User Group

This endpoint will return all RADIUS servers bound to a User Group, 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 User Group to the corresponding RADIUS Server; this array represents all grouping and/or associations that would have to be removed to deprovision the RADIUS Server from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/radiusservers \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 RADIUS Servers bound to a User Group
  result = api_instance.graph_user_group_traverse_radius_server(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_radius_server: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_system

Array<GraphObjectWithPaths> graph_user_group_traverse_system(group_id, content_type, accept, opts)

List the Systems bound to a User Group

This endpoint will return all Systems bound to a User Group, 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 User Group to the corresponding System; this array represents all grouping and/or associations that would have to be removed to deprovision the System from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systems \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 Systems bound to a User Group
  result = api_instance.graph_user_group_traverse_system(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_system: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

graph_user_group_traverse_system_group

Array<GraphObjectWithPaths> graph_user_group_traverse_system_group(group_id, content_type, accept, opts)

List the System Groups bound to User Groups

This endpoint will return all System Groups bound to a User Group, 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 User Group to the corresponding System Group; this array represents all grouping and/or associations that would have to be removed to deprovision the System Group from this User Group. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID}/systemgroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

group_id = "group_id_example" # String | ObjectID of the User Group.

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 System Groups bound to User Groups
  result = api_instance.graph_user_group_traverse_system_group(group_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->graph_user_group_traverse_system_group: #{e}"
end

Parameters

Name Type Description Notes
group_id String ObjectID of the User Group.
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]

Return type

Array<GraphObjectWithPaths>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groups_user_delete

groups_user_delete(id, content_type, accept, opts)

Delete a User Group

This endpoint allows you to delete a User Group. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

id = "id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #Delete a User Group
  api_instance.groups_user_delete(id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->groups_user_delete: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
x_org_id String [optional] [default to ]

Return type

nil (empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groups_user_get

UserGroup groups_user_get(id, content_type, accept, opts)

View an individual User Group details

This endpoint returns the details of a User Group. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups/{GroupID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

id = "id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  x_org_id: "" # String | 
}

begin
  #View an individual User Group details
  result = api_instance.groups_user_get(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->groups_user_get: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
x_org_id String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groups_user_list

Array<UserGroup> groups_user_list(content_type, accept, opts)

List all User Groups

This endpoint returns all User Groups. Available filter fields: - name - disabled - type #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

# 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::UserGroupsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  fields: ["fields_example"], # Array<String> | The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. 
  filter: ["filter_example"], # Array<String> | Supported operators are: eq, ne, gt, ge, lt, le, between, search, in
  limit: 10, # Integer | The number of records to return at once. Limited to 100.
  skip: 0, # Integer | The offset into the records to return.
  sort: ["sort_example"], # Array<String> | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. 
  x_org_id: "" # String | 
}

begin
  #List all User Groups
  result = api_instance.groups_user_list(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->groups_user_list: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
fields Array<String> The comma separated fields included in the returned records. If omitted, the default list of fields will be returned. [optional]
filter Array<String> Supported operators are: eq, ne, gt, ge, lt, le, between, search, in [optional]
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]
sort Array<String> The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. [optional]
x_org_id String [optional] [default to ]

Return type

Array<UserGroup>

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groups_user_patch

UserGroup groups_user_patch(id, content_type, accept, opts)

Partial update a User Group

We have hidden PATCH on the systemgroups and usergroups for now; we don't have that implemented correctly yet, people should use PUT until we do a true PATCH operation. #### Sample Request https://console.jumpcloud.com/api/v2/usergroups/{id}

Example

# 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::UserGroupsApi.new

id = "id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::UserGroupPost.new, # UserGroupPost | 
  x_org_id: "" # String | 
}

begin
  #Partial update a User Group
  result = api_instance.groups_user_patch(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->groups_user_patch: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
body UserGroupPost [optional]
x_org_id String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groups_user_post

UserGroup groups_user_post(content_type, accept, opts)

Create a new User Group

This endpoint allows you to create a new User Group. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/usergroups \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"{Group_Name}\" }'

Example

# 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::UserGroupsApi.new

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::UserGroupPost.new, # UserGroupPost | 
  x_org_id: "" # String | 
}

begin
  #Create a new User Group
  result = api_instance.groups_user_post(content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->groups_user_post: #{e}"
end

Parameters

Name Type Description Notes
content_type String [default to application/json]
accept String [default to application/json]
body UserGroupPost [optional]
x_org_id String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

groups_user_put

UserGroup groups_user_put(id, content_type, accept, opts)

Update a User Group

This endpoint allows you to do a full update of the User Group. #### Sample Request curl -X PUT https://console.jumpcloud.com/api/v2/usergroups/{Group_ID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY' \\ -d '{ \"name\": \"group_update\" }'

Example

# 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::UserGroupsApi.new

id = "id_example" # String | ObjectID of the User Group.

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::UserGroupPut.new, # UserGroupPut | 
  x_org_id: "" # String | 
}

begin
  #Update a User Group
  result = api_instance.groups_user_put(id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UserGroupsApi->groups_user_put: #{e}"
end

Parameters

Name Type Description Notes
id String ObjectID of the User Group.
content_type String [default to application/json]
accept String [default to application/json]
body UserGroupPut [optional]
x_org_id String [optional] [default to ]

Return type

UserGroup

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json