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

    open class func tenantsDomainsCreate(domainRequest: DomainRequest, completion: @escaping (_ data: Domain?, _ error: Error?) -> Void)

Domain 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 domainRequest = DomainRequest(domain: "domain_example", isPrimary: false, tenant: 123) // DomainRequest | 

TenantsAPI.tenantsDomainsCreate(domainRequest: domainRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
domainRequest	DomainRequest

Return type

Domain

Authorization

No authorization required

HTTP request headers

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

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

tenantsDomainsDestroy

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

Domain 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 Domain.

TenantsAPI.tenantsDomainsDestroy(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 Domain.

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

tenantsDomainsList

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

Domain 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 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)

TenantsAPI.tenantsDomainsList(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
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

PaginatedDomainList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

tenantsDomainsPartialUpdate

    open class func tenantsDomainsPartialUpdate(id: Int, patchedDomainRequest: PatchedDomainRequest? = nil, completion: @escaping (_ data: Domain?, _ error: Error?) -> Void)

Domain 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 Domain.
let patchedDomainRequest = PatchedDomainRequest(domain: "domain_example", isPrimary: false, tenant: 123) // PatchedDomainRequest |  (optional)

TenantsAPI.tenantsDomainsPartialUpdate(id: id, patchedDomainRequest: patchedDomainRequest) { (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 Domain.
patchedDomainRequest	PatchedDomainRequest		[optional]

Return type

Domain

Authorization

No authorization required

HTTP request headers

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

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

tenantsDomainsRetrieve

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

Domain 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 Domain.

TenantsAPI.tenantsDomainsRetrieve(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 Domain.

Return type

Domain

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

tenantsDomainsUpdate

    open class func tenantsDomainsUpdate(id: Int, domainRequest: DomainRequest, completion: @escaping (_ data: Domain?, _ error: Error?) -> Void)

Domain 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 Domain.
let domainRequest = DomainRequest(domain: "domain_example", isPrimary: false, tenant: 123) // DomainRequest | 

TenantsAPI.tenantsDomainsUpdate(id: id, domainRequest: domainRequest) { (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 Domain.
domainRequest	DomainRequest

Return type

Domain

Authorization

No authorization required

HTTP request headers

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

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

tenantsTenantsCreate

    open class func tenantsTenantsCreate(tenantRequest: TenantRequest, completion: @escaping (_ data: Tenant?, _ error: Error?) -> Void)

Tenant 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 tenantRequest = TenantRequest(schemaName: "schemaName_example", name: "name_example", ready: false) // TenantRequest | 

TenantsAPI.tenantsTenantsCreate(tenantRequest: tenantRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
tenantRequest	TenantRequest

Return type

Tenant

Authorization

No authorization required

HTTP request headers

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

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

tenantsTenantsCreateAdminGroupCreate

    open class func tenantsTenantsCreateAdminGroupCreate(tenantUuid: UUID, tenantAdminGroupRequestRequest: TenantAdminGroupRequestRequest, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Create admin group and add user to it.

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 tenantUuid = 987 // UUID | A UUID string identifying this Tenant.
let tenantAdminGroupRequestRequest = TenantAdminGroupRequestRequest(user: "user_example") // TenantAdminGroupRequestRequest | 

TenantsAPI.tenantsTenantsCreateAdminGroupCreate(tenantUuid: tenantUuid, tenantAdminGroupRequestRequest: tenantAdminGroupRequestRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

tenantsTenantsCreateRecoveryKeyCreate

    open class func tenantsTenantsCreateRecoveryKeyCreate(tenantUuid: UUID, tenantRecoveryKeyRequestRequest: TenantRecoveryKeyRequestRequest, completion: @escaping (_ data: TenantRecoveryKeyResponse?, _ error: Error?) -> Void)

Create recovery key for user.

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 tenantUuid = 987 // UUID | A UUID string identifying this Tenant.
let tenantRecoveryKeyRequestRequest = TenantRecoveryKeyRequestRequest(user: "user_example", durationDays: 123) // TenantRecoveryKeyRequestRequest | 

TenantsAPI.tenantsTenantsCreateRecoveryKeyCreate(tenantUuid: tenantUuid, tenantRecoveryKeyRequestRequest: tenantRecoveryKeyRequestRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

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

tenantsTenantsDestroy

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

Tenant 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 tenantUuid = 987 // UUID | A UUID string identifying this Tenant.

TenantsAPI.tenantsTenantsDestroy(tenantUuid: tenantUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

Void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

tenantsTenantsList

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

Tenant 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 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)

TenantsAPI.tenantsTenantsList(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
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

PaginatedTenantList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

tenantsTenantsPartialUpdate

    open class func tenantsTenantsPartialUpdate(tenantUuid: UUID, patchedTenantRequest: PatchedTenantRequest? = nil, completion: @escaping (_ data: Tenant?, _ error: Error?) -> Void)

Tenant 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 tenantUuid = 987 // UUID | A UUID string identifying this Tenant.
let patchedTenantRequest = PatchedTenantRequest(schemaName: "schemaName_example", name: "name_example", ready: false) // PatchedTenantRequest |  (optional)

TenantsAPI.tenantsTenantsPartialUpdate(tenantUuid: tenantUuid, patchedTenantRequest: patchedTenantRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

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

tenantsTenantsRetrieve

    open class func tenantsTenantsRetrieve(tenantUuid: UUID, completion: @escaping (_ data: Tenant?, _ error: Error?) -> Void)

Tenant 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 tenantUuid = 987 // UUID | A UUID string identifying this Tenant.

TenantsAPI.tenantsTenantsRetrieve(tenantUuid: tenantUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

Tenant

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

tenantsTenantsUpdate

    open class func tenantsTenantsUpdate(tenantUuid: UUID, tenantRequest: TenantRequest, completion: @escaping (_ data: Tenant?, _ error: Error?) -> Void)

Tenant 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 tenantUuid = 987 // UUID | A UUID string identifying this Tenant.
let tenantRequest = TenantRequest(schemaName: "schemaName_example", name: "name_example", ready: false) // TenantRequest | 

TenantsAPI.tenantsTenantsUpdate(tenantUuid: tenantUuid, tenantRequest: tenantRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

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

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