OutpostsAPI.md

OutpostsAPI

All URIs are relative to http://localhost/api/v3

Method	HTTP request	Description
outpostsInstancesCreate	POST /outposts/instances/
outpostsInstancesDefaultSettingsRetrieve	GET /outposts/instances/default_settings/
outpostsInstancesDestroy	DELETE /outposts/instances/{uuid}/
outpostsInstancesHealthList	GET /outposts/instances/{uuid}/health/
outpostsInstancesList	GET /outposts/instances/
outpostsInstancesPartialUpdate	PATCH /outposts/instances/{uuid}/
outpostsInstancesRetrieve	GET /outposts/instances/{uuid}/
outpostsInstancesUpdate	PUT /outposts/instances/{uuid}/
outpostsInstancesUsedByList	GET /outposts/instances/{uuid}/used_by/
outpostsLdapList	GET /outposts/ldap/
outpostsLdapRetrieve	GET /outposts/ldap/{id}/
outpostsProxyList	GET /outposts/proxy/
outpostsProxyRetrieve	GET /outposts/proxy/{id}/
outpostsRadiusList	GET /outposts/radius/
outpostsRadiusRetrieve	GET /outposts/radius/{id}/
outpostsServiceConnectionsAllDestroy	DELETE /outposts/service_connections/all/{uuid}/
outpostsServiceConnectionsAllList	GET /outposts/service_connections/all/
outpostsServiceConnectionsAllRetrieve	GET /outposts/service_connections/all/{uuid}/
outpostsServiceConnectionsAllStateRetrieve	GET /outposts/service_connections/all/{uuid}/state/
outpostsServiceConnectionsAllTypesList	GET /outposts/service_connections/all/types/
outpostsServiceConnectionsAllUsedByList	GET /outposts/service_connections/all/{uuid}/used_by/
outpostsServiceConnectionsDockerCreate	POST /outposts/service_connections/docker/
outpostsServiceConnectionsDockerDestroy	DELETE /outposts/service_connections/docker/{uuid}/
outpostsServiceConnectionsDockerList	GET /outposts/service_connections/docker/
outpostsServiceConnectionsDockerPartialUpdate	PATCH /outposts/service_connections/docker/{uuid}/
outpostsServiceConnectionsDockerRetrieve	GET /outposts/service_connections/docker/{uuid}/
outpostsServiceConnectionsDockerUpdate	PUT /outposts/service_connections/docker/{uuid}/
outpostsServiceConnectionsDockerUsedByList	GET /outposts/service_connections/docker/{uuid}/used_by/
outpostsServiceConnectionsKubernetesCreate	POST /outposts/service_connections/kubernetes/
outpostsServiceConnectionsKubernetesDestroy	DELETE /outposts/service_connections/kubernetes/{uuid}/
outpostsServiceConnectionsKubernetesList	GET /outposts/service_connections/kubernetes/
outpostsServiceConnectionsKubernetesPartialUpdate	PATCH /outposts/service_connections/kubernetes/{uuid}/
outpostsServiceConnectionsKubernetesRetrieve	GET /outposts/service_connections/kubernetes/{uuid}/
outpostsServiceConnectionsKubernetesUpdate	PUT /outposts/service_connections/kubernetes/{uuid}/
outpostsServiceConnectionsKubernetesUsedByList	GET /outposts/service_connections/kubernetes/{uuid}/used_by/

outpostsInstancesCreate

    open class func outpostsInstancesCreate(outpostRequest: OutpostRequest, completion: @escaping (_ data: Outpost?, _ error: Error?) -> Void)

Outpost Viewset

Example

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

let outpostRequest = OutpostRequest(name: "name_example", type: OutpostTypeEnum(), providers: [123], serviceConnection: 123, config: "TODO", managed: "managed_example") // OutpostRequest | 

OutpostsAPI.outpostsInstancesCreate(outpostRequest: outpostRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
outpostRequest	OutpostRequest

Return type

Outpost

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesDefaultSettingsRetrieve

    open class func outpostsInstancesDefaultSettingsRetrieve(completion: @escaping (_ data: OutpostDefaultConfig?, _ error: Error?) -> Void)

Global default outpost config

Example

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


OutpostsAPI.outpostsInstancesDefaultSettingsRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

OutpostDefaultConfig

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesDestroy

    open class func outpostsInstancesDestroy(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Outpost Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost.

OutpostsAPI.outpostsInstancesDestroy(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesHealthList

    open class func outpostsInstancesHealthList(uuid: UUID, managedIcontains: String? = nil, managedIexact: String? = nil, nameIcontains: String? = nil, nameIexact: String? = nil, ordering: String? = nil, providersIsnull: Bool? = nil, providersByPk: [Int]? = nil, search: String? = nil, serviceConnectionNameIcontains: String? = nil, serviceConnectionNameIexact: String? = nil, completion: @escaping (_ data: [OutpostHealth]?, _ error: Error?) -> Void)

Get outposts current health

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost.
let managedIcontains = "managedIcontains_example" // String |  (optional)
let managedIexact = "managedIexact_example" // String |  (optional)
let nameIcontains = "nameIcontains_example" // String |  (optional)
let nameIexact = "nameIexact_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let providersIsnull = true // Bool |  (optional)
let providersByPk = [123] // [Int] |  (optional)
let search = "search_example" // String | A search term. (optional)
let serviceConnectionNameIcontains = "serviceConnectionNameIcontains_example" // String |  (optional)
let serviceConnectionNameIexact = "serviceConnectionNameIexact_example" // String |  (optional)

OutpostsAPI.outpostsInstancesHealthList(uuid: uuid, managedIcontains: managedIcontains, managedIexact: managedIexact, nameIcontains: nameIcontains, nameIexact: nameIexact, ordering: ordering, providersIsnull: providersIsnull, providersByPk: providersByPk, search: search, serviceConnectionNameIcontains: serviceConnectionNameIcontains, serviceConnectionNameIexact: serviceConnectionNameIexact) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.
managedIcontains	String		[optional]
managedIexact	String		[optional]
nameIcontains	String		[optional]
nameIexact	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
providersIsnull	Bool		[optional]
providersByPk	[Int]		[optional]
search	String	A search term.	[optional]
serviceConnectionNameIcontains	String		[optional]
serviceConnectionNameIexact	String		[optional]

Return type

[OutpostHealth]

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesList

    open class func outpostsInstancesList(managedIcontains: String? = nil, managedIexact: String? = nil, nameIcontains: String? = nil, nameIexact: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, providersIsnull: Bool? = nil, providersByPk: [Int]? = nil, search: String? = nil, serviceConnectionNameIcontains: String? = nil, serviceConnectionNameIexact: String? = nil, completion: @escaping (_ data: PaginatedOutpostList?, _ error: Error?) -> Void)

Outpost Viewset

Example

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

let managedIcontains = "managedIcontains_example" // String |  (optional)
let managedIexact = "managedIexact_example" // String |  (optional)
let nameIcontains = "nameIcontains_example" // String |  (optional)
let nameIexact = "nameIexact_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let providersIsnull = true // Bool |  (optional)
let providersByPk = [123] // [Int] |  (optional)
let search = "search_example" // String | A search term. (optional)
let serviceConnectionNameIcontains = "serviceConnectionNameIcontains_example" // String |  (optional)
let serviceConnectionNameIexact = "serviceConnectionNameIexact_example" // String |  (optional)

OutpostsAPI.outpostsInstancesList(managedIcontains: managedIcontains, managedIexact: managedIexact, nameIcontains: nameIcontains, nameIexact: nameIexact, ordering: ordering, page: page, pageSize: pageSize, providersIsnull: providersIsnull, providersByPk: providersByPk, search: search, serviceConnectionNameIcontains: serviceConnectionNameIcontains, serviceConnectionNameIexact: serviceConnectionNameIexact) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
managedIcontains	String		[optional]
managedIexact	String		[optional]
nameIcontains	String		[optional]
nameIexact	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
providersIsnull	Bool		[optional]
providersByPk	[Int]		[optional]
search	String	A search term.	[optional]
serviceConnectionNameIcontains	String		[optional]
serviceConnectionNameIexact	String		[optional]

Return type

PaginatedOutpostList

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesPartialUpdate

    open class func outpostsInstancesPartialUpdate(uuid: UUID, patchedOutpostRequest: PatchedOutpostRequest? = nil, completion: @escaping (_ data: Outpost?, _ error: Error?) -> Void)

Outpost Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost.
let patchedOutpostRequest = PatchedOutpostRequest(name: "name_example", type: OutpostTypeEnum(), providers: [123], serviceConnection: 123, config: "TODO", managed: "managed_example") // PatchedOutpostRequest |  (optional)

OutpostsAPI.outpostsInstancesPartialUpdate(uuid: uuid, patchedOutpostRequest: patchedOutpostRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.
patchedOutpostRequest	PatchedOutpostRequest		[optional]

Return type

Outpost

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesRetrieve

    open class func outpostsInstancesRetrieve(uuid: UUID, completion: @escaping (_ data: Outpost?, _ error: Error?) -> Void)

Outpost Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost.

OutpostsAPI.outpostsInstancesRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.

Return type

Outpost

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesUpdate

    open class func outpostsInstancesUpdate(uuid: UUID, outpostRequest: OutpostRequest, completion: @escaping (_ data: Outpost?, _ error: Error?) -> Void)

Outpost Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost.
let outpostRequest = OutpostRequest(name: "name_example", type: OutpostTypeEnum(), providers: [123], serviceConnection: 123, config: "TODO", managed: "managed_example") // OutpostRequest | 

OutpostsAPI.outpostsInstancesUpdate(uuid: uuid, outpostRequest: outpostRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.
outpostRequest	OutpostRequest

Return type

Outpost

Authorization

authentik

HTTP request headers

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

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

outpostsInstancesUsedByList

    open class func outpostsInstancesUsedByList(uuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost.

OutpostsAPI.outpostsInstancesUsedByList(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

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

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

outpostsLdapList

    open class func outpostsLdapList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedLDAPOutpostConfigList?, _ error: Error?) -> Void)

LDAPProvider Viewset

Example

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

let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)

OutpostsAPI.outpostsLdapList(name: name, ordering: ordering, page: page, pageSize: pageSize, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]

Return type

PaginatedLDAPOutpostConfigList

Authorization

authentik

HTTP request headers

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

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

outpostsLdapRetrieve

    open class func outpostsLdapRetrieve(id: Int, completion: @escaping (_ data: LDAPOutpostConfig?, _ error: Error?) -> Void)

LDAPProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this LDAP Provider.

OutpostsAPI.outpostsLdapRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this LDAP Provider.

Return type

LDAPOutpostConfig

Authorization

authentik

HTTP request headers

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

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

outpostsProxyList

    open class func outpostsProxyList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedProxyOutpostConfigList?, _ error: Error?) -> Void)

ProxyProvider Viewset

Example

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

let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)

OutpostsAPI.outpostsProxyList(name: name, ordering: ordering, page: page, pageSize: pageSize, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]

Return type

PaginatedProxyOutpostConfigList

Authorization

authentik

HTTP request headers

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

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

outpostsProxyRetrieve

    open class func outpostsProxyRetrieve(id: Int, completion: @escaping (_ data: ProxyOutpostConfig?, _ error: Error?) -> Void)

ProxyProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Proxy Provider.

OutpostsAPI.outpostsProxyRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Proxy Provider.

Return type

ProxyOutpostConfig

Authorization

authentik

HTTP request headers

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

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

outpostsRadiusList

    open class func outpostsRadiusList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedRadiusOutpostConfigList?, _ error: Error?) -> Void)

RadiusProvider Viewset

Example

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

let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)

OutpostsAPI.outpostsRadiusList(name: name, ordering: ordering, page: page, pageSize: pageSize, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]

Return type

PaginatedRadiusOutpostConfigList

Authorization

authentik

HTTP request headers

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

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

outpostsRadiusRetrieve

    open class func outpostsRadiusRetrieve(id: Int, completion: @escaping (_ data: RadiusOutpostConfig?, _ error: Error?) -> Void)

RadiusProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Radius Provider.

OutpostsAPI.outpostsRadiusRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Radius Provider.

Return type

RadiusOutpostConfig

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsAllDestroy

    open class func outpostsServiceConnectionsAllDestroy(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

ServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost Service-Connection.

OutpostsAPI.outpostsServiceConnectionsAllDestroy(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsAllList

    open class func outpostsServiceConnectionsAllList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedServiceConnectionList?, _ error: Error?) -> Void)

ServiceConnection Viewset

Example

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

let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)

OutpostsAPI.outpostsServiceConnectionsAllList(name: name, ordering: ordering, page: page, pageSize: pageSize, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]

Return type

PaginatedServiceConnectionList

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsAllRetrieve

    open class func outpostsServiceConnectionsAllRetrieve(uuid: UUID, completion: @escaping (_ data: ServiceConnection?, _ error: Error?) -> Void)

ServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost Service-Connection.

OutpostsAPI.outpostsServiceConnectionsAllRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

Return type

ServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsAllStateRetrieve

    open class func outpostsServiceConnectionsAllStateRetrieve(uuid: UUID, completion: @escaping (_ data: ServiceConnectionState?, _ error: Error?) -> Void)

Get the service connection's state

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost Service-Connection.

OutpostsAPI.outpostsServiceConnectionsAllStateRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

Return type

ServiceConnectionState

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsAllTypesList

    open class func outpostsServiceConnectionsAllTypesList(completion: @escaping (_ data: [TypeCreate]?, _ error: Error?) -> Void)

Get all creatable service connection types

Example

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


OutpostsAPI.outpostsServiceConnectionsAllTypesList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[TypeCreate]

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsAllUsedByList

    open class func outpostsServiceConnectionsAllUsedByList(uuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

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

let uuid = 987 // UUID | A UUID string identifying this Outpost Service-Connection.

OutpostsAPI.outpostsServiceConnectionsAllUsedByList(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerCreate

    open class func outpostsServiceConnectionsDockerCreate(dockerServiceConnectionRequest: DockerServiceConnectionRequest, completion: @escaping (_ data: DockerServiceConnection?, _ error: Error?) -> Void)

DockerServiceConnection Viewset

Example

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

let dockerServiceConnectionRequest = DockerServiceConnectionRequest(name: "name_example", local: false, url: "url_example", tlsVerification: 123, tlsAuthentication: 123) // DockerServiceConnectionRequest | 

OutpostsAPI.outpostsServiceConnectionsDockerCreate(dockerServiceConnectionRequest: dockerServiceConnectionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
dockerServiceConnectionRequest	DockerServiceConnectionRequest

Return type

DockerServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerDestroy

    open class func outpostsServiceConnectionsDockerDestroy(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

DockerServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Docker Service-Connection.

OutpostsAPI.outpostsServiceConnectionsDockerDestroy(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerList

    open class func outpostsServiceConnectionsDockerList(local: Bool? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, tlsAuthentication: UUID? = nil, tlsVerification: UUID? = nil, url: String? = nil, completion: @escaping (_ data: PaginatedDockerServiceConnectionList?, _ error: Error?) -> Void)

DockerServiceConnection Viewset

Example

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

let local = true // Bool |  (optional)
let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let tlsAuthentication = 987 // UUID |  (optional)
let tlsVerification = 987 // UUID |  (optional)
let url = "url_example" // String |  (optional)

OutpostsAPI.outpostsServiceConnectionsDockerList(local: local, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, tlsAuthentication: tlsAuthentication, tlsVerification: tlsVerification, url: url) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
local	Bool		[optional]
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]
tlsAuthentication	UUID		[optional]
tlsVerification	UUID		[optional]
url	String		[optional]

Return type

PaginatedDockerServiceConnectionList

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerPartialUpdate

    open class func outpostsServiceConnectionsDockerPartialUpdate(uuid: UUID, patchedDockerServiceConnectionRequest: PatchedDockerServiceConnectionRequest? = nil, completion: @escaping (_ data: DockerServiceConnection?, _ error: Error?) -> Void)

DockerServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Docker Service-Connection.
let patchedDockerServiceConnectionRequest = PatchedDockerServiceConnectionRequest(name: "name_example", local: false, url: "url_example", tlsVerification: 123, tlsAuthentication: 123) // PatchedDockerServiceConnectionRequest |  (optional)

OutpostsAPI.outpostsServiceConnectionsDockerPartialUpdate(uuid: uuid, patchedDockerServiceConnectionRequest: patchedDockerServiceConnectionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.
patchedDockerServiceConnectionRequest	PatchedDockerServiceConnectionRequest		[optional]

Return type

DockerServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerRetrieve

    open class func outpostsServiceConnectionsDockerRetrieve(uuid: UUID, completion: @escaping (_ data: DockerServiceConnection?, _ error: Error?) -> Void)

DockerServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Docker Service-Connection.

OutpostsAPI.outpostsServiceConnectionsDockerRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.

Return type

DockerServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerUpdate

    open class func outpostsServiceConnectionsDockerUpdate(uuid: UUID, dockerServiceConnectionRequest: DockerServiceConnectionRequest, completion: @escaping (_ data: DockerServiceConnection?, _ error: Error?) -> Void)

DockerServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Docker Service-Connection.
let dockerServiceConnectionRequest = DockerServiceConnectionRequest(name: "name_example", local: false, url: "url_example", tlsVerification: 123, tlsAuthentication: 123) // DockerServiceConnectionRequest | 

OutpostsAPI.outpostsServiceConnectionsDockerUpdate(uuid: uuid, dockerServiceConnectionRequest: dockerServiceConnectionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.
dockerServiceConnectionRequest	DockerServiceConnectionRequest

Return type

DockerServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsDockerUsedByList

    open class func outpostsServiceConnectionsDockerUsedByList(uuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

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

let uuid = 987 // UUID | A UUID string identifying this Docker Service-Connection.

OutpostsAPI.outpostsServiceConnectionsDockerUsedByList(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesCreate

    open class func outpostsServiceConnectionsKubernetesCreate(kubernetesServiceConnectionRequest: KubernetesServiceConnectionRequest, completion: @escaping (_ data: KubernetesServiceConnection?, _ error: Error?) -> Void)

KubernetesServiceConnection Viewset

Example

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

let kubernetesServiceConnectionRequest = KubernetesServiceConnectionRequest(name: "name_example", local: false, kubeconfig: "TODO", verifySsl: false) // KubernetesServiceConnectionRequest | 

OutpostsAPI.outpostsServiceConnectionsKubernetesCreate(kubernetesServiceConnectionRequest: kubernetesServiceConnectionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
kubernetesServiceConnectionRequest	KubernetesServiceConnectionRequest

Return type

KubernetesServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesDestroy

    open class func outpostsServiceConnectionsKubernetesDestroy(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

KubernetesServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Kubernetes Service-Connection.

OutpostsAPI.outpostsServiceConnectionsKubernetesDestroy(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesList

    open class func outpostsServiceConnectionsKubernetesList(local: Bool? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedKubernetesServiceConnectionList?, _ error: Error?) -> Void)

KubernetesServiceConnection Viewset

Example

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

let local = true // Bool |  (optional)
let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)

OutpostsAPI.outpostsServiceConnectionsKubernetesList(local: local, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
local	Bool		[optional]
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]

Return type

PaginatedKubernetesServiceConnectionList

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesPartialUpdate

    open class func outpostsServiceConnectionsKubernetesPartialUpdate(uuid: UUID, patchedKubernetesServiceConnectionRequest: PatchedKubernetesServiceConnectionRequest? = nil, completion: @escaping (_ data: KubernetesServiceConnection?, _ error: Error?) -> Void)

KubernetesServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Kubernetes Service-Connection.
let patchedKubernetesServiceConnectionRequest = PatchedKubernetesServiceConnectionRequest(name: "name_example", local: false, kubeconfig: "TODO", verifySsl: false) // PatchedKubernetesServiceConnectionRequest |  (optional)

OutpostsAPI.outpostsServiceConnectionsKubernetesPartialUpdate(uuid: uuid, patchedKubernetesServiceConnectionRequest: patchedKubernetesServiceConnectionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.
patchedKubernetesServiceConnectionRequest	PatchedKubernetesServiceConnectionRequest		[optional]

Return type

KubernetesServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesRetrieve

    open class func outpostsServiceConnectionsKubernetesRetrieve(uuid: UUID, completion: @escaping (_ data: KubernetesServiceConnection?, _ error: Error?) -> Void)

KubernetesServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Kubernetes Service-Connection.

OutpostsAPI.outpostsServiceConnectionsKubernetesRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.

Return type

KubernetesServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesUpdate

    open class func outpostsServiceConnectionsKubernetesUpdate(uuid: UUID, kubernetesServiceConnectionRequest: KubernetesServiceConnectionRequest, completion: @escaping (_ data: KubernetesServiceConnection?, _ error: Error?) -> Void)

KubernetesServiceConnection Viewset

Example

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

let uuid = 987 // UUID | A UUID string identifying this Kubernetes Service-Connection.
let kubernetesServiceConnectionRequest = KubernetesServiceConnectionRequest(name: "name_example", local: false, kubeconfig: "TODO", verifySsl: false) // KubernetesServiceConnectionRequest | 

OutpostsAPI.outpostsServiceConnectionsKubernetesUpdate(uuid: uuid, kubernetesServiceConnectionRequest: kubernetesServiceConnectionRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.
kubernetesServiceConnectionRequest	KubernetesServiceConnectionRequest

Return type

KubernetesServiceConnection

Authorization

authentik

HTTP request headers

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

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

outpostsServiceConnectionsKubernetesUsedByList

    open class func outpostsServiceConnectionsKubernetesUsedByList(uuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

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

let uuid = 987 // UUID | A UUID string identifying this Kubernetes Service-Connection.

OutpostsAPI.outpostsServiceConnectionsKubernetesUsedByList(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

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

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