Skip to content

Latest commit

 

History

History
185 lines (129 loc) · 10 KB

Office365Api.md

File metadata and controls

185 lines (129 loc) · 10 KB

\Office365Api

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

Method HTTP request Description
GraphOffice365AssociationsList Get /office365s/{office365_id}/associations List the associations of an Office 365 instance
GraphOffice365AssociationsPost Post /office365s/{office365_id}/associations Manage the associations of an Office 365 instance
GraphOffice365TraverseUser Get /office365s/{office365_id}/users List the Users bound to an Office 365 instance
GraphOffice365TraverseUserGroup Get /office365s/{office365_id}/usergroups List the User Groups bound to an Office 365 instance

GraphOffice365AssociationsList

[]GraphConnection GraphOffice365AssociationsList(ctx, office365Id, targets, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
office365Id string ObjectID of the Office 365 instance.
targets []string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
office365Id string ObjectID of the Office 365 instance.
targets []string
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]GraphConnection

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GraphOffice365AssociationsPost

GraphOffice365AssociationsPost(ctx, office365Id, contentType, accept, optional) 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}\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
office365Id string ObjectID of the Office 365 instance.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
office365Id string ObjectID of the Office 365 instance.
contentType string [default to application/json]
accept string [default to application/json]
body GraphManagementReq
xOrgId string [default to ]

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GraphOffice365TraverseUser

[]GraphObjectWithPaths GraphOffice365TraverseUser(ctx, office365Id, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
office365Id string ObjectID of the Office 365 suite.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
office365Id string ObjectID of the Office 365 suite.
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]GraphObjectWithPaths

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GraphOffice365TraverseUserGroup

[]GraphObjectWithPaths GraphOffice365TraverseUserGroup(ctx, office365Id, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
office365Id string ObjectID of the Office 365 suite.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
office365Id string ObjectID of the Office 365 suite.
contentType string [default to application/json]
accept string [default to application/json]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

[]GraphObjectWithPaths

Authorization

x-api-key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]