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

Latest commit

 

History

History
3276 lines (2221 loc) · 101 KB

CoreAPI.md

File metadata and controls

3276 lines (2221 loc) · 101 KB
Raw

CoreAPI

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

Method HTTP request Description
coreApplicationsCheckAccessRetrieve GET /core/applications/{slug}/check_access/
coreApplicationsCreate POST /core/applications/
coreApplicationsDestroy DELETE /core/applications/{slug}/
coreApplicationsList GET /core/applications/
coreApplicationsMetricsList GET /core/applications/{slug}/metrics/
coreApplicationsPartialUpdate PATCH /core/applications/{slug}/
coreApplicationsRetrieve GET /core/applications/{slug}/
coreApplicationsSetIconCreate POST /core/applications/{slug}/set_icon/
coreApplicationsSetIconUrlCreate POST /core/applications/{slug}/set_icon_url/
coreApplicationsUpdate PUT /core/applications/{slug}/
coreApplicationsUsedByList GET /core/applications/{slug}/used_by/
coreAuthenticatedSessionsDestroy DELETE /core/authenticated_sessions/{uuid}/
coreAuthenticatedSessionsList GET /core/authenticated_sessions/
coreAuthenticatedSessionsRetrieve GET /core/authenticated_sessions/{uuid}/
coreAuthenticatedSessionsUsedByList GET /core/authenticated_sessions/{uuid}/used_by/
coreBrandsCreate POST /core/brands/
coreBrandsCurrentRetrieve GET /core/brands/current/
coreBrandsDestroy DELETE /core/brands/{brand_uuid}/
coreBrandsList GET /core/brands/
coreBrandsPartialUpdate PATCH /core/brands/{brand_uuid}/
coreBrandsRetrieve GET /core/brands/{brand_uuid}/
coreBrandsUpdate PUT /core/brands/{brand_uuid}/
coreBrandsUsedByList GET /core/brands/{brand_uuid}/used_by/
coreGroupsAddUserCreate POST /core/groups/{group_uuid}/add_user/
coreGroupsCreate POST /core/groups/
coreGroupsDestroy DELETE /core/groups/{group_uuid}/
coreGroupsList GET /core/groups/
coreGroupsPartialUpdate PATCH /core/groups/{group_uuid}/
coreGroupsRemoveUserCreate POST /core/groups/{group_uuid}/remove_user/
coreGroupsRetrieve GET /core/groups/{group_uuid}/
coreGroupsUpdate PUT /core/groups/{group_uuid}/
coreGroupsUsedByList GET /core/groups/{group_uuid}/used_by/
coreTokensCreate POST /core/tokens/
coreTokensDestroy DELETE /core/tokens/{identifier}/
coreTokensList GET /core/tokens/
coreTokensPartialUpdate PATCH /core/tokens/{identifier}/
coreTokensRetrieve GET /core/tokens/{identifier}/
coreTokensSetKeyCreate POST /core/tokens/{identifier}/set_key/
coreTokensUpdate PUT /core/tokens/{identifier}/
coreTokensUsedByList GET /core/tokens/{identifier}/used_by/
coreTokensViewKeyRetrieve GET /core/tokens/{identifier}/view_key/
coreTransactionalApplicationsUpdate PUT /core/transactional/applications/
coreUserConsentDestroy DELETE /core/user_consent/{id}/
coreUserConsentList GET /core/user_consent/
coreUserConsentRetrieve GET /core/user_consent/{id}/
coreUserConsentUsedByList GET /core/user_consent/{id}/used_by/
coreUsersCreate POST /core/users/
coreUsersDestroy DELETE /core/users/{id}/
coreUsersImpersonateCreate POST /core/users/{id}/impersonate/
coreUsersImpersonateEndRetrieve GET /core/users/impersonate_end/
coreUsersList GET /core/users/
coreUsersMeRetrieve GET /core/users/me/
coreUsersMetricsRetrieve GET /core/users/{id}/metrics/
coreUsersPartialUpdate PATCH /core/users/{id}/
coreUsersPathsRetrieve GET /core/users/paths/
coreUsersRecoveryEmailRetrieve GET /core/users/{id}/recovery_email/
coreUsersRecoveryRetrieve GET /core/users/{id}/recovery/
coreUsersRetrieve GET /core/users/{id}/
coreUsersServiceAccountCreate POST /core/users/service_account/
coreUsersSetPasswordCreate POST /core/users/{id}/set_password/
coreUsersUpdate PUT /core/users/{id}/
coreUsersUsedByList GET /core/users/{id}/used_by/

coreApplicationsCheckAccessRetrieve

    open class func coreApplicationsCheckAccessRetrieve(slug: String, forUser: Int? = nil, completion: @escaping (_ data: PolicyTestResult?, _ error: Error?) -> Void)

Check access to a single application by slug

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 slug = "slug_example" // String | 
let forUser = 987 // Int |  (optional)

CoreAPI.coreApplicationsCheckAccessRetrieve(slug: slug, forUser: forUser) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String
forUser Int [optional]

Return type

PolicyTestResult

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]

coreApplicationsCreate

    open class func coreApplicationsCreate(applicationRequest: ApplicationRequest, completion: @escaping (_ data: Application?, _ error: Error?) -> Void)

Application 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 applicationRequest = ApplicationRequest(name: "name_example", slug: "slug_example", provider: 123, backchannelProviders: [123], openInNewTab: false, metaLaunchUrl: "metaLaunchUrl_example", metaDescription: "metaDescription_example", metaPublisher: "metaPublisher_example", policyEngineMode: PolicyEngineMode(), group: "group_example") // ApplicationRequest | 

CoreAPI.coreApplicationsCreate(applicationRequest: applicationRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
applicationRequest ApplicationRequest

Return type

Application

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]

coreApplicationsDestroy

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

Application 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 slug = "slug_example" // String | 

CoreAPI.coreApplicationsDestroy(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String

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]

coreApplicationsList

    open class func coreApplicationsList(forUser: Int? = nil, group: String? = nil, metaDescription: String? = nil, metaLaunchUrl: String? = nil, metaPublisher: String? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, slug: String? = nil, superuserFullList: Bool? = nil, completion: @escaping (_ data: PaginatedApplicationList?, _ error: Error?) -> Void)

Custom list method that checks Policy based access instead of guardian

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 forUser = 987 // Int |  (optional)
let group = "group_example" // String |  (optional)
let metaDescription = "metaDescription_example" // String |  (optional)
let metaLaunchUrl = "metaLaunchUrl_example" // String |  (optional)
let metaPublisher = "metaPublisher_example" // String |  (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 slug = "slug_example" // String |  (optional)
let superuserFullList = true // Bool |  (optional)

CoreAPI.coreApplicationsList(forUser: forUser, group: group, metaDescription: metaDescription, metaLaunchUrl: metaLaunchUrl, metaPublisher: metaPublisher, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, slug: slug, superuserFullList: superuserFullList) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
forUser Int [optional]
group String [optional]
metaDescription String [optional]
metaLaunchUrl String [optional]
metaPublisher String [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]
slug String [optional]
superuserFullList Bool [optional]

Return type

PaginatedApplicationList

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]

coreApplicationsMetricsList

    open class func coreApplicationsMetricsList(slug: String, completion: @escaping (_ data: [Coordinate]?, _ error: Error?) -> Void)

Metrics for application logins

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 slug = "slug_example" // String | 

CoreAPI.coreApplicationsMetricsList(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String

Return type

[Coordinate]

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]

coreApplicationsPartialUpdate

    open class func coreApplicationsPartialUpdate(slug: String, patchedApplicationRequest: PatchedApplicationRequest? = nil, completion: @escaping (_ data: Application?, _ error: Error?) -> Void)

Application 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 slug = "slug_example" // String | 
let patchedApplicationRequest = PatchedApplicationRequest(name: "name_example", slug: "slug_example", provider: 123, backchannelProviders: [123], openInNewTab: false, metaLaunchUrl: "metaLaunchUrl_example", metaDescription: "metaDescription_example", metaPublisher: "metaPublisher_example", policyEngineMode: PolicyEngineMode(), group: "group_example") // PatchedApplicationRequest |  (optional)

CoreAPI.coreApplicationsPartialUpdate(slug: slug, patchedApplicationRequest: patchedApplicationRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String
patchedApplicationRequest PatchedApplicationRequest [optional]

Return type

Application

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]

coreApplicationsRetrieve

    open class func coreApplicationsRetrieve(slug: String, completion: @escaping (_ data: Application?, _ error: Error?) -> Void)

Application 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 slug = "slug_example" // String | 

CoreAPI.coreApplicationsRetrieve(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String

Return type

Application

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]

coreApplicationsSetIconCreate

    open class func coreApplicationsSetIconCreate(slug: String, file: URL? = nil, clear: Bool? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Set application icon

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 slug = "slug_example" // String | 
let file = URL(string: "https://example.com")! // URL |  (optional)
let clear = true // Bool |  (optional) (default to false)

CoreAPI.coreApplicationsSetIconCreate(slug: slug, file: file, clear: clear) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String
file URL [optional]
clear Bool [optional] [default to false]

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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

coreApplicationsSetIconUrlCreate

    open class func coreApplicationsSetIconUrlCreate(slug: String, filePathRequest: FilePathRequest, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Set application icon (as URL)

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 slug = "slug_example" // String | 
let filePathRequest = FilePathRequest(url: "url_example") // FilePathRequest | 

CoreAPI.coreApplicationsSetIconUrlCreate(slug: slug, filePathRequest: filePathRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String
filePathRequest FilePathRequest

Return type

Void (empty response body)

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]

coreApplicationsUpdate

    open class func coreApplicationsUpdate(slug: String, applicationRequest: ApplicationRequest, completion: @escaping (_ data: Application?, _ error: Error?) -> Void)

Application 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 slug = "slug_example" // String | 
let applicationRequest = ApplicationRequest(name: "name_example", slug: "slug_example", provider: 123, backchannelProviders: [123], openInNewTab: false, metaLaunchUrl: "metaLaunchUrl_example", metaDescription: "metaDescription_example", metaPublisher: "metaPublisher_example", policyEngineMode: PolicyEngineMode(), group: "group_example") // ApplicationRequest | 

CoreAPI.coreApplicationsUpdate(slug: slug, applicationRequest: applicationRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String
applicationRequest ApplicationRequest

Return type

Application

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]

coreApplicationsUsedByList

    open class func coreApplicationsUsedByList(slug: String, 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 slug = "slug_example" // String | 

CoreAPI.coreApplicationsUsedByList(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
slug String

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]

coreAuthenticatedSessionsDestroy

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

AuthenticatedSession 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 Authenticated Session.

CoreAPI.coreAuthenticatedSessionsDestroy(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 Authenticated Session.

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]

coreAuthenticatedSessionsList

    open class func coreAuthenticatedSessionsList(lastIp: String? = nil, lastUserAgent: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, userUsername: String? = nil, completion: @escaping (_ data: PaginatedAuthenticatedSessionList?, _ error: Error?) -> Void)

AuthenticatedSession 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 lastIp = "lastIp_example" // String |  (optional)
let lastUserAgent = "lastUserAgent_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 userUsername = "userUsername_example" // String |  (optional)

CoreAPI.coreAuthenticatedSessionsList(lastIp: lastIp, lastUserAgent: lastUserAgent, ordering: ordering, page: page, pageSize: pageSize, search: search, userUsername: userUsername) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
lastIp String [optional]
lastUserAgent 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]
userUsername String [optional]

Return type

PaginatedAuthenticatedSessionList

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]

coreAuthenticatedSessionsRetrieve

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

AuthenticatedSession 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 Authenticated Session.

CoreAPI.coreAuthenticatedSessionsRetrieve(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 Authenticated Session.

Return type

AuthenticatedSession

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]

coreAuthenticatedSessionsUsedByList

    open class func coreAuthenticatedSessionsUsedByList(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 Authenticated Session.

CoreAPI.coreAuthenticatedSessionsUsedByList(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 Authenticated Session.

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]

coreBrandsCreate

    open class func coreBrandsCreate(brandRequest: BrandRequest, completion: @escaping (_ data: Brand?, _ error: Error?) -> Void)

Brand 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 brandRequest = BrandRequest(domain: "domain_example", _default: false, brandingTitle: "brandingTitle_example", brandingLogo: "brandingLogo_example", brandingFavicon: "brandingFavicon_example", flowAuthentication: 123, flowInvalidation: 123, flowRecovery: 123, flowUnenrollment: 123, flowUserSettings: 123, flowDeviceCode: 123, webCertificate: 123, attributes: "TODO") // BrandRequest | 

CoreAPI.coreBrandsCreate(brandRequest: brandRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandRequest BrandRequest

Return type

Brand

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]

coreBrandsCurrentRetrieve

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

Get current brand

Example

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


CoreAPI.coreBrandsCurrentRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

CurrentBrand

Authorization

authentik, mobile_device_token

HTTP request headers

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

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

coreBrandsDestroy

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

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

CoreAPI.coreBrandsDestroy(brandUuid: brandUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandUuid UUID A UUID string identifying this Brand.

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]

coreBrandsList

    open class func coreBrandsList(brandUuid: UUID? = nil, brandingFavicon: String? = nil, brandingLogo: String? = nil, brandingTitle: String? = nil, _default: Bool? = nil, domain: String? = nil, flowAuthentication: UUID? = nil, flowDeviceCode: UUID? = nil, flowInvalidation: UUID? = nil, flowRecovery: UUID? = nil, flowUnenrollment: UUID? = nil, flowUserSettings: UUID? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, webCertificate: UUID? = nil, completion: @escaping (_ data: PaginatedBrandList?, _ error: Error?) -> Void)

Brand 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 brandUuid = 987 // UUID |  (optional)
let brandingFavicon = "brandingFavicon_example" // String |  (optional)
let brandingLogo = "brandingLogo_example" // String |  (optional)
let brandingTitle = "brandingTitle_example" // String |  (optional)
let _default = true // Bool |  (optional)
let domain = "domain_example" // String |  (optional)
let flowAuthentication = 987 // UUID |  (optional)
let flowDeviceCode = 987 // UUID |  (optional)
let flowInvalidation = 987 // UUID |  (optional)
let flowRecovery = 987 // UUID |  (optional)
let flowUnenrollment = 987 // UUID |  (optional)
let flowUserSettings = 987 // UUID |  (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 webCertificate = 987 // UUID |  (optional)

CoreAPI.coreBrandsList(brandUuid: brandUuid, brandingFavicon: brandingFavicon, brandingLogo: brandingLogo, brandingTitle: brandingTitle, _default: _default, domain: domain, flowAuthentication: flowAuthentication, flowDeviceCode: flowDeviceCode, flowInvalidation: flowInvalidation, flowRecovery: flowRecovery, flowUnenrollment: flowUnenrollment, flowUserSettings: flowUserSettings, ordering: ordering, page: page, pageSize: pageSize, search: search, webCertificate: webCertificate) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandUuid UUID [optional]
brandingFavicon String [optional]
brandingLogo String [optional]
brandingTitle String [optional]
_default Bool [optional]
domain String [optional]
flowAuthentication UUID [optional]
flowDeviceCode UUID [optional]
flowInvalidation UUID [optional]
flowRecovery UUID [optional]
flowUnenrollment UUID [optional]
flowUserSettings UUID [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]
webCertificate UUID [optional]

Return type

PaginatedBrandList

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]

coreBrandsPartialUpdate

    open class func coreBrandsPartialUpdate(brandUuid: UUID, patchedBrandRequest: PatchedBrandRequest? = nil, completion: @escaping (_ data: Brand?, _ error: Error?) -> Void)

Brand 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 brandUuid = 987 // UUID | A UUID string identifying this Brand.
let patchedBrandRequest = PatchedBrandRequest(domain: "domain_example", _default: false, brandingTitle: "brandingTitle_example", brandingLogo: "brandingLogo_example", brandingFavicon: "brandingFavicon_example", flowAuthentication: 123, flowInvalidation: 123, flowRecovery: 123, flowUnenrollment: 123, flowUserSettings: 123, flowDeviceCode: 123, webCertificate: 123, attributes: "TODO") // PatchedBrandRequest |  (optional)

CoreAPI.coreBrandsPartialUpdate(brandUuid: brandUuid, patchedBrandRequest: patchedBrandRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandUuid UUID A UUID string identifying this Brand.
patchedBrandRequest PatchedBrandRequest [optional]

Return type

Brand

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]

coreBrandsRetrieve

    open class func coreBrandsRetrieve(brandUuid: UUID, completion: @escaping (_ data: Brand?, _ error: Error?) -> Void)

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

CoreAPI.coreBrandsRetrieve(brandUuid: brandUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandUuid UUID A UUID string identifying this Brand.

Return type

Brand

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]

coreBrandsUpdate

    open class func coreBrandsUpdate(brandUuid: UUID, brandRequest: BrandRequest, completion: @escaping (_ data: Brand?, _ error: Error?) -> Void)

Brand 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 brandUuid = 987 // UUID | A UUID string identifying this Brand.
let brandRequest = BrandRequest(domain: "domain_example", _default: false, brandingTitle: "brandingTitle_example", brandingLogo: "brandingLogo_example", brandingFavicon: "brandingFavicon_example", flowAuthentication: 123, flowInvalidation: 123, flowRecovery: 123, flowUnenrollment: 123, flowUserSettings: 123, flowDeviceCode: 123, webCertificate: 123, attributes: "TODO") // BrandRequest | 

CoreAPI.coreBrandsUpdate(brandUuid: brandUuid, brandRequest: brandRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandUuid UUID A UUID string identifying this Brand.
brandRequest BrandRequest

Return type

Brand

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]

coreBrandsUsedByList

    open class func coreBrandsUsedByList(brandUuid: 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 brandUuid = 987 // UUID | A UUID string identifying this Brand.

CoreAPI.coreBrandsUsedByList(brandUuid: brandUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
brandUuid UUID A UUID string identifying this Brand.

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]

coreGroupsAddUserCreate

    open class func coreGroupsAddUserCreate(groupUuid: UUID, userAccountRequest: UserAccountRequest, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Add user to group

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 groupUuid = 987 // UUID | A UUID string identifying this Group.
let userAccountRequest = UserAccountRequest(pk: 123) // UserAccountRequest | 

CoreAPI.coreGroupsAddUserCreate(groupUuid: groupUuid, userAccountRequest: userAccountRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.
userAccountRequest UserAccountRequest

Return type

Void (empty response body)

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]

coreGroupsCreate

    open class func coreGroupsCreate(groupRequest: GroupRequest, completion: @escaping (_ data: Group?, _ error: Error?) -> Void)

Group 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 groupRequest = GroupRequest(name: "name_example", isSuperuser: false, parent: 123, users: [123], attributes: "TODO", roles: [123]) // GroupRequest | 

CoreAPI.coreGroupsCreate(groupRequest: groupRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupRequest GroupRequest

Return type

Group

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]

coreGroupsDestroy

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

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

CoreAPI.coreGroupsDestroy(groupUuid: groupUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.

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]

coreGroupsList

    open class func coreGroupsList(attributes: String? = nil, isSuperuser: Bool? = nil, membersByPk: [Int]? = nil, membersByUsername: [String]? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedGroupList?, _ error: Error?) -> Void)

Group 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 attributes = "attributes_example" // String | Attributes (optional)
let isSuperuser = true // Bool |  (optional)
let membersByPk = [123] // [Int] |  (optional)
let membersByUsername = ["inner_example"] // [String] | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (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)

CoreAPI.coreGroupsList(attributes: attributes, isSuperuser: isSuperuser, membersByPk: membersByPk, membersByUsername: membersByUsername, 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
attributes String Attributes [optional]
isSuperuser Bool [optional]
membersByPk [Int] [optional]
membersByUsername [String] Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. [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

PaginatedGroupList

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]

coreGroupsPartialUpdate

    open class func coreGroupsPartialUpdate(groupUuid: UUID, patchedGroupRequest: PatchedGroupRequest? = nil, completion: @escaping (_ data: Group?, _ error: Error?) -> Void)

Group 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 groupUuid = 987 // UUID | A UUID string identifying this Group.
let patchedGroupRequest = PatchedGroupRequest(name: "name_example", isSuperuser: false, parent: 123, users: [123], attributes: "TODO", roles: [123]) // PatchedGroupRequest |  (optional)

CoreAPI.coreGroupsPartialUpdate(groupUuid: groupUuid, patchedGroupRequest: patchedGroupRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.
patchedGroupRequest PatchedGroupRequest [optional]

Return type

Group

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]

coreGroupsRemoveUserCreate

    open class func coreGroupsRemoveUserCreate(groupUuid: UUID, userAccountRequest: UserAccountRequest, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Add user to group

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 groupUuid = 987 // UUID | A UUID string identifying this Group.
let userAccountRequest = UserAccountRequest(pk: 123) // UserAccountRequest | 

CoreAPI.coreGroupsRemoveUserCreate(groupUuid: groupUuid, userAccountRequest: userAccountRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.
userAccountRequest UserAccountRequest

Return type

Void (empty response body)

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]

coreGroupsRetrieve

    open class func coreGroupsRetrieve(groupUuid: UUID, completion: @escaping (_ data: Group?, _ error: Error?) -> Void)

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

CoreAPI.coreGroupsRetrieve(groupUuid: groupUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.

Return type

Group

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]

coreGroupsUpdate

    open class func coreGroupsUpdate(groupUuid: UUID, groupRequest: GroupRequest, completion: @escaping (_ data: Group?, _ error: Error?) -> Void)

Group 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 groupUuid = 987 // UUID | A UUID string identifying this Group.
let groupRequest = GroupRequest(name: "name_example", isSuperuser: false, parent: 123, users: [123], attributes: "TODO", roles: [123]) // GroupRequest | 

CoreAPI.coreGroupsUpdate(groupUuid: groupUuid, groupRequest: groupRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.
groupRequest GroupRequest

Return type

Group

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]

coreGroupsUsedByList

    open class func coreGroupsUsedByList(groupUuid: 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 groupUuid = 987 // UUID | A UUID string identifying this Group.

CoreAPI.coreGroupsUsedByList(groupUuid: groupUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupUuid UUID A UUID string identifying this Group.

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]

coreTokensCreate

    open class func coreTokensCreate(tokenRequest: TokenRequest, completion: @escaping (_ data: Token?, _ error: Error?) -> Void)

Token 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 tokenRequest = TokenRequest(managed: "managed_example", identifier: "identifier_example", intent: IntentEnum(), user: 123, description: "description_example", expires: Date(), expiring: false) // TokenRequest | 

CoreAPI.coreTokensCreate(tokenRequest: tokenRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
tokenRequest TokenRequest

Return type

Token

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]

coreTokensDestroy

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

Token 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 identifier = "identifier_example" // String | 

CoreAPI.coreTokensDestroy(identifier: identifier) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String

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]

coreTokensList

    open class func coreTokensList(description: String? = nil, expires: Date? = nil, expiring: Bool? = nil, identifier: String? = nil, intent: Intent_coreTokensList? = nil, managed: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, userUsername: String? = nil, completion: @escaping (_ data: PaginatedTokenList?, _ error: Error?) -> Void)

Token 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 description = "description_example" // String |  (optional)
let expires = Date() // Date |  (optional)
let expiring = true // Bool |  (optional)
let identifier = "identifier_example" // String |  (optional)
let intent = "intent_example" // String | * `verification` - Intent Verification * `api` - Intent Api * `recovery` - Intent Recovery * `app_password` - Intent App Password (optional)
let managed = "managed_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 userUsername = "userUsername_example" // String |  (optional)

CoreAPI.coreTokensList(description: description, expires: expires, expiring: expiring, identifier: identifier, intent: intent, managed: managed, ordering: ordering, page: page, pageSize: pageSize, search: search, userUsername: userUsername) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
description String [optional]
expires Date [optional]
expiring Bool [optional]
identifier String [optional]
intent String * `verification` - Intent Verification * `api` - Intent Api * `recovery` - Intent Recovery * `app_password` - Intent App Password [optional]
managed 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]
userUsername String [optional]

Return type

PaginatedTokenList

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]

coreTokensPartialUpdate

    open class func coreTokensPartialUpdate(identifier: String, patchedTokenRequest: PatchedTokenRequest? = nil, completion: @escaping (_ data: Token?, _ error: Error?) -> Void)

Token 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 identifier = "identifier_example" // String | 
let patchedTokenRequest = PatchedTokenRequest(managed: "managed_example", identifier: "identifier_example", intent: IntentEnum(), user: 123, description: "description_example", expires: Date(), expiring: false) // PatchedTokenRequest |  (optional)

CoreAPI.coreTokensPartialUpdate(identifier: identifier, patchedTokenRequest: patchedTokenRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String
patchedTokenRequest PatchedTokenRequest [optional]

Return type

Token

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]

coreTokensRetrieve

    open class func coreTokensRetrieve(identifier: String, completion: @escaping (_ data: Token?, _ error: Error?) -> Void)

Token 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 identifier = "identifier_example" // String | 

CoreAPI.coreTokensRetrieve(identifier: identifier) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String

Return type

Token

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]

coreTokensSetKeyCreate

    open class func coreTokensSetKeyCreate(identifier: String, tokenSetKeyRequest: TokenSetKeyRequest, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Set token key. Action is logged as event. authentik_core.set_token_key permission is required.

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 identifier = "identifier_example" // String | 
let tokenSetKeyRequest = TokenSetKeyRequest(key: "key_example") // TokenSetKeyRequest | 

CoreAPI.coreTokensSetKeyCreate(identifier: identifier, tokenSetKeyRequest: tokenSetKeyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String
tokenSetKeyRequest TokenSetKeyRequest

Return type

Void (empty response body)

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]

coreTokensUpdate

    open class func coreTokensUpdate(identifier: String, tokenRequest: TokenRequest, completion: @escaping (_ data: Token?, _ error: Error?) -> Void)

Token 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 identifier = "identifier_example" // String | 
let tokenRequest = TokenRequest(managed: "managed_example", identifier: "identifier_example", intent: IntentEnum(), user: 123, description: "description_example", expires: Date(), expiring: false) // TokenRequest | 

CoreAPI.coreTokensUpdate(identifier: identifier, tokenRequest: tokenRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String
tokenRequest TokenRequest

Return type

Token

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]

coreTokensUsedByList

    open class func coreTokensUsedByList(identifier: String, 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 identifier = "identifier_example" // String | 

CoreAPI.coreTokensUsedByList(identifier: identifier) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String

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]

coreTokensViewKeyRetrieve

    open class func coreTokensViewKeyRetrieve(identifier: String, completion: @escaping (_ data: TokenView?, _ error: Error?) -> Void)

Return token key and log access

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 identifier = "identifier_example" // String | 

CoreAPI.coreTokensViewKeyRetrieve(identifier: identifier) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String

Return type

TokenView

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]

coreTransactionalApplicationsUpdate

    open class func coreTransactionalApplicationsUpdate(transactionApplicationRequest: TransactionApplicationRequest, completion: @escaping (_ data: TransactionApplicationResponse?, _ error: Error?) -> Void)

Convert data into a blueprint, validate it and apply 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 transactionApplicationRequest = TransactionApplicationRequest(app: ApplicationRequest(name: "name_example", slug: "slug_example", provider: 123, backchannelProviders: [123], openInNewTab: false, metaLaunchUrl: "metaLaunchUrl_example", metaDescription: "metaDescription_example", metaPublisher: "metaPublisher_example", policyEngineMode: PolicyEngineMode(), group: "group_example"), providerModel: ProviderModelEnum(), provider: modelRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], baseDn: "baseDn_example", searchGroup: 123, certificate: 123, tlsServerName: "tlsServerName_example", uidStartNumber: 123, gidStartNumber: 123, searchMode: LDAPAPIAccessMode(), bindMode: nil, mfaSupport: false, clientType: ClientTypeEnum(), clientId: "clientId_example", clientSecret: "clientSecret_example", accessCodeValidity: "accessCodeValidity_example", accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example", includeClaimsInIdToken: false, signingKey: 123, redirectUris: "redirectUris_example", subMode: SubModeEnum(), issuerMode: IssuerModeEnum(), jwksSources: [123], internalHost: "internalHost_example", externalHost: "externalHost_example", internalHostSslValidation: false, skipPathRegex: "skipPathRegex_example", basicAuthEnabled: false, basicAuthPasswordAttribute: "basicAuthPasswordAttribute_example", basicAuthUserAttribute: "basicAuthUserAttribute_example", mode: ProxyMode(), interceptHeaderAuth: false, cookieDomain: "cookieDomain_example", settings: "TODO", connectionExpiry: "connectionExpiry_example", clientNetworks: "clientNetworks_example", sharedSecret: "sharedSecret_example", acsUrl: "acsUrl_example", audience: "audience_example", issuer: "issuer_example", assertionValidNotBefore: "assertionValidNotBefore_example", assertionValidNotOnOrAfter: "assertionValidNotOnOrAfter_example", sessionValidNotOnOrAfter: "sessionValidNotOnOrAfter_example", nameIdMapping: 123, digestAlgorithm: DigestAlgorithmEnum(), signatureAlgorithm: SignatureAlgorithmEnum(), signingKp: 123, verificationKp: 123, spBinding: SpBindingEnum(), defaultRelayState: "defaultRelayState_example", propertyMappingsGroup: [123], url: "url_example", token: "token_example", excludeUsersServiceAccount: false, filterGroup: 123)) // TransactionApplicationRequest | 

CoreAPI.coreTransactionalApplicationsUpdate(transactionApplicationRequest: transactionApplicationRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
transactionApplicationRequest TransactionApplicationRequest

Return type

TransactionApplicationResponse

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]

coreUserConsentDestroy

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

UserConsent 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 User Consent.

CoreAPI.coreUserConsentDestroy(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 User Consent.

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]

coreUserConsentList

    open class func coreUserConsentList(application: UUID? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, user: Int? = nil, completion: @escaping (_ data: PaginatedUserConsentList?, _ error: Error?) -> Void)

UserConsent 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 application = 987 // UUID |  (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 user = 987 // Int |  (optional)

CoreAPI.coreUserConsentList(application: application, ordering: ordering, page: page, pageSize: pageSize, search: search, user: user) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
application UUID [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]
user Int [optional]

Return type

PaginatedUserConsentList

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]

coreUserConsentRetrieve

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

UserConsent 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 User Consent.

CoreAPI.coreUserConsentRetrieve(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 User Consent.

Return type

UserConsent

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]

coreUserConsentUsedByList

    open class func coreUserConsentUsedByList(id: Int, 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 id = 987 // Int | A unique integer value identifying this User Consent.

CoreAPI.coreUserConsentUsedByList(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 User Consent.

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]

coreUsersCreate

    open class func coreUsersCreate(userRequest: UserRequest, completion: @escaping (_ data: User?, _ error: Error?) -> Void)

User 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 userRequest = UserRequest(username: "username_example", name: "name_example", isActive: false, lastLogin: Date(), groups: [123], email: "email_example", attributes: "TODO", path: "path_example", type: UserTypeEnum()) // UserRequest | 

CoreAPI.coreUsersCreate(userRequest: userRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
userRequest UserRequest

Return type

User

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]

coreUsersDestroy

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

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

CoreAPI.coreUsersDestroy(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 User.

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]

coreUsersImpersonateCreate

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

Impersonate a 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 id = 987 // Int | A unique integer value identifying this User.

CoreAPI.coreUsersImpersonateCreate(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 User.

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]

coreUsersImpersonateEndRetrieve

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

End Impersonation a 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


CoreAPI.coreUsersImpersonateEndRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

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]

coreUsersList

    open class func coreUsersList(attributes: String? = nil, email: String? = nil, groupsByName: [String]? = nil, groupsByPk: [UUID]? = nil, isActive: Bool? = nil, isSuperuser: Bool? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, path: String? = nil, pathStartswith: String? = nil, search: String? = nil, type: [ModelType_coreUsersList]? = nil, username: String? = nil, uuid: UUID? = nil, completion: @escaping (_ data: PaginatedUserList?, _ error: Error?) -> Void)

User 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 attributes = "attributes_example" // String | Attributes (optional)
let email = "email_example" // String |  (optional)
let groupsByName = ["inner_example"] // [String] |  (optional)
let groupsByPk = [123] // [UUID] |  (optional)
let isActive = true // Bool |  (optional)
let isSuperuser = 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 path = "path_example" // String |  (optional)
let pathStartswith = "pathStartswith_example" // String |  (optional)
let search = "search_example" // String | A search term. (optional)
let type = ["type_example"] // [String] | * `internal` - Internal * `external` - External * `service_account` - Service Account * `internal_service_account` - Internal Service Account (optional)
let username = "username_example" // String |  (optional)
let uuid = 987 // UUID |  (optional)

CoreAPI.coreUsersList(attributes: attributes, email: email, groupsByName: groupsByName, groupsByPk: groupsByPk, isActive: isActive, isSuperuser: isSuperuser, name: name, ordering: ordering, page: page, pageSize: pageSize, path: path, pathStartswith: pathStartswith, search: search, type: type, username: username, uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
attributes String Attributes [optional]
email String [optional]
groupsByName [String] [optional]
groupsByPk [UUID] [optional]
isActive Bool [optional]
isSuperuser 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]
path String [optional]
pathStartswith String [optional]
search String A search term. [optional]
type [String] * `internal` - Internal * `external` - External * `service_account` - Service Account * `internal_service_account` - Internal Service Account [optional]
username String [optional]
uuid UUID [optional]

Return type

PaginatedUserList

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]

coreUsersMeRetrieve

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

Get information about current 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


CoreAPI.coreUsersMeRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

SessionUser

Authorization

authentik, mobile_device_token

HTTP request headers

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

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

coreUsersMetricsRetrieve

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

User metrics per 1h

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

CoreAPI.coreUsersMetricsRetrieve(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 User.

Return type

UserMetrics

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]

coreUsersPartialUpdate

    open class func coreUsersPartialUpdate(id: Int, patchedUserRequest: PatchedUserRequest? = nil, completion: @escaping (_ data: User?, _ error: Error?) -> Void)

User 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 User.
let patchedUserRequest = PatchedUserRequest(username: "username_example", name: "name_example", isActive: false, lastLogin: Date(), groups: [123], email: "email_example", attributes: "TODO", path: "path_example", type: UserTypeEnum()) // PatchedUserRequest |  (optional)

CoreAPI.coreUsersPartialUpdate(id: id, patchedUserRequest: patchedUserRequest) { (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 User.
patchedUserRequest PatchedUserRequest [optional]

Return type

User

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]

coreUsersPathsRetrieve

    open class func coreUsersPathsRetrieve(search: String? = nil, completion: @escaping (_ data: UserPath?, _ error: Error?) -> Void)

Get all user paths

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 search = "search_example" // String |  (optional)

CoreAPI.coreUsersPathsRetrieve(search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
search String [optional]

Return type

UserPath

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]

coreUsersRecoveryEmailRetrieve

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

Create a temporary link that a user can use to recover their accounts

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 emailStage = "emailStage_example" // String | 
let id = 987 // Int | A unique integer value identifying this User.

CoreAPI.coreUsersRecoveryEmailRetrieve(emailStage: emailStage, id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
emailStage String
id Int A unique integer value identifying this User.

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]

coreUsersRecoveryRetrieve

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

Create a temporary link that a user can use to recover their accounts

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

CoreAPI.coreUsersRecoveryRetrieve(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 User.

Return type

Link

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]

coreUsersRetrieve

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

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

CoreAPI.coreUsersRetrieve(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 User.

Return type

User

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]

coreUsersServiceAccountCreate

    open class func coreUsersServiceAccountCreate(userServiceAccountRequest: UserServiceAccountRequest, completion: @escaping (_ data: UserServiceAccountResponse?, _ error: Error?) -> Void)

Create a new user account that is marked as a service account

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 userServiceAccountRequest = UserServiceAccountRequest(name: "name_example", createGroup: false, expiring: false, expires: Date()) // UserServiceAccountRequest | 

CoreAPI.coreUsersServiceAccountCreate(userServiceAccountRequest: userServiceAccountRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
userServiceAccountRequest UserServiceAccountRequest

Return type

UserServiceAccountResponse

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]

coreUsersSetPasswordCreate

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

Set password 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 id = 987 // Int | A unique integer value identifying this User.
let userPasswordSetRequest = UserPasswordSetRequest(password: "password_example") // UserPasswordSetRequest | 

CoreAPI.coreUsersSetPasswordCreate(id: id, userPasswordSetRequest: userPasswordSetRequest) { (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 User.
userPasswordSetRequest UserPasswordSetRequest

Return type

Void (empty response body)

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]

coreUsersUpdate

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

User 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 User.
let userRequest = UserRequest(username: "username_example", name: "name_example", isActive: false, lastLogin: Date(), groups: [123], email: "email_example", attributes: "TODO", path: "path_example", type: UserTypeEnum()) // UserRequest | 

CoreAPI.coreUsersUpdate(id: id, userRequest: userRequest) { (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 User.
userRequest UserRequest

Return type

User

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]

coreUsersUsedByList

    open class func coreUsersUsedByList(id: Int, 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 id = 987 // Int | A unique integer value identifying this User.

CoreAPI.coreUsersUsedByList(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 User.

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]