Skip to content

Latest commit

 

History

History
373 lines (257 loc) · 13 KB

InHouseAppsAPI.md

File metadata and controls

373 lines (257 loc) · 13 KB
Raw

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

    open class func createInhouseApp(contentType: String, body: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Create In-House App

After uploading the .ipa app file to S3, this request allows you to create the In-House App in the Kandji library.

You must have already generated a file_key via Create In-House App endpoint and uploaded the file to S3 using a request similar to the Upload In-House App to S3 example.

The name key can be an arbitrary value used for setting the name of the Library Item as it appears in Kandji

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let contentType = "contentType_example" // String | 
let body = "body_example" // String |  (optional)

// Create In-House App
InHouseAppsAPI.createInhouseApp(contentType: contentType, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
contentType String
body String [optional]

Return type

Void (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

    open class func deleteInhouseApp(libraryItemId: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Delete In-House App

NOTICE: This is permanent so be careful.

This endpoint sends a request to delete a specific In-House App Library Item from Kandji.

Request Parameters

library_item_id (path parameter): The unique identifier of the Library Item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let libraryItemId = "libraryItemId_example" // String | 

// Delete In-House App
InHouseAppsAPI.deleteInhouseApp(libraryItemId: libraryItemId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
libraryItemId String

Return type

Void (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

    open class func getInhouseApp(libraryItemId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Get In-House App

This endpoint retrieves details about a specific In-House App from the Kandji Library.

Request Parameters

library_item_id (path parameter): The unique identifier of the Library Item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let libraryItemId = "libraryItemId_example" // String | 

// Get In-House App
InHouseAppsAPI.getInhouseApp(libraryItemId: libraryItemId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
libraryItemId String

Return type

AnyCodable

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

    open class func listInhouseApps(page: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

List In-House Apps

This endpoint makes a request to retrieve a list of In-House Apps from the Kandji library.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let page = "page_example" // 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)

// List In-House Apps
InHouseAppsAPI.listInhouseApps(page: page) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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. [optional]

Return type

AnyCodable

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

    open class func updateInhouseApp(libraryItemId: String, contentType: String, body: String? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Update In-House App

This request allows you to update an existing In-house App in the Kandji library.

Must have already generated a file_key via Create In-House App endpoint and uploaded the file to S3 using a request similar to the Upload In-House App to S3 example.

Request Parameters

library_item_id (path parameter): The unique identifier of the library item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let libraryItemId = "libraryItemId_example" // String | 
let contentType = "contentType_example" // String | 
let body = "body_example" // String |  (optional)

// Update In-House App
InHouseAppsAPI.updateInhouseApp(libraryItemId: libraryItemId, contentType: contentType, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
libraryItemId String
contentType String
body String [optional]

Return type

Void (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

    open class func uploadInhouseApp(contentType: String, body: String? = nil, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Upload In-House App

This request retrieves the S3 upload details needed for uploading the in-house app .ipa file to Amazon S3.

Creates a pre-signed post_url to upload a new In-house App to S3.

The provided filename will be used to calculate a unique file_key in S3.

A separate request will have to be made to the Upload In-House App to S3 endpoint to upload the file to S3 directly using the post_url and post_data from the Upload In-House App response.

The returned id value can be used to check the upload status in the Upload In-House App Status endpoint after calling the Upload In-House App to S3 endpoint.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let contentType = "contentType_example" // String | 
let body = "body_example" // String |  (optional)

// Upload In-House App
InHouseAppsAPI.uploadInhouseApp(contentType: contentType, body: body) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
contentType String
body String [optional]

Return type

AnyCodable

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

    open class func uploadInhouseAppStatus(pendingUploadId: String, completion: @escaping (_ data: AnyCodable?, _ error: Error?) -> Void)

Upload In-House App Status

This endpoint retrieves current upload status of an In-House App .ipa file to Amazon S3 from the Upload In-House App to S3 endpoint

The app .ipa file has successfully uploaded and is ready for the Create In-House App endpoint when the status returned is VALIDATED

If the status returned is UPLOADING or VALIDATING, the upload is still being processed. Retry again after 1 second.

If the status returned is UPLOAD_FAILED or VALIDATE_FAILED then re-attempt the Upload In-House App to S3 endpoint.

Request Parameters

pending_upload_id (path parameter): This should be the id from the Upload to In-House App API response

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import kandji_sdk

let pendingUploadId = "pendingUploadId_example" // String | 

// Upload In-House App Status
InHouseAppsAPI.uploadInhouseAppStatus(pendingUploadId: pendingUploadId) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pendingUploadId String

Return type

AnyCodable

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]