JCAPIv2::Office365Api

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

Method	HTTP request	Description
graph_office365_associations_list	GET /office365s/{office365_id}/associations	List the associations of an Office 365 instance
graph_office365_associations_post	POST /office365s/{office365_id}/associations	Manage the associations of an Office 365 instance
graph_office365_traverse_user	GET /office365s/{office365_id}/users	List the Users bound to an Office 365 instance
graph_office365_traverse_user_group	GET /office365s/{office365_id}/usergroups	List the User Groups bound to an Office 365 instance
translation_rules_office365_delete	DELETE /office365s/{office365_id}/translationrules/{id}	Deletes a Office 365 translation rule
translation_rules_office365_get	GET /office365s/{office365_id}/translationrules/{id}	Gets a specific Office 365 translation rule
translation_rules_office365_list	GET /office365s/{office365_id}/translationrules	List all the Office 365 Translation Rules
translation_rules_office365_post	POST /office365s/{office365_id}/translationrules	Create a new Office 365 Translation Rule

graph_office365_associations_list

Array<GraphConnection> graph_office365_associations_list(office365_id, targets, content_type, accept, opts)

List the associations of an Office 365 instance

This endpoint returns direct associations of an Office 365 instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. #### Sample Request curl -X GET 'https://console.jumpcloud.com/api/v2/office365s/{O365_ID}/associations?targets=user_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::Office365Api.new

office365_id = "office365_id_example" # String | ObjectID of the Office 365 instance.

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 an Office 365 instance
  result = api_instance.graph_office365_associations_list(office365_id, targets, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->graph_office365_associations_list: #{e}"
end

Parameters

Name	Type	Description	Notes
office365_id	String	ObjectID of the Office 365 instance.
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 ]

Return type

Array<GraphConnection>

Authorization

x-api-key

HTTP request headers

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

graph_office365_associations_post

graph_office365_associations_post(office365_id, content_type, accept, opts)

Manage the associations of an Office 365 instance

This endpoint allows you to manage the direct associations of a Office 365 instance. A direct association can be a non-homogeneous relationship between 2 different objects, for example Office 365 and Users. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/office365s/{O365_ID}/associations \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"op\": \"add\", \"type\": \"user_group\", \"id\": \"{Group_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::Office365Api.new

office365_id = "office365_id_example" # String | ObjectID of the Office 365 instance.

content_type = "application/json" # String | 

accept = "application/json" # String | 

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

begin
  #Manage the associations of an Office 365 instance
  api_instance.graph_office365_associations_post(office365_id, content_type, accept, opts)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->graph_office365_associations_post: #{e}"
end

Parameters

Name	Type	Description	Notes
office365_id	String	ObjectID of the Office 365 instance.
content_type	String		[default to application/json]
accept	String		[default to application/json]
body	GraphManagementReq		[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_office365_traverse_user

Array<GraphObjectWithPaths> graph_office365_traverse_user(office365_id, content_type, accept, opts)

List the Users bound to an Office 365 instance

This endpoint will return all Users bound to an Office 365 instance, 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 Office 365 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 Office 365 instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/office365s/{O365_ID}/users \\ -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::Office365Api.new

office365_id = "office365_id_example" # String | ObjectID of the Office 365 suite.

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 an Office 365 instance
  result = api_instance.graph_office365_traverse_user(office365_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->graph_office365_traverse_user: #{e}"
end

Parameters

Name	Type	Description	Notes
office365_id	String	ObjectID of the Office 365 suite.
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_office365_traverse_user_group

Array<GraphObjectWithPaths> graph_office365_traverse_user_group(office365_id, content_type, accept, opts)

List the User Groups bound to an Office 365 instance

This endpoint will return all Users Groups bound to an Office 365 instance, 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 Office 365 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 Office 365 instance. See /members and /associations endpoints to manage those collections. #### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/office365s/{O365_ID/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::Office365Api.new

office365_id = "office365_id_example" # String | ObjectID of the Office 365 suite.

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 an Office 365 instance
  result = api_instance.graph_office365_traverse_user_group(office365_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->graph_office365_traverse_user_group: #{e}"
end

Parameters

Name	Type	Description	Notes
office365_id	String	ObjectID of the Office 365 suite.
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

translation_rules_office365_delete

translation_rules_office365_delete(office365_id, id, content_type, accept)

Deletes a Office 365 translation rule

This endpoint allows you to delete a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to Microsoft Graph attributes. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -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::Office365Api.new

office365_id = "office365_id_example" # String | 

id = "id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 


begin
  #Deletes a Office 365 translation rule
  api_instance.translation_rules_office365_delete(office365_id, id, content_type, accept)
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->translation_rules_office365_delete: #{e}"
end

Parameters

Name	Type	Notes
office365_id	String
id	String
content_type	String	[default to application/json]
accept	String	[default to application/json]

Return type

nil (empty response body)

Authorization

x-api-key

HTTP request headers

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

translation_rules_office365_get

Office365TranslationRule translation_rules_office365_get(office365_id, id, content_type, accept)

Gets a specific Office 365 translation rule

This endpoint returns a specific translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to Microsoft Graph attributes. ###### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules/{id} \\ -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::Office365Api.new

office365_id = "office365_id_example" # String | 

id = "id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 


begin
  #Gets a specific Office 365 translation rule
  result = api_instance.translation_rules_office365_get(office365_id, id, content_type, accept)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->translation_rules_office365_get: #{e}"
end

Parameters

Name	Type	Notes
office365_id	String
id	String
content_type	String	[default to application/json]
accept	String	[default to application/json]

Return type

Office365TranslationRule

Authorization

x-api-key

HTTP request headers

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

translation_rules_office365_list

Array<Office365TranslationRule> translation_rules_office365_list(office365_id, content_type, accept, opts)

List all the Office 365 Translation Rules

This endpoint returns all translation rules for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to Microsoft Graph attributes. ##### Sample Request curl -X GET https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -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::Office365Api.new

office365_id = "office365_id_example" # String | 

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. 
}

begin
  #List all the Office 365 Translation Rules
  result = api_instance.translation_rules_office365_list(office365_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->translation_rules_office365_list: #{e}"
end

Parameters

Name	Type	Description	Notes
office365_id	String
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]

Return type

Array<Office365TranslationRule>

Authorization

x-api-key

HTTP request headers

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

translation_rules_office365_post

Office365TranslationRule translation_rules_office365_post(office365_id, content_type, accept, opts)

Create a new Office 365 Translation Rule

This endpoint allows you to create a translation rule for a specific Office 365 instance. These rules specify how JumpCloud attributes translate to Microsoft Graph attributes. ##### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/office365s/{office365_id}/translationrules \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ {Translation Rule Parameters} }'

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

office365_id = "office365_id_example" # String | 

content_type = "application/json" # String | 

accept = "application/json" # String | 

opts = { 
  body: JCAPIv2::Office365TranslationRuleRequest.new # Office365TranslationRuleRequest | 
}

begin
  #Create a new Office 365 Translation Rule
  result = api_instance.translation_rules_office365_post(office365_id, content_type, accept, opts)
  p result
rescue JCAPIv2::ApiError => e
  puts "Exception when calling Office365Api->translation_rules_office365_post: #{e}"
end

Parameters

Name	Type	Notes
office365_id	String
content_type	String	[default to application/json]
accept	String	[default to application/json]
body	Office365TranslationRuleRequest	[optional]

Return type

Office365TranslationRule

Authorization

x-api-key

HTTP request headers

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

Files

Office365Api.md

Latest commit

History

Office365Api.md

File metadata and controls

JCAPIv2::Office365Api

graph_office365_associations_list

Example

Parameters

Return type

Authorization

HTTP request headers

graph_office365_associations_post

Example

Parameters

Return type

Authorization

HTTP request headers

graph_office365_traverse_user

Example

Parameters

Return type

Authorization

HTTP request headers

graph_office365_traverse_user_group

Example

Parameters

Return type

Authorization

HTTP request headers

translation_rules_office365_delete

Example

Parameters

Return type

Authorization

HTTP request headers

translation_rules_office365_get

Example

Parameters

Return type

Authorization

HTTP request headers

translation_rules_office365_list

Example

Parameters

Return type

Authorization

HTTP request headers

translation_rules_office365_post

Example

Parameters

Return type

Authorization

HTTP request headers