Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Latest commit

 

History

History
1893 lines (1366 loc) · 61.4 KB

OutpostsApi.md

File metadata and controls

1893 lines (1366 loc) · 61.4 KB
Raw

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

Outpost outpostsInstancesCreate(outpostRequest)

Outpost Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val outpostRequest : OutpostRequest =  // OutpostRequest | 
try {
    val result : Outpost = apiInstance.outpostsInstancesCreate(outpostRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
outpostRequest OutpostRequest

Return type

Outpost

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesDefaultSettingsRetrieve

OutpostDefaultConfig outpostsInstancesDefaultSettingsRetrieve()

Global default outpost config

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
try {
    val result : OutpostDefaultConfig = apiInstance.outpostsInstancesDefaultSettingsRetrieve()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesDefaultSettingsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesDefaultSettingsRetrieve")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

OutpostDefaultConfig

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesDestroy

outpostsInstancesDestroy(uuid)

Outpost Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost.
try {
    apiInstance.outpostsInstancesDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesHealthList

kotlin.collections.List<OutpostHealth> outpostsInstancesHealthList(uuid, managedIcontains, managedIexact, nameIcontains, nameIexact, ordering, providersIsnull, providersByPk, search, serviceConnectionNameIcontains, serviceConnectionNameIexact)

Get outposts current health

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost.
val managedIcontains : kotlin.String = managedIcontains_example // kotlin.String | 
val managedIexact : kotlin.String = managedIexact_example // kotlin.String | 
val nameIcontains : kotlin.String = nameIcontains_example // kotlin.String | 
val nameIexact : kotlin.String = nameIexact_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val providersIsnull : kotlin.Boolean = true // kotlin.Boolean | 
val providersByPk : kotlin.collections.List<kotlin.Int> =  // kotlin.collections.List<kotlin.Int> | 
val search : kotlin.String = search_example // kotlin.String | A search term.
val serviceConnectionNameIcontains : kotlin.String = serviceConnectionNameIcontains_example // kotlin.String | 
val serviceConnectionNameIexact : kotlin.String = serviceConnectionNameIexact_example // kotlin.String | 
try {
    val result : kotlin.collections.List<OutpostHealth> = apiInstance.outpostsInstancesHealthList(uuid, managedIcontains, managedIexact, nameIcontains, nameIexact, ordering, providersIsnull, providersByPk, search, serviceConnectionNameIcontains, serviceConnectionNameIexact)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesHealthList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesHealthList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
uuid java.util.UUID A UUID string identifying this Outpost.
managedIcontains kotlin.String [optional]
managedIexact kotlin.String [optional]
nameIcontains kotlin.String [optional]
nameIexact kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
providersIsnull kotlin.Boolean [optional]
providersByPk kotlin.collections.List<kotlin.Int> [optional]
search kotlin.String A search term. [optional]
serviceConnectionNameIcontains kotlin.String [optional]
serviceConnectionNameIexact kotlin.String [optional]

Return type

kotlin.collections.List<OutpostHealth>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesList

PaginatedOutpostList outpostsInstancesList(managedIcontains, managedIexact, nameIcontains, nameIexact, ordering, page, pageSize, providersIsnull, providersByPk, search, serviceConnectionNameIcontains, serviceConnectionNameIexact)

Outpost Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val managedIcontains : kotlin.String = managedIcontains_example // kotlin.String | 
val managedIexact : kotlin.String = managedIexact_example // kotlin.String | 
val nameIcontains : kotlin.String = nameIcontains_example // kotlin.String | 
val nameIexact : kotlin.String = nameIexact_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val providersIsnull : kotlin.Boolean = true // kotlin.Boolean | 
val providersByPk : kotlin.collections.List<kotlin.Int> =  // kotlin.collections.List<kotlin.Int> | 
val search : kotlin.String = search_example // kotlin.String | A search term.
val serviceConnectionNameIcontains : kotlin.String = serviceConnectionNameIcontains_example // kotlin.String | 
val serviceConnectionNameIexact : kotlin.String = serviceConnectionNameIexact_example // kotlin.String | 
try {
    val result : PaginatedOutpostList = apiInstance.outpostsInstancesList(managedIcontains, managedIexact, nameIcontains, nameIexact, ordering, page, pageSize, providersIsnull, providersByPk, search, serviceConnectionNameIcontains, serviceConnectionNameIexact)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedOutpostList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesPartialUpdate

Outpost outpostsInstancesPartialUpdate(uuid, patchedOutpostRequest)

Outpost Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost.
val patchedOutpostRequest : PatchedOutpostRequest =  // PatchedOutpostRequest | 
try {
    val result : Outpost = apiInstance.outpostsInstancesPartialUpdate(uuid, patchedOutpostRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

Outpost

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesRetrieve

Outpost outpostsInstancesRetrieve(uuid)

Outpost Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost.
try {
    val result : Outpost = apiInstance.outpostsInstancesRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

Outpost

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesUpdate

Outpost outpostsInstancesUpdate(uuid, outpostRequest)

Outpost Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost.
val outpostRequest : OutpostRequest =  // OutpostRequest | 
try {
    val result : Outpost = apiInstance.outpostsInstancesUpdate(uuid, outpostRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

Outpost

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsInstancesUsedByList

kotlin.collections.List<UsedBy> outpostsInstancesUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.outpostsInstancesUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsInstancesUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsInstancesUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsLdapList

PaginatedLDAPOutpostConfigList outpostsLdapList(name, ordering, page, pageSize, search)

LDAPProvider Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedLDAPOutpostConfigList = apiInstance.outpostsLdapList(name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsLdapList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsLdapList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedLDAPOutpostConfigList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsLdapRetrieve

LDAPOutpostConfig outpostsLdapRetrieve(id)

LDAPProvider Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this LDAP Provider.
try {
    val result : LDAPOutpostConfig = apiInstance.outpostsLdapRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsLdapRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsLdapRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

LDAPOutpostConfig

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsProxyList

PaginatedProxyOutpostConfigList outpostsProxyList(name, ordering, page, pageSize, search)

ProxyProvider Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedProxyOutpostConfigList = apiInstance.outpostsProxyList(name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsProxyList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsProxyList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedProxyOutpostConfigList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsProxyRetrieve

ProxyOutpostConfig outpostsProxyRetrieve(id)

ProxyProvider Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this Proxy Provider.
try {
    val result : ProxyOutpostConfig = apiInstance.outpostsProxyRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsProxyRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsProxyRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

ProxyOutpostConfig

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsRadiusList

PaginatedRadiusOutpostConfigList outpostsRadiusList(name, ordering, page, pageSize, search)

RadiusProvider Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedRadiusOutpostConfigList = apiInstance.outpostsRadiusList(name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsRadiusList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsRadiusList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedRadiusOutpostConfigList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsRadiusRetrieve

RadiusOutpostConfig outpostsRadiusRetrieve(id)

RadiusProvider Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this Radius Provider.
try {
    val result : RadiusOutpostConfig = apiInstance.outpostsRadiusRetrieve(id)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsRadiusRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsRadiusRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

RadiusOutpostConfig

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsAllDestroy

outpostsServiceConnectionsAllDestroy(uuid)

ServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost Service-Connection.
try {
    apiInstance.outpostsServiceConnectionsAllDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsAllDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsAllDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsAllList

PaginatedServiceConnectionList outpostsServiceConnectionsAllList(name, ordering, page, pageSize, search)

ServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedServiceConnectionList = apiInstance.outpostsServiceConnectionsAllList(name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsAllList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsAllList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedServiceConnectionList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsAllRetrieve

ServiceConnection outpostsServiceConnectionsAllRetrieve(uuid)

ServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost Service-Connection.
try {
    val result : ServiceConnection = apiInstance.outpostsServiceConnectionsAllRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsAllRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsAllRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

ServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsAllStateRetrieve

ServiceConnectionState outpostsServiceConnectionsAllStateRetrieve(uuid)

Get the service connection's state

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost Service-Connection.
try {
    val result : ServiceConnectionState = apiInstance.outpostsServiceConnectionsAllStateRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsAllStateRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsAllStateRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

ServiceConnectionState

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsAllTypesList

kotlin.collections.List<TypeCreate> outpostsServiceConnectionsAllTypesList()

Get all creatable service connection types

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
try {
    val result : kotlin.collections.List<TypeCreate> = apiInstance.outpostsServiceConnectionsAllTypesList()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsAllTypesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsAllTypesList")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<TypeCreate>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsAllUsedByList

kotlin.collections.List<UsedBy> outpostsServiceConnectionsAllUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Outpost Service-Connection.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.outpostsServiceConnectionsAllUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsAllUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsAllUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerCreate

DockerServiceConnection outpostsServiceConnectionsDockerCreate(dockerServiceConnectionRequest)

DockerServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val dockerServiceConnectionRequest : DockerServiceConnectionRequest =  // DockerServiceConnectionRequest | 
try {
    val result : DockerServiceConnection = apiInstance.outpostsServiceConnectionsDockerCreate(dockerServiceConnectionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
dockerServiceConnectionRequest DockerServiceConnectionRequest

Return type

DockerServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerDestroy

outpostsServiceConnectionsDockerDestroy(uuid)

DockerServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Docker Service-Connection.
try {
    apiInstance.outpostsServiceConnectionsDockerDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerList

PaginatedDockerServiceConnectionList outpostsServiceConnectionsDockerList(local, name, ordering, page, pageSize, search, tlsAuthentication, tlsVerification, url)

DockerServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val local : kotlin.Boolean = true // kotlin.Boolean | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val tlsAuthentication : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val tlsVerification : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val url : kotlin.String = url_example // kotlin.String | 
try {
    val result : PaginatedDockerServiceConnectionList = apiInstance.outpostsServiceConnectionsDockerList(local, name, ordering, page, pageSize, search, tlsAuthentication, tlsVerification, url)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedDockerServiceConnectionList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerPartialUpdate

DockerServiceConnection outpostsServiceConnectionsDockerPartialUpdate(uuid, patchedDockerServiceConnectionRequest)

DockerServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Docker Service-Connection.
val patchedDockerServiceConnectionRequest : PatchedDockerServiceConnectionRequest =  // PatchedDockerServiceConnectionRequest | 
try {
    val result : DockerServiceConnection = apiInstance.outpostsServiceConnectionsDockerPartialUpdate(uuid, patchedDockerServiceConnectionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

DockerServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerRetrieve

DockerServiceConnection outpostsServiceConnectionsDockerRetrieve(uuid)

DockerServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Docker Service-Connection.
try {
    val result : DockerServiceConnection = apiInstance.outpostsServiceConnectionsDockerRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

DockerServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerUpdate

DockerServiceConnection outpostsServiceConnectionsDockerUpdate(uuid, dockerServiceConnectionRequest)

DockerServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Docker Service-Connection.
val dockerServiceConnectionRequest : DockerServiceConnectionRequest =  // DockerServiceConnectionRequest | 
try {
    val result : DockerServiceConnection = apiInstance.outpostsServiceConnectionsDockerUpdate(uuid, dockerServiceConnectionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

DockerServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsDockerUsedByList

kotlin.collections.List<UsedBy> outpostsServiceConnectionsDockerUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Docker Service-Connection.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.outpostsServiceConnectionsDockerUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsDockerUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsDockerUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesCreate

KubernetesServiceConnection outpostsServiceConnectionsKubernetesCreate(kubernetesServiceConnectionRequest)

KubernetesServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val kubernetesServiceConnectionRequest : KubernetesServiceConnectionRequest =  // KubernetesServiceConnectionRequest | 
try {
    val result : KubernetesServiceConnection = apiInstance.outpostsServiceConnectionsKubernetesCreate(kubernetesServiceConnectionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
kubernetesServiceConnectionRequest KubernetesServiceConnectionRequest

Return type

KubernetesServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesDestroy

outpostsServiceConnectionsKubernetesDestroy(uuid)

KubernetesServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Kubernetes Service-Connection.
try {
    apiInstance.outpostsServiceConnectionsKubernetesDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesList

PaginatedKubernetesServiceConnectionList outpostsServiceConnectionsKubernetesList(local, name, ordering, page, pageSize, search)

KubernetesServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val local : kotlin.Boolean = true // kotlin.Boolean | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedKubernetesServiceConnectionList = apiInstance.outpostsServiceConnectionsKubernetesList(local, name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedKubernetesServiceConnectionList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesPartialUpdate

KubernetesServiceConnection outpostsServiceConnectionsKubernetesPartialUpdate(uuid, patchedKubernetesServiceConnectionRequest)

KubernetesServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Kubernetes Service-Connection.
val patchedKubernetesServiceConnectionRequest : PatchedKubernetesServiceConnectionRequest =  // PatchedKubernetesServiceConnectionRequest | 
try {
    val result : KubernetesServiceConnection = apiInstance.outpostsServiceConnectionsKubernetesPartialUpdate(uuid, patchedKubernetesServiceConnectionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

KubernetesServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesRetrieve

KubernetesServiceConnection outpostsServiceConnectionsKubernetesRetrieve(uuid)

KubernetesServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Kubernetes Service-Connection.
try {
    val result : KubernetesServiceConnection = apiInstance.outpostsServiceConnectionsKubernetesRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

KubernetesServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesUpdate

KubernetesServiceConnection outpostsServiceConnectionsKubernetesUpdate(uuid, kubernetesServiceConnectionRequest)

KubernetesServiceConnection Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Kubernetes Service-Connection.
val kubernetesServiceConnectionRequest : KubernetesServiceConnectionRequest =  // KubernetesServiceConnectionRequest | 
try {
    val result : KubernetesServiceConnection = apiInstance.outpostsServiceConnectionsKubernetesUpdate(uuid, kubernetesServiceConnectionRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

KubernetesServiceConnection

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

outpostsServiceConnectionsKubernetesUsedByList

kotlin.collections.List<UsedBy> outpostsServiceConnectionsKubernetesUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = OutpostsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Kubernetes Service-Connection.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.outpostsServiceConnectionsKubernetesUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling OutpostsApi#outpostsServiceConnectionsKubernetesUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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