JCAPIv2::UsersApi

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

Method	HTTP request	Description
graph_user_associations_list	GET /users/{user_id}/associations	List the associations of a User
graph_user_associations_post	POST /users/{user_id}/associations	Manage the associations of a User
graph_user_member_of	GET /users/{user_id}/memberof	List the parent Groups of a User
graph_user_traverse_application	GET /users/{user_id}/applications	List the Applications bound to a User
graph_user_traverse_directory	GET /users/{user_id}/directories	List the Directories bound to a User
graph_user_traverse_g_suite	GET /users/{user_id}/gsuites	List the G Suite instances bound to a User
graph_user_traverse_ldap_server	GET /users/{user_id}/ldapservers	List the LDAP servers bound to a User
graph_user_traverse_office365	GET /users/{user_id}/office365s	List the Office 365 instances bound to a User
graph_user_traverse_radius_server	GET /users/{user_id}/radiusservers	List the RADIUS Servers bound to a User
graph_user_traverse_system	GET /users/{user_id}/systems	List the Systems bound to a User
graph_user_traverse_system_group	GET /users/{user_id}/systemgroups	List the System Groups bound to a User
users_send_emails	POST /users/{user_id}/emails	Send User Emails

graph_user_associations_list

Array<GraphConnection> graph_user_associations_list(user_id, content_type, accepttargets, opts)

List the associations of a User

This endpoint returns the direct associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/associations?targets=system_group \\ -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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_associations_list(user_id, content_type, accepttargets, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_associations_list: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_associations_post

graph_user_associations_post(user_id, content_type, accept, opts)

Manage the associations of a User

This endpoint allows you to manage the direct associations of a User. A direct association can be a non-homogeneous relationship between 2 different objects, for example Users and Systems. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/v2/users/{UserID}/associations \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "attributes": { "sudo": { "enabled": true, "withoutPassword": false } }, "op": "add", "type": "system_group", "id": "{GroupID}" }'

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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

content_type = "application/json" # String | 

accept = "application/json" # String | 

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

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

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
content_type	String		[default to application/json]
accept	String		[default to application/json]
body	UserGraphManagementReq		[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_member_of

Array<GraphObjectWithPaths> graph_user_member_of(user_id, content_type, accept, opts)

List the parent Groups of a User

This endpoint returns all the User Groups a User is a member of. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/memberof \\ -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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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 parent Groups of a User
  result = api_instance.graph_user_member_of(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_member_of: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_application

Array<GraphObjectWithPaths> graph_user_traverse_application(user_id, content_type, accept, opts)

List the Applications bound to a User

This endpoint will return all Applications bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_application(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_application: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_directory

Array<GraphObjectWithPaths> graph_user_traverse_directory(user_id, content_type, accept, opts)

List the Directories bound to a User

This endpoint will return all Directories bound to a User, 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 to the corresponding Directory; this array represents all grouping and/or associations that would have to be removed to deprovision the Directory from this User. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_directory(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_directory: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_g_suite

Array<GraphObjectWithPaths> graph_user_traverse_g_suite(user_id, content_type, accept, opts)

List the G Suite instances bound to a User

This endpoint will return all G-Suite Instances bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_g_suite(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_g_suite: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_ldap_server

Array<GraphObjectWithPaths> graph_user_traverse_ldap_server(user_id, content_type, accept, opts)

List the LDAP servers bound to a User

This endpoint will return all LDAP Servers bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_ldap_server(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_ldap_server: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_office365

Array<GraphObjectWithPaths> graph_user_traverse_office365(user_id, content_type, accept, opts)

List the Office 365 instances bound to a User

This endpoint will return all Office 365 Instances bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_office365(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_office365: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_radius_server

Array<GraphObjectWithPaths> graph_user_traverse_radius_server(user_id, content_type, accept, opts)

List the RADIUS Servers bound to a User

This endpoint will return all RADIUS Servers bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_radius_server(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_radius_server: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_system

Array<GraphObjectWithPaths> graph_user_traverse_system(user_id, content_type, accept, opts)

List the Systems bound to a User

This endpoint will return all Systems bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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
  result = api_instance.graph_user_traverse_system(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_system: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
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_traverse_system_group

Array<GraphObjectWithPaths> graph_user_traverse_system_group(user_id, content_type, accept, opts)

List the System Groups bound to a User

This endpoint will return all System Groups bound to a User, 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 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. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/users/{UserID}/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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

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 a User
  result = api_instance.graph_user_traverse_system_group(user_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->graph_user_traverse_system_group: #{e}"
end

Parameters

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

users_send_emails

users_send_emails(user_id, content_type, accept, opts)

Send User Emails

This endpoint allows you to send a specific email to a user without waiting for or triggering a workflow.

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::UsersApi.new

user_id = "user_id_example" # String | ObjectID of the User.

content_type = "application/json" # String | 

accept = "application/json" # String | 

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

begin
  #Send User Emails
  api_instance.users_send_emails(user_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling UsersApi->users_send_emails: #{e}"
end

Parameters

Name	Type	Description	Notes
user_id	String	ObjectID of the User.
content_type	String		[default to application/json]
accept	String		[default to application/json]
body	Emailrequest		[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

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

JCAPIv2::UsersApi

graph_user_associations_list

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_associations_post

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_member_of

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_application

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_directory

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_g_suite

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_ldap_server

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_office365

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_radius_server

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_system

Example

Parameters

Return type

Authorization

HTTP request headers

graph_user_traverse_system_group

Example

Parameters

Return type

Authorization

HTTP request headers

users_send_emails

Example

Parameters

Return type

Authorization

HTTP request headers