Skip to content

Latest commit

 

History

History
495 lines (312 loc) · 12.4 KB

InHouseAppsAPI.md

File metadata and controls

495 lines (312 loc) · 12.4 KB

\InHouseAppsAPI

All URIs are relative to https://<sub_domain>.api.kandji.io

Method HTTP request Description
CreateInhouseApp Post /api/v1/library/ipa-apps Create In-House App
DeleteInhouseApp Delete /api/v1/library/ipa-apps/{library_item_id} Delete In-House App
GetInhouseApp Get /api/v1/library/ipa-apps/{library_item_id} Get In-House App
ListInhouseApps Get /api/v1/library/ipa-apps List In-House Apps
UpdateInhouseApp Patch /api/v1/library/ipa-apps/{library_item_id} Update In-House App
UploadInhouseApp Post /api/v1/library/ipa-apps/upload Upload In-House App
UploadInhouseAppStatus Get /api/v1/library/ipa-apps/upload/{pending_upload_id}/status Upload In-House App Status

CreateInhouseApp

CreateInhouseApp(ctx).ContentType(contentType).Body(body).Execute()

Create In-House App

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	contentType := "application/json" // string | 
	body := "body_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.InHouseAppsAPI.CreateInhouseApp(context.Background()).ContentType(contentType).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.CreateInhouseApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateInhouseAppRequest struct via the builder pattern

Name Type Description Notes
contentType string
body string

Return type

(empty response body)

Authorization

bearer

HTTP request headers

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

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

DeleteInhouseApp

DeleteInhouseApp(ctx, libraryItemId).Execute()

Delete In-House App

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	libraryItemId := "libraryItemId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.InHouseAppsAPI.DeleteInhouseApp(context.Background(), libraryItemId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.DeleteInhouseApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
libraryItemId string

Other Parameters

Other parameters are passed through a pointer to a apiDeleteInhouseAppRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetInhouseApp

map[string]interface{} GetInhouseApp(ctx, libraryItemId).Execute()

Get In-House App

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	libraryItemId := "libraryItemId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.InHouseAppsAPI.GetInhouseApp(context.Background(), libraryItemId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.GetInhouseApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetInhouseApp`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `InHouseAppsAPI.GetInhouseApp`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
libraryItemId string

Other Parameters

Other parameters are passed through a pointer to a apiGetInhouseAppRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=utf-8

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

ListInhouseApps

map[string]interface{} ListInhouseApps(ctx).Page(page).Execute()

List In-House Apps

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	page := "1" // string | Optional page number. Used when results exceed pagination threshold. A hard upper <code>limit</code> is set at 300 app records returned per request. (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.InHouseAppsAPI.ListInhouseApps(context.Background()).Page(page).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.ListInhouseApps``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListInhouseApps`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `InHouseAppsAPI.ListInhouseApps`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListInhouseAppsRequest struct via the builder pattern

Name Type Description Notes
page string Optional page number. Used when results exceed pagination threshold. A hard upper <code>limit</code> is set at 300 app records returned per request.

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

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

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

UpdateInhouseApp

UpdateInhouseApp(ctx, libraryItemId).ContentType(contentType).Body(body).Execute()

Update In-House App

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	libraryItemId := "libraryItemId_example" // string | 
	contentType := "application/json" // string | 
	body := "body_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.InHouseAppsAPI.UpdateInhouseApp(context.Background(), libraryItemId).ContentType(contentType).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.UpdateInhouseApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
libraryItemId string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateInhouseAppRequest struct via the builder pattern

Name Type Description Notes

contentType | string | | body | string | |

Return type

(empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: text/plain
  • Accept: Not defined

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

UploadInhouseApp

map[string]interface{} UploadInhouseApp(ctx).ContentType(contentType).Body(body).Execute()

Upload In-House App

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	contentType := "application/json" // string | 
	body := "body_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.InHouseAppsAPI.UploadInhouseApp(context.Background()).ContentType(contentType).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.UploadInhouseApp``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UploadInhouseApp`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `InHouseAppsAPI.UploadInhouseApp`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUploadInhouseAppRequest struct via the builder pattern

Name Type Description Notes
contentType string
body string

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json; charset=utf-8

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

UploadInhouseAppStatus

map[string]interface{} UploadInhouseAppStatus(ctx, pendingUploadId).Execute()

Upload In-House App Status

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/MScottBlake/kandji-go-sdk"
)

func main() {
	pendingUploadId := "pendingUploadId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.InHouseAppsAPI.UploadInhouseAppStatus(context.Background(), pendingUploadId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InHouseAppsAPI.UploadInhouseAppStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UploadInhouseAppStatus`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `InHouseAppsAPI.UploadInhouseAppStatus`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pendingUploadId string

Other Parameters

Other parameters are passed through a pointer to a apiUploadInhouseAppStatusRequest struct via the builder pattern

Name Type Description Notes

Return type

map[string]interface{}

Authorization

bearer

HTTP request headers

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

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