TenantsApi

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

Method	HTTP request	Description
tenantsDomainsCreate	POST /tenants/domains/
tenantsDomainsDestroy	DELETE /tenants/domains/{id}/
tenantsDomainsList	GET /tenants/domains/
tenantsDomainsPartialUpdate	PATCH /tenants/domains/{id}/
tenantsDomainsRetrieve	GET /tenants/domains/{id}/
tenantsDomainsUpdate	PUT /tenants/domains/{id}/
tenantsTenantsCreate	POST /tenants/tenants/
tenantsTenantsCreateAdminGroupCreate	POST /tenants/tenants/{tenant_uuid}/create_admin_group/
tenantsTenantsCreateRecoveryKeyCreate	POST /tenants/tenants/{tenant_uuid}/create_recovery_key/
tenantsTenantsDestroy	DELETE /tenants/tenants/{tenant_uuid}/
tenantsTenantsList	GET /tenants/tenants/
tenantsTenantsPartialUpdate	PATCH /tenants/tenants/{tenant_uuid}/
tenantsTenantsRetrieve	GET /tenants/tenants/{tenant_uuid}/
tenantsTenantsUpdate	PUT /tenants/tenants/{tenant_uuid}/

tenantsDomainsCreate

Domain tenantsDomainsCreate(domainRequest)

Domain ViewSet

Example

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

val apiInstance = TenantsApi()
val domainRequest : DomainRequest =  // DomainRequest | 
try {
    val result : Domain = apiInstance.tenantsDomainsCreate(domainRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsDomainsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsDomainsCreate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
domainRequest	DomainRequest

Return type

Domain

Authorization

No authorization required

HTTP request headers

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

tenantsDomainsDestroy

tenantsDomainsDestroy(id)

Domain ViewSet

Example

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

val apiInstance = TenantsApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this Domain.
try {
    apiInstance.tenantsDomainsDestroy(id)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsDomainsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsDomainsDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

tenantsDomainsList

PaginatedDomainList tenantsDomainsList(ordering, page, pageSize, search)

Domain ViewSet

Example

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

val apiInstance = TenantsApi()
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 : PaginatedDomainList = apiInstance.tenantsDomainsList(ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsDomainsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsDomainsList")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
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

PaginatedDomainList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

tenantsDomainsPartialUpdate

Domain tenantsDomainsPartialUpdate(id, patchedDomainRequest)

Domain ViewSet

Example

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

val apiInstance = TenantsApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this Domain.
val patchedDomainRequest : PatchedDomainRequest =  // PatchedDomainRequest | 
try {
    val result : Domain = apiInstance.tenantsDomainsPartialUpdate(id, patchedDomainRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsDomainsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsDomainsPartialUpdate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.Int	A unique integer value identifying this Domain.
patchedDomainRequest	PatchedDomainRequest		[optional]

Return type

Domain

Authorization

No authorization required

HTTP request headers

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

tenantsDomainsRetrieve

Domain tenantsDomainsRetrieve(id)

Domain ViewSet

Example

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

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

Parameters

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

Return type

Domain

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

tenantsDomainsUpdate

Domain tenantsDomainsUpdate(id, domainRequest)

Domain ViewSet

Example

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

val apiInstance = TenantsApi()
val id : kotlin.Int = 56 // kotlin.Int | A unique integer value identifying this Domain.
val domainRequest : DomainRequest =  // DomainRequest | 
try {
    val result : Domain = apiInstance.tenantsDomainsUpdate(id, domainRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsDomainsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsDomainsUpdate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
id	kotlin.Int	A unique integer value identifying this Domain.
domainRequest	DomainRequest

Return type

Domain

Authorization

No authorization required

HTTP request headers

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

tenantsTenantsCreate

Tenant tenantsTenantsCreate(tenantRequest)

Tenant Viewset

Example

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

val apiInstance = TenantsApi()
val tenantRequest : TenantRequest =  // TenantRequest | 
try {
    val result : Tenant = apiInstance.tenantsTenantsCreate(tenantRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsTenantsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsTenantsCreate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
tenantRequest	TenantRequest

Return type

Tenant

Authorization

No authorization required

HTTP request headers

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

tenantsTenantsCreateAdminGroupCreate

tenantsTenantsCreateAdminGroupCreate(tenantUuid, tenantAdminGroupRequestRequest)

Create admin group and add user to it.

Example

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

val apiInstance = TenantsApi()
val tenantUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Tenant.
val tenantAdminGroupRequestRequest : TenantAdminGroupRequestRequest =  // TenantAdminGroupRequestRequest | 
try {
    apiInstance.tenantsTenantsCreateAdminGroupCreate(tenantUuid, tenantAdminGroupRequestRequest)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsTenantsCreateAdminGroupCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsTenantsCreateAdminGroupCreate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
tenantUuid	java.util.UUID	A UUID string identifying this Tenant.
tenantAdminGroupRequestRequest	TenantAdminGroupRequestRequest

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

tenantsTenantsCreateRecoveryKeyCreate

TenantRecoveryKeyResponse tenantsTenantsCreateRecoveryKeyCreate(tenantUuid, tenantRecoveryKeyRequestRequest)

Create recovery key for user.

Example

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

val apiInstance = TenantsApi()
val tenantUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Tenant.
val tenantRecoveryKeyRequestRequest : TenantRecoveryKeyRequestRequest =  // TenantRecoveryKeyRequestRequest | 
try {
    val result : TenantRecoveryKeyResponse = apiInstance.tenantsTenantsCreateRecoveryKeyCreate(tenantUuid, tenantRecoveryKeyRequestRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsTenantsCreateRecoveryKeyCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsTenantsCreateRecoveryKeyCreate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
tenantUuid	java.util.UUID	A UUID string identifying this Tenant.
tenantRecoveryKeyRequestRequest	TenantRecoveryKeyRequestRequest

Return type

TenantRecoveryKeyResponse

Authorization

No authorization required

HTTP request headers

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

tenantsTenantsDestroy

tenantsTenantsDestroy(tenantUuid)

Tenant Viewset

Example

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

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

Parameters

Name	Type	Description	Notes
tenantUuid	java.util.UUID	A UUID string identifying this Tenant.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

tenantsTenantsList

PaginatedTenantList tenantsTenantsList(ordering, page, pageSize, search)

Tenant Viewset

Example

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

val apiInstance = TenantsApi()
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 : PaginatedTenantList = apiInstance.tenantsTenantsList(ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsTenantsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsTenantsList")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
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

PaginatedTenantList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

tenantsTenantsPartialUpdate

Tenant tenantsTenantsPartialUpdate(tenantUuid, patchedTenantRequest)

Tenant Viewset

Example

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

val apiInstance = TenantsApi()
val tenantUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Tenant.
val patchedTenantRequest : PatchedTenantRequest =  // PatchedTenantRequest | 
try {
    val result : Tenant = apiInstance.tenantsTenantsPartialUpdate(tenantUuid, patchedTenantRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsTenantsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsTenantsPartialUpdate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
tenantUuid	java.util.UUID	A UUID string identifying this Tenant.
patchedTenantRequest	PatchedTenantRequest		[optional]

Return type

Tenant

Authorization

No authorization required

HTTP request headers

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

tenantsTenantsRetrieve

Tenant tenantsTenantsRetrieve(tenantUuid)

Tenant Viewset

Example

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

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

Parameters

Name	Type	Description	Notes
tenantUuid	java.util.UUID	A UUID string identifying this Tenant.

Return type

Tenant

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

tenantsTenantsUpdate

Tenant tenantsTenantsUpdate(tenantUuid, tenantRequest)

Tenant Viewset

Example

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

val apiInstance = TenantsApi()
val tenantUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Tenant.
val tenantRequest : TenantRequest =  // TenantRequest | 
try {
    val result : Tenant = apiInstance.tenantsTenantsUpdate(tenantUuid, tenantRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling TenantsApi#tenantsTenantsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling TenantsApi#tenantsTenantsUpdate")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
tenantUuid	java.util.UUID	A UUID string identifying this Tenant.
tenantRequest	TenantRequest

Return type

Tenant

Authorization

No authorization required

HTTP request headers

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

Files

TenantsApi.md

Latest commit

History

TenantsApi.md

File metadata and controls

TenantsApi

tenantsDomainsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsDomainsDestroy

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsDomainsList

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsDomainsPartialUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsDomainsRetrieve

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsDomainsUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsCreateAdminGroupCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsCreateRecoveryKeyCreate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsDestroy

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsList

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsPartialUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

tenantsTenantsRetrieve