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

Latest commit

 

History

History
3266 lines (2228 loc) · 108 KB

PoliciesAPI.md

File metadata and controls

3266 lines (2228 loc) · 108 KB

PoliciesAPI

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

Method HTTP request Description
policiesAllCacheClearCreate POST /policies/all/cache_clear/
policiesAllCacheInfoRetrieve GET /policies/all/cache_info/
policiesAllDestroy DELETE /policies/all/{policy_uuid}/
policiesAllList GET /policies/all/
policiesAllRetrieve GET /policies/all/{policy_uuid}/
policiesAllTestCreate POST /policies/all/{policy_uuid}/test/
policiesAllTypesList GET /policies/all/types/
policiesAllUsedByList GET /policies/all/{policy_uuid}/used_by/
policiesBindingsCreate POST /policies/bindings/
policiesBindingsDestroy DELETE /policies/bindings/{policy_binding_uuid}/
policiesBindingsList GET /policies/bindings/
policiesBindingsPartialUpdate PATCH /policies/bindings/{policy_binding_uuid}/
policiesBindingsRetrieve GET /policies/bindings/{policy_binding_uuid}/
policiesBindingsUpdate PUT /policies/bindings/{policy_binding_uuid}/
policiesBindingsUsedByList GET /policies/bindings/{policy_binding_uuid}/used_by/
policiesDummyCreate POST /policies/dummy/
policiesDummyDestroy DELETE /policies/dummy/{policy_uuid}/
policiesDummyList GET /policies/dummy/
policiesDummyPartialUpdate PATCH /policies/dummy/{policy_uuid}/
policiesDummyRetrieve GET /policies/dummy/{policy_uuid}/
policiesDummyUpdate PUT /policies/dummy/{policy_uuid}/
policiesDummyUsedByList GET /policies/dummy/{policy_uuid}/used_by/
policiesEventMatcherCreate POST /policies/event_matcher/
policiesEventMatcherDestroy DELETE /policies/event_matcher/{policy_uuid}/
policiesEventMatcherList GET /policies/event_matcher/
policiesEventMatcherPartialUpdate PATCH /policies/event_matcher/{policy_uuid}/
policiesEventMatcherRetrieve GET /policies/event_matcher/{policy_uuid}/
policiesEventMatcherUpdate PUT /policies/event_matcher/{policy_uuid}/
policiesEventMatcherUsedByList GET /policies/event_matcher/{policy_uuid}/used_by/
policiesExpressionCreate POST /policies/expression/
policiesExpressionDestroy DELETE /policies/expression/{policy_uuid}/
policiesExpressionList GET /policies/expression/
policiesExpressionPartialUpdate PATCH /policies/expression/{policy_uuid}/
policiesExpressionRetrieve GET /policies/expression/{policy_uuid}/
policiesExpressionUpdate PUT /policies/expression/{policy_uuid}/
policiesExpressionUsedByList GET /policies/expression/{policy_uuid}/used_by/
policiesPasswordCreate POST /policies/password/
policiesPasswordDestroy DELETE /policies/password/{policy_uuid}/
policiesPasswordExpiryCreate POST /policies/password_expiry/
policiesPasswordExpiryDestroy DELETE /policies/password_expiry/{policy_uuid}/
policiesPasswordExpiryList GET /policies/password_expiry/
policiesPasswordExpiryPartialUpdate PATCH /policies/password_expiry/{policy_uuid}/
policiesPasswordExpiryRetrieve GET /policies/password_expiry/{policy_uuid}/
policiesPasswordExpiryUpdate PUT /policies/password_expiry/{policy_uuid}/
policiesPasswordExpiryUsedByList GET /policies/password_expiry/{policy_uuid}/used_by/
policiesPasswordList GET /policies/password/
policiesPasswordPartialUpdate PATCH /policies/password/{policy_uuid}/
policiesPasswordRetrieve GET /policies/password/{policy_uuid}/
policiesPasswordUpdate PUT /policies/password/{policy_uuid}/
policiesPasswordUsedByList GET /policies/password/{policy_uuid}/used_by/
policiesReputationCreate POST /policies/reputation/
policiesReputationDestroy DELETE /policies/reputation/{policy_uuid}/
policiesReputationList GET /policies/reputation/
policiesReputationPartialUpdate PATCH /policies/reputation/{policy_uuid}/
policiesReputationRetrieve GET /policies/reputation/{policy_uuid}/
policiesReputationScoresDestroy DELETE /policies/reputation/scores/{reputation_uuid}/
policiesReputationScoresList GET /policies/reputation/scores/
policiesReputationScoresRetrieve GET /policies/reputation/scores/{reputation_uuid}/
policiesReputationScoresUsedByList GET /policies/reputation/scores/{reputation_uuid}/used_by/
policiesReputationUpdate PUT /policies/reputation/{policy_uuid}/
policiesReputationUsedByList GET /policies/reputation/{policy_uuid}/used_by/

policiesAllCacheClearCreate

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

Clear policy cache

Example

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


PoliciesAPI.policiesAllCacheClearCreate() { (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]

policiesAllCacheInfoRetrieve

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

Info about cached policies

Example

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


PoliciesAPI.policiesAllCacheInfoRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Cache

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]

policiesAllDestroy

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

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

PoliciesAPI.policiesAllDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Policy.

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]

policiesAllList

    open class func policiesAllList(bindingsIsnull: Bool? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, promptstageIsnull: Bool? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedPolicyList?, _ error: Error?) -> Void)

Policy 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 bindingsIsnull = true // Bool |  (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 promptstageIsnull = true // Bool |  (optional)
let search = "search_example" // String | A search term. (optional)

PoliciesAPI.policiesAllList(bindingsIsnull: bindingsIsnull, ordering: ordering, page: page, pageSize: pageSize, promptstageIsnull: promptstageIsnull, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
bindingsIsnull Bool [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]
promptstageIsnull Bool [optional]
search String A search term. [optional]

Return type

PaginatedPolicyList

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]

policiesAllRetrieve

    open class func policiesAllRetrieve(policyUuid: UUID, completion: @escaping (_ data: Policy?, _ error: Error?) -> Void)

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

PoliciesAPI.policiesAllRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Policy.

Return type

Policy

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]

policiesAllTestCreate

    open class func policiesAllTestCreate(policyUuid: UUID, policyTestRequest: PolicyTestRequest, completion: @escaping (_ data: PolicyTestResult?, _ error: Error?) -> Void)

Test policy

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 policyUuid = 987 // UUID | A UUID string identifying this Policy.
let policyTestRequest = PolicyTestRequest(user: 123, context: "TODO") // PolicyTestRequest | 

PoliciesAPI.policiesAllTestCreate(policyUuid: policyUuid, policyTestRequest: policyTestRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Policy.
policyTestRequest PolicyTestRequest

Return type

PolicyTestResult

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]

policiesAllTypesList

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

Get all creatable policy types

Example

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


PoliciesAPI.policiesAllTypesList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[TypeCreate]

Authorization

authentik

HTTP request headers

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

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

policiesAllUsedByList

    open class func policiesAllUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Policy.

PoliciesAPI.policiesAllUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Policy.

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]

policiesBindingsCreate

    open class func policiesBindingsCreate(policyBindingRequest: PolicyBindingRequest, completion: @escaping (_ data: PolicyBinding?, _ error: Error?) -> Void)

PolicyBinding 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 policyBindingRequest = PolicyBindingRequest(policy: 123, group: 123, user: 123, target: 123, negate: false, enabled: false, order: 123, timeout: 123, failureResult: false) // PolicyBindingRequest | 

PoliciesAPI.policiesBindingsCreate(policyBindingRequest: policyBindingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyBindingRequest PolicyBindingRequest

Return type

PolicyBinding

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]

policiesBindingsDestroy

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

PolicyBinding 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 policyBindingUuid = 987 // UUID | A UUID string identifying this Policy Binding.

PoliciesAPI.policiesBindingsDestroy(policyBindingUuid: policyBindingUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyBindingUuid UUID A UUID string identifying this Policy Binding.

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]

policiesBindingsList

    open class func policiesBindingsList(enabled: Bool? = nil, order: Int? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, policy: UUID? = nil, policyIsnull: Bool? = nil, search: String? = nil, target: UUID? = nil, targetIn: [UUID]? = nil, timeout: Int? = nil, completion: @escaping (_ data: PaginatedPolicyBindingList?, _ error: Error?) -> Void)

PolicyBinding 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 enabled = true // Bool |  (optional)
let order = 987 // Int |  (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 policy = 987 // UUID |  (optional)
let policyIsnull = true // Bool |  (optional)
let search = "search_example" // String | A search term. (optional)
let target = 987 // UUID |  (optional)
let targetIn = [123] // [UUID] |  (optional)
let timeout = 987 // Int |  (optional)

PoliciesAPI.policiesBindingsList(enabled: enabled, order: order, ordering: ordering, page: page, pageSize: pageSize, policy: policy, policyIsnull: policyIsnull, search: search, target: target, targetIn: targetIn, timeout: timeout) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
enabled Bool [optional]
order Int [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]
policy UUID [optional]
policyIsnull Bool [optional]
search String A search term. [optional]
target UUID [optional]
targetIn [UUID] [optional]
timeout Int [optional]

Return type

PaginatedPolicyBindingList

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]

policiesBindingsPartialUpdate

    open class func policiesBindingsPartialUpdate(policyBindingUuid: UUID, patchedPolicyBindingRequest: PatchedPolicyBindingRequest? = nil, completion: @escaping (_ data: PolicyBinding?, _ error: Error?) -> Void)

PolicyBinding 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 policyBindingUuid = 987 // UUID | A UUID string identifying this Policy Binding.
let patchedPolicyBindingRequest = PatchedPolicyBindingRequest(policy: 123, group: 123, user: 123, target: 123, negate: false, enabled: false, order: 123, timeout: 123, failureResult: false) // PatchedPolicyBindingRequest |  (optional)

PoliciesAPI.policiesBindingsPartialUpdate(policyBindingUuid: policyBindingUuid, patchedPolicyBindingRequest: patchedPolicyBindingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyBindingUuid UUID A UUID string identifying this Policy Binding.
patchedPolicyBindingRequest PatchedPolicyBindingRequest [optional]

Return type

PolicyBinding

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]

policiesBindingsRetrieve

    open class func policiesBindingsRetrieve(policyBindingUuid: UUID, completion: @escaping (_ data: PolicyBinding?, _ error: Error?) -> Void)

PolicyBinding 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 policyBindingUuid = 987 // UUID | A UUID string identifying this Policy Binding.

PoliciesAPI.policiesBindingsRetrieve(policyBindingUuid: policyBindingUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyBindingUuid UUID A UUID string identifying this Policy Binding.

Return type

PolicyBinding

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]

policiesBindingsUpdate

    open class func policiesBindingsUpdate(policyBindingUuid: UUID, policyBindingRequest: PolicyBindingRequest, completion: @escaping (_ data: PolicyBinding?, _ error: Error?) -> Void)

PolicyBinding 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 policyBindingUuid = 987 // UUID | A UUID string identifying this Policy Binding.
let policyBindingRequest = PolicyBindingRequest(policy: 123, group: 123, user: 123, target: 123, negate: false, enabled: false, order: 123, timeout: 123, failureResult: false) // PolicyBindingRequest | 

PoliciesAPI.policiesBindingsUpdate(policyBindingUuid: policyBindingUuid, policyBindingRequest: policyBindingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyBindingUuid UUID A UUID string identifying this Policy Binding.
policyBindingRequest PolicyBindingRequest

Return type

PolicyBinding

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]

policiesBindingsUsedByList

    open class func policiesBindingsUsedByList(policyBindingUuid: 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 policyBindingUuid = 987 // UUID | A UUID string identifying this Policy Binding.

PoliciesAPI.policiesBindingsUsedByList(policyBindingUuid: policyBindingUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyBindingUuid UUID A UUID string identifying this Policy Binding.

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]

policiesDummyCreate

    open class func policiesDummyCreate(dummyPolicyRequest: DummyPolicyRequest, completion: @escaping (_ data: DummyPolicy?, _ error: Error?) -> Void)

Dummy 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 dummyPolicyRequest = DummyPolicyRequest(name: "name_example", executionLogging: false, result: false, waitMin: 123, waitMax: 123) // DummyPolicyRequest | 

PoliciesAPI.policiesDummyCreate(dummyPolicyRequest: dummyPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
dummyPolicyRequest DummyPolicyRequest

Return type

DummyPolicy

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]

policiesDummyDestroy

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

Dummy 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 policyUuid = 987 // UUID | A UUID string identifying this Dummy Policy.

PoliciesAPI.policiesDummyDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Dummy Policy.

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]

policiesDummyList

    open class func policiesDummyList(created: Date? = nil, executionLogging: Bool? = nil, lastUpdated: Date? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, policyUuid: UUID? = nil, result: Bool? = nil, search: String? = nil, waitMax: Int? = nil, waitMin: Int? = nil, completion: @escaping (_ data: PaginatedDummyPolicyList?, _ error: Error?) -> Void)

Dummy 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 created = Date() // Date |  (optional)
let executionLogging = true // Bool |  (optional)
let lastUpdated = Date() // Date |  (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 policyUuid = 987 // UUID |  (optional)
let result = true // Bool |  (optional)
let search = "search_example" // String | A search term. (optional)
let waitMax = 987 // Int |  (optional)
let waitMin = 987 // Int |  (optional)

PoliciesAPI.policiesDummyList(created: created, executionLogging: executionLogging, lastUpdated: lastUpdated, name: name, ordering: ordering, page: page, pageSize: pageSize, policyUuid: policyUuid, result: result, search: search, waitMax: waitMax, waitMin: waitMin) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
created Date [optional]
executionLogging Bool [optional]
lastUpdated Date [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]
policyUuid UUID [optional]
result Bool [optional]
search String A search term. [optional]
waitMax Int [optional]
waitMin Int [optional]

Return type

PaginatedDummyPolicyList

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]

policiesDummyPartialUpdate

    open class func policiesDummyPartialUpdate(policyUuid: UUID, patchedDummyPolicyRequest: PatchedDummyPolicyRequest? = nil, completion: @escaping (_ data: DummyPolicy?, _ error: Error?) -> Void)

Dummy 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 policyUuid = 987 // UUID | A UUID string identifying this Dummy Policy.
let patchedDummyPolicyRequest = PatchedDummyPolicyRequest(name: "name_example", executionLogging: false, result: false, waitMin: 123, waitMax: 123) // PatchedDummyPolicyRequest |  (optional)

PoliciesAPI.policiesDummyPartialUpdate(policyUuid: policyUuid, patchedDummyPolicyRequest: patchedDummyPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Dummy Policy.
patchedDummyPolicyRequest PatchedDummyPolicyRequest [optional]

Return type

DummyPolicy

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]

policiesDummyRetrieve

    open class func policiesDummyRetrieve(policyUuid: UUID, completion: @escaping (_ data: DummyPolicy?, _ error: Error?) -> Void)

Dummy 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 policyUuid = 987 // UUID | A UUID string identifying this Dummy Policy.

PoliciesAPI.policiesDummyRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Dummy Policy.

Return type

DummyPolicy

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]

policiesDummyUpdate

    open class func policiesDummyUpdate(policyUuid: UUID, dummyPolicyRequest: DummyPolicyRequest, completion: @escaping (_ data: DummyPolicy?, _ error: Error?) -> Void)

Dummy 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 policyUuid = 987 // UUID | A UUID string identifying this Dummy Policy.
let dummyPolicyRequest = DummyPolicyRequest(name: "name_example", executionLogging: false, result: false, waitMin: 123, waitMax: 123) // DummyPolicyRequest | 

PoliciesAPI.policiesDummyUpdate(policyUuid: policyUuid, dummyPolicyRequest: dummyPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Dummy Policy.
dummyPolicyRequest DummyPolicyRequest

Return type

DummyPolicy

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]

policiesDummyUsedByList

    open class func policiesDummyUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Dummy Policy.

PoliciesAPI.policiesDummyUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Dummy Policy.

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]

policiesEventMatcherCreate

    open class func policiesEventMatcherCreate(eventMatcherPolicyRequest: EventMatcherPolicyRequest, completion: @escaping (_ data: EventMatcherPolicy?, _ error: Error?) -> Void)

Event Matcher Policy 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 eventMatcherPolicyRequest = EventMatcherPolicyRequest(name: "name_example", executionLogging: false, action: EventActions(), clientIp: "clientIp_example", app: AppEnum(), model: ModelEnum()) // EventMatcherPolicyRequest | 

PoliciesAPI.policiesEventMatcherCreate(eventMatcherPolicyRequest: eventMatcherPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eventMatcherPolicyRequest EventMatcherPolicyRequest

Return type

EventMatcherPolicy

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]

policiesEventMatcherDestroy

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

Event Matcher Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Event Matcher Policy.

PoliciesAPI.policiesEventMatcherDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Event Matcher Policy.

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]

policiesEventMatcherList

    open class func policiesEventMatcherList(action: Action_policiesEventMatcherList? = nil, app: String? = nil, clientIp: String? = nil, created: Date? = nil, executionLogging: Bool? = nil, lastUpdated: Date? = nil, model: String? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, policyUuid: UUID? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedEventMatcherPolicyList?, _ error: Error?) -> Void)

Event Matcher Policy 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 action = "action_example" // String | Match created events with this action type. When left empty, all action types will be matched.  * `login` - Login * `login_failed` - Login Failed * `logout` - Logout * `user_write` - User Write * `suspicious_request` - Suspicious Request * `password_set` - Password Set * `secret_view` - Secret View * `secret_rotate` - Secret Rotate * `invitation_used` - Invite Used * `authorize_application` - Authorize Application * `source_linked` - Source Linked * `impersonation_started` - Impersonation Started * `impersonation_ended` - Impersonation Ended * `flow_execution` - Flow Execution * `policy_execution` - Policy Execution * `policy_exception` - Policy Exception * `property_mapping_exception` - Property Mapping Exception * `system_task_execution` - System Task Execution * `system_task_exception` - System Task Exception * `system_exception` - System Exception * `configuration_error` - Configuration Error * `model_created` - Model Created * `model_updated` - Model Updated * `model_deleted` - Model Deleted * `email_sent` - Email Sent * `update_available` - Update Available * `custom_` - Custom Prefix (optional)
let app = "app_example" // String |  (optional)
let clientIp = "clientIp_example" // String |  (optional)
let created = Date() // Date |  (optional)
let executionLogging = true // Bool |  (optional)
let lastUpdated = Date() // Date |  (optional)
let model = "model_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 policyUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)

PoliciesAPI.policiesEventMatcherList(action: action, app: app, clientIp: clientIp, created: created, executionLogging: executionLogging, lastUpdated: lastUpdated, model: model, name: name, ordering: ordering, page: page, pageSize: pageSize, policyUuid: policyUuid, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
action String Match created events with this action type. When left empty, all action types will be matched. * `login` - Login * `login_failed` - Login Failed * `logout` - Logout * `user_write` - User Write * `suspicious_request` - Suspicious Request * `password_set` - Password Set * `secret_view` - Secret View * `secret_rotate` - Secret Rotate * `invitation_used` - Invite Used * `authorize_application` - Authorize Application * `source_linked` - Source Linked * `impersonation_started` - Impersonation Started * `impersonation_ended` - Impersonation Ended * `flow_execution` - Flow Execution * `policy_execution` - Policy Execution * `policy_exception` - Policy Exception * `property_mapping_exception` - Property Mapping Exception * `system_task_execution` - System Task Execution * `system_task_exception` - System Task Exception * `system_exception` - System Exception * `configuration_error` - Configuration Error * `model_created` - Model Created * `model_updated` - Model Updated * `model_deleted` - Model Deleted * `email_sent` - Email Sent * `update_available` - Update Available * `custom_` - Custom Prefix [optional]
app String [optional]
clientIp String [optional]
created Date [optional]
executionLogging Bool [optional]
lastUpdated Date [optional]
model 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]
policyUuid UUID [optional]
search String A search term. [optional]

Return type

PaginatedEventMatcherPolicyList

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]

policiesEventMatcherPartialUpdate

    open class func policiesEventMatcherPartialUpdate(policyUuid: UUID, patchedEventMatcherPolicyRequest: PatchedEventMatcherPolicyRequest? = nil, completion: @escaping (_ data: EventMatcherPolicy?, _ error: Error?) -> Void)

Event Matcher Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Event Matcher Policy.
let patchedEventMatcherPolicyRequest = PatchedEventMatcherPolicyRequest(name: "name_example", executionLogging: false, action: EventActions(), clientIp: "clientIp_example", app: AppEnum(), model: ModelEnum()) // PatchedEventMatcherPolicyRequest |  (optional)

PoliciesAPI.policiesEventMatcherPartialUpdate(policyUuid: policyUuid, patchedEventMatcherPolicyRequest: patchedEventMatcherPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Event Matcher Policy.
patchedEventMatcherPolicyRequest PatchedEventMatcherPolicyRequest [optional]

Return type

EventMatcherPolicy

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]

policiesEventMatcherRetrieve

    open class func policiesEventMatcherRetrieve(policyUuid: UUID, completion: @escaping (_ data: EventMatcherPolicy?, _ error: Error?) -> Void)

Event Matcher Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Event Matcher Policy.

PoliciesAPI.policiesEventMatcherRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Event Matcher Policy.

Return type

EventMatcherPolicy

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]

policiesEventMatcherUpdate

    open class func policiesEventMatcherUpdate(policyUuid: UUID, eventMatcherPolicyRequest: EventMatcherPolicyRequest, completion: @escaping (_ data: EventMatcherPolicy?, _ error: Error?) -> Void)

Event Matcher Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Event Matcher Policy.
let eventMatcherPolicyRequest = EventMatcherPolicyRequest(name: "name_example", executionLogging: false, action: EventActions(), clientIp: "clientIp_example", app: AppEnum(), model: ModelEnum()) // EventMatcherPolicyRequest | 

PoliciesAPI.policiesEventMatcherUpdate(policyUuid: policyUuid, eventMatcherPolicyRequest: eventMatcherPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Event Matcher Policy.
eventMatcherPolicyRequest EventMatcherPolicyRequest

Return type

EventMatcherPolicy

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]

policiesEventMatcherUsedByList

    open class func policiesEventMatcherUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Event Matcher Policy.

PoliciesAPI.policiesEventMatcherUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Event Matcher Policy.

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]

policiesExpressionCreate

    open class func policiesExpressionCreate(expressionPolicyRequest: ExpressionPolicyRequest, completion: @escaping (_ data: ExpressionPolicy?, _ error: Error?) -> Void)

Source 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 expressionPolicyRequest = ExpressionPolicyRequest(name: "name_example", executionLogging: false, expression: "expression_example") // ExpressionPolicyRequest | 

PoliciesAPI.policiesExpressionCreate(expressionPolicyRequest: expressionPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
expressionPolicyRequest ExpressionPolicyRequest

Return type

ExpressionPolicy

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]

policiesExpressionDestroy

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

Source 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 policyUuid = 987 // UUID | A UUID string identifying this Expression Policy.

PoliciesAPI.policiesExpressionDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Expression Policy.

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]

policiesExpressionList

    open class func policiesExpressionList(created: Date? = nil, executionLogging: Bool? = nil, expression: String? = nil, lastUpdated: Date? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, policyUuid: UUID? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedExpressionPolicyList?, _ error: Error?) -> Void)

Source 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 created = Date() // Date |  (optional)
let executionLogging = true // Bool |  (optional)
let expression = "expression_example" // String |  (optional)
let lastUpdated = Date() // Date |  (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 policyUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)

PoliciesAPI.policiesExpressionList(created: created, executionLogging: executionLogging, expression: expression, lastUpdated: lastUpdated, name: name, ordering: ordering, page: page, pageSize: pageSize, policyUuid: policyUuid, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
created Date [optional]
executionLogging Bool [optional]
expression String [optional]
lastUpdated Date [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]
policyUuid UUID [optional]
search String A search term. [optional]

Return type

PaginatedExpressionPolicyList

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]

policiesExpressionPartialUpdate

    open class func policiesExpressionPartialUpdate(policyUuid: UUID, patchedExpressionPolicyRequest: PatchedExpressionPolicyRequest? = nil, completion: @escaping (_ data: ExpressionPolicy?, _ error: Error?) -> Void)

Source 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 policyUuid = 987 // UUID | A UUID string identifying this Expression Policy.
let patchedExpressionPolicyRequest = PatchedExpressionPolicyRequest(name: "name_example", executionLogging: false, expression: "expression_example") // PatchedExpressionPolicyRequest |  (optional)

PoliciesAPI.policiesExpressionPartialUpdate(policyUuid: policyUuid, patchedExpressionPolicyRequest: patchedExpressionPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Expression Policy.
patchedExpressionPolicyRequest PatchedExpressionPolicyRequest [optional]

Return type

ExpressionPolicy

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]

policiesExpressionRetrieve

    open class func policiesExpressionRetrieve(policyUuid: UUID, completion: @escaping (_ data: ExpressionPolicy?, _ error: Error?) -> Void)

Source 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 policyUuid = 987 // UUID | A UUID string identifying this Expression Policy.

PoliciesAPI.policiesExpressionRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Expression Policy.

Return type

ExpressionPolicy

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]

policiesExpressionUpdate

    open class func policiesExpressionUpdate(policyUuid: UUID, expressionPolicyRequest: ExpressionPolicyRequest, completion: @escaping (_ data: ExpressionPolicy?, _ error: Error?) -> Void)

Source 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 policyUuid = 987 // UUID | A UUID string identifying this Expression Policy.
let expressionPolicyRequest = ExpressionPolicyRequest(name: "name_example", executionLogging: false, expression: "expression_example") // ExpressionPolicyRequest | 

PoliciesAPI.policiesExpressionUpdate(policyUuid: policyUuid, expressionPolicyRequest: expressionPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Expression Policy.
expressionPolicyRequest ExpressionPolicyRequest

Return type

ExpressionPolicy

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]

policiesExpressionUsedByList

    open class func policiesExpressionUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Expression Policy.

PoliciesAPI.policiesExpressionUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Expression Policy.

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]

policiesPasswordCreate

    open class func policiesPasswordCreate(passwordPolicyRequest: PasswordPolicyRequest, completion: @escaping (_ data: PasswordPolicy?, _ error: Error?) -> Void)

Password Policy 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 passwordPolicyRequest = PasswordPolicyRequest(name: "name_example", executionLogging: false, passwordField: "passwordField_example", amountDigits: 123, amountUppercase: 123, amountLowercase: 123, amountSymbols: 123, lengthMin: 123, symbolCharset: "symbolCharset_example", errorMessage: "errorMessage_example", checkStaticRules: false, checkHaveIBeenPwned: false, checkZxcvbn: false, hibpAllowedCount: 123, zxcvbnScoreThreshold: 123) // PasswordPolicyRequest | 

PoliciesAPI.policiesPasswordCreate(passwordPolicyRequest: passwordPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
passwordPolicyRequest PasswordPolicyRequest

Return type

PasswordPolicy

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]

policiesPasswordDestroy

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

Password Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Password Policy.

PoliciesAPI.policiesPasswordDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Policy.

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]

policiesPasswordExpiryCreate

    open class func policiesPasswordExpiryCreate(passwordExpiryPolicyRequest: PasswordExpiryPolicyRequest, completion: @escaping (_ data: PasswordExpiryPolicy?, _ error: Error?) -> Void)

Password Expiry 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 passwordExpiryPolicyRequest = PasswordExpiryPolicyRequest(name: "name_example", executionLogging: false, days: 123, denyOnly: false) // PasswordExpiryPolicyRequest | 

PoliciesAPI.policiesPasswordExpiryCreate(passwordExpiryPolicyRequest: passwordExpiryPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
passwordExpiryPolicyRequest PasswordExpiryPolicyRequest

Return type

PasswordExpiryPolicy

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]

policiesPasswordExpiryDestroy

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

Password Expiry 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 policyUuid = 987 // UUID | A UUID string identifying this Password Expiry Policy.

PoliciesAPI.policiesPasswordExpiryDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Expiry Policy.

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]

policiesPasswordExpiryList

    open class func policiesPasswordExpiryList(created: Date? = nil, days: Int? = nil, denyOnly: Bool? = nil, executionLogging: Bool? = nil, lastUpdated: Date? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, policyUuid: UUID? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedPasswordExpiryPolicyList?, _ error: Error?) -> Void)

Password Expiry 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 created = Date() // Date |  (optional)
let days = 987 // Int |  (optional)
let denyOnly = true // Bool |  (optional)
let executionLogging = true // Bool |  (optional)
let lastUpdated = Date() // Date |  (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 policyUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)

PoliciesAPI.policiesPasswordExpiryList(created: created, days: days, denyOnly: denyOnly, executionLogging: executionLogging, lastUpdated: lastUpdated, name: name, ordering: ordering, page: page, pageSize: pageSize, policyUuid: policyUuid, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
created Date [optional]
days Int [optional]
denyOnly Bool [optional]
executionLogging Bool [optional]
lastUpdated Date [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]
policyUuid UUID [optional]
search String A search term. [optional]

Return type

PaginatedPasswordExpiryPolicyList

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]

policiesPasswordExpiryPartialUpdate

    open class func policiesPasswordExpiryPartialUpdate(policyUuid: UUID, patchedPasswordExpiryPolicyRequest: PatchedPasswordExpiryPolicyRequest? = nil, completion: @escaping (_ data: PasswordExpiryPolicy?, _ error: Error?) -> Void)

Password Expiry 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 policyUuid = 987 // UUID | A UUID string identifying this Password Expiry Policy.
let patchedPasswordExpiryPolicyRequest = PatchedPasswordExpiryPolicyRequest(name: "name_example", executionLogging: false, days: 123, denyOnly: false) // PatchedPasswordExpiryPolicyRequest |  (optional)

PoliciesAPI.policiesPasswordExpiryPartialUpdate(policyUuid: policyUuid, patchedPasswordExpiryPolicyRequest: patchedPasswordExpiryPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Expiry Policy.
patchedPasswordExpiryPolicyRequest PatchedPasswordExpiryPolicyRequest [optional]

Return type

PasswordExpiryPolicy

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]

policiesPasswordExpiryRetrieve

    open class func policiesPasswordExpiryRetrieve(policyUuid: UUID, completion: @escaping (_ data: PasswordExpiryPolicy?, _ error: Error?) -> Void)

Password Expiry 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 policyUuid = 987 // UUID | A UUID string identifying this Password Expiry Policy.

PoliciesAPI.policiesPasswordExpiryRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Expiry Policy.

Return type

PasswordExpiryPolicy

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]

policiesPasswordExpiryUpdate

    open class func policiesPasswordExpiryUpdate(policyUuid: UUID, passwordExpiryPolicyRequest: PasswordExpiryPolicyRequest, completion: @escaping (_ data: PasswordExpiryPolicy?, _ error: Error?) -> Void)

Password Expiry 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 policyUuid = 987 // UUID | A UUID string identifying this Password Expiry Policy.
let passwordExpiryPolicyRequest = PasswordExpiryPolicyRequest(name: "name_example", executionLogging: false, days: 123, denyOnly: false) // PasswordExpiryPolicyRequest | 

PoliciesAPI.policiesPasswordExpiryUpdate(policyUuid: policyUuid, passwordExpiryPolicyRequest: passwordExpiryPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Expiry Policy.
passwordExpiryPolicyRequest PasswordExpiryPolicyRequest

Return type

PasswordExpiryPolicy

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]

policiesPasswordExpiryUsedByList

    open class func policiesPasswordExpiryUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Password Expiry Policy.

PoliciesAPI.policiesPasswordExpiryUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Expiry Policy.

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]

policiesPasswordList

    open class func policiesPasswordList(amountDigits: Int? = nil, amountLowercase: Int? = nil, amountSymbols: Int? = nil, amountUppercase: Int? = nil, checkHaveIBeenPwned: Bool? = nil, checkStaticRules: Bool? = nil, checkZxcvbn: Bool? = nil, created: Date? = nil, errorMessage: String? = nil, executionLogging: Bool? = nil, hibpAllowedCount: Int? = nil, lastUpdated: Date? = nil, lengthMin: Int? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, passwordField: String? = nil, policyUuid: UUID? = nil, search: String? = nil, symbolCharset: String? = nil, zxcvbnScoreThreshold: Int? = nil, completion: @escaping (_ data: PaginatedPasswordPolicyList?, _ error: Error?) -> Void)

Password Policy 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 amountDigits = 987 // Int |  (optional)
let amountLowercase = 987 // Int |  (optional)
let amountSymbols = 987 // Int |  (optional)
let amountUppercase = 987 // Int |  (optional)
let checkHaveIBeenPwned = true // Bool |  (optional)
let checkStaticRules = true // Bool |  (optional)
let checkZxcvbn = true // Bool |  (optional)
let created = Date() // Date |  (optional)
let errorMessage = "errorMessage_example" // String |  (optional)
let executionLogging = true // Bool |  (optional)
let hibpAllowedCount = 987 // Int |  (optional)
let lastUpdated = Date() // Date |  (optional)
let lengthMin = 987 // Int |  (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 passwordField = "passwordField_example" // String |  (optional)
let policyUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)
let symbolCharset = "symbolCharset_example" // String |  (optional)
let zxcvbnScoreThreshold = 987 // Int |  (optional)

PoliciesAPI.policiesPasswordList(amountDigits: amountDigits, amountLowercase: amountLowercase, amountSymbols: amountSymbols, amountUppercase: amountUppercase, checkHaveIBeenPwned: checkHaveIBeenPwned, checkStaticRules: checkStaticRules, checkZxcvbn: checkZxcvbn, created: created, errorMessage: errorMessage, executionLogging: executionLogging, hibpAllowedCount: hibpAllowedCount, lastUpdated: lastUpdated, lengthMin: lengthMin, name: name, ordering: ordering, page: page, pageSize: pageSize, passwordField: passwordField, policyUuid: policyUuid, search: search, symbolCharset: symbolCharset, zxcvbnScoreThreshold: zxcvbnScoreThreshold) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
amountDigits Int [optional]
amountLowercase Int [optional]
amountSymbols Int [optional]
amountUppercase Int [optional]
checkHaveIBeenPwned Bool [optional]
checkStaticRules Bool [optional]
checkZxcvbn Bool [optional]
created Date [optional]
errorMessage String [optional]
executionLogging Bool [optional]
hibpAllowedCount Int [optional]
lastUpdated Date [optional]
lengthMin Int [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]
passwordField String [optional]
policyUuid UUID [optional]
search String A search term. [optional]
symbolCharset String [optional]
zxcvbnScoreThreshold Int [optional]

Return type

PaginatedPasswordPolicyList

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]

policiesPasswordPartialUpdate

    open class func policiesPasswordPartialUpdate(policyUuid: UUID, patchedPasswordPolicyRequest: PatchedPasswordPolicyRequest? = nil, completion: @escaping (_ data: PasswordPolicy?, _ error: Error?) -> Void)

Password Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Password Policy.
let patchedPasswordPolicyRequest = PatchedPasswordPolicyRequest(name: "name_example", executionLogging: false, passwordField: "passwordField_example", amountDigits: 123, amountUppercase: 123, amountLowercase: 123, amountSymbols: 123, lengthMin: 123, symbolCharset: "symbolCharset_example", errorMessage: "errorMessage_example", checkStaticRules: false, checkHaveIBeenPwned: false, checkZxcvbn: false, hibpAllowedCount: 123, zxcvbnScoreThreshold: 123) // PatchedPasswordPolicyRequest |  (optional)

PoliciesAPI.policiesPasswordPartialUpdate(policyUuid: policyUuid, patchedPasswordPolicyRequest: patchedPasswordPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Policy.
patchedPasswordPolicyRequest PatchedPasswordPolicyRequest [optional]

Return type

PasswordPolicy

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]

policiesPasswordRetrieve

    open class func policiesPasswordRetrieve(policyUuid: UUID, completion: @escaping (_ data: PasswordPolicy?, _ error: Error?) -> Void)

Password Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Password Policy.

PoliciesAPI.policiesPasswordRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Policy.

Return type

PasswordPolicy

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]

policiesPasswordUpdate

    open class func policiesPasswordUpdate(policyUuid: UUID, passwordPolicyRequest: PasswordPolicyRequest, completion: @escaping (_ data: PasswordPolicy?, _ error: Error?) -> Void)

Password Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Password Policy.
let passwordPolicyRequest = PasswordPolicyRequest(name: "name_example", executionLogging: false, passwordField: "passwordField_example", amountDigits: 123, amountUppercase: 123, amountLowercase: 123, amountSymbols: 123, lengthMin: 123, symbolCharset: "symbolCharset_example", errorMessage: "errorMessage_example", checkStaticRules: false, checkHaveIBeenPwned: false, checkZxcvbn: false, hibpAllowedCount: 123, zxcvbnScoreThreshold: 123) // PasswordPolicyRequest | 

PoliciesAPI.policiesPasswordUpdate(policyUuid: policyUuid, passwordPolicyRequest: passwordPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Policy.
passwordPolicyRequest PasswordPolicyRequest

Return type

PasswordPolicy

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]

policiesPasswordUsedByList

    open class func policiesPasswordUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Password Policy.

PoliciesAPI.policiesPasswordUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Password Policy.

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]

policiesReputationCreate

    open class func policiesReputationCreate(reputationPolicyRequest: ReputationPolicyRequest, completion: @escaping (_ data: ReputationPolicy?, _ error: Error?) -> Void)

Reputation Policy 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 reputationPolicyRequest = ReputationPolicyRequest(name: "name_example", executionLogging: false, checkIp: false, checkUsername: false, threshold: 123) // ReputationPolicyRequest | 

PoliciesAPI.policiesReputationCreate(reputationPolicyRequest: reputationPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
reputationPolicyRequest ReputationPolicyRequest

Return type

ReputationPolicy

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]

policiesReputationDestroy

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

Reputation Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Reputation Policy.

PoliciesAPI.policiesReputationDestroy(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Reputation Policy.

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]

policiesReputationList

    open class func policiesReputationList(checkIp: Bool? = nil, checkUsername: Bool? = nil, created: Date? = nil, executionLogging: Bool? = nil, lastUpdated: Date? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, policyUuid: UUID? = nil, search: String? = nil, threshold: Int? = nil, completion: @escaping (_ data: PaginatedReputationPolicyList?, _ error: Error?) -> Void)

Reputation Policy 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 checkIp = true // Bool |  (optional)
let checkUsername = true // Bool |  (optional)
let created = Date() // Date |  (optional)
let executionLogging = true // Bool |  (optional)
let lastUpdated = Date() // Date |  (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 policyUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)
let threshold = 987 // Int |  (optional)

PoliciesAPI.policiesReputationList(checkIp: checkIp, checkUsername: checkUsername, created: created, executionLogging: executionLogging, lastUpdated: lastUpdated, name: name, ordering: ordering, page: page, pageSize: pageSize, policyUuid: policyUuid, search: search, threshold: threshold) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
checkIp Bool [optional]
checkUsername Bool [optional]
created Date [optional]
executionLogging Bool [optional]
lastUpdated Date [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]
policyUuid UUID [optional]
search String A search term. [optional]
threshold Int [optional]

Return type

PaginatedReputationPolicyList

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]

policiesReputationPartialUpdate

    open class func policiesReputationPartialUpdate(policyUuid: UUID, patchedReputationPolicyRequest: PatchedReputationPolicyRequest? = nil, completion: @escaping (_ data: ReputationPolicy?, _ error: Error?) -> Void)

Reputation Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Reputation Policy.
let patchedReputationPolicyRequest = PatchedReputationPolicyRequest(name: "name_example", executionLogging: false, checkIp: false, checkUsername: false, threshold: 123) // PatchedReputationPolicyRequest |  (optional)

PoliciesAPI.policiesReputationPartialUpdate(policyUuid: policyUuid, patchedReputationPolicyRequest: patchedReputationPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Reputation Policy.
patchedReputationPolicyRequest PatchedReputationPolicyRequest [optional]

Return type

ReputationPolicy

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]

policiesReputationRetrieve

    open class func policiesReputationRetrieve(policyUuid: UUID, completion: @escaping (_ data: ReputationPolicy?, _ error: Error?) -> Void)

Reputation Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Reputation Policy.

PoliciesAPI.policiesReputationRetrieve(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Reputation Policy.

Return type

ReputationPolicy

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]

policiesReputationScoresDestroy

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

Reputation 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 reputationUuid = 987 // UUID | A UUID string identifying this Reputation Score.

PoliciesAPI.policiesReputationScoresDestroy(reputationUuid: reputationUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
reputationUuid UUID A UUID string identifying this Reputation Score.

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]

policiesReputationScoresList

    open class func policiesReputationScoresList(identifier: String? = nil, ip: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, score: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedReputationList?, _ error: Error?) -> Void)

Reputation 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 |  (optional)
let ip = "ip_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 score = 987 // Int |  (optional)
let search = "search_example" // String | A search term. (optional)

PoliciesAPI.policiesReputationScoresList(identifier: identifier, ip: ip, ordering: ordering, page: page, pageSize: pageSize, score: score, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
identifier String [optional]
ip 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]
score Int [optional]
search String A search term. [optional]

Return type

PaginatedReputationList

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]

policiesReputationScoresRetrieve

    open class func policiesReputationScoresRetrieve(reputationUuid: UUID, completion: @escaping (_ data: Reputation?, _ error: Error?) -> Void)

Reputation 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 reputationUuid = 987 // UUID | A UUID string identifying this Reputation Score.

PoliciesAPI.policiesReputationScoresRetrieve(reputationUuid: reputationUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
reputationUuid UUID A UUID string identifying this Reputation Score.

Return type

Reputation

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]

policiesReputationScoresUsedByList

    open class func policiesReputationScoresUsedByList(reputationUuid: 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 reputationUuid = 987 // UUID | A UUID string identifying this Reputation Score.

PoliciesAPI.policiesReputationScoresUsedByList(reputationUuid: reputationUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
reputationUuid UUID A UUID string identifying this Reputation Score.

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]

policiesReputationUpdate

    open class func policiesReputationUpdate(policyUuid: UUID, reputationPolicyRequest: ReputationPolicyRequest, completion: @escaping (_ data: ReputationPolicy?, _ error: Error?) -> Void)

Reputation Policy 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 policyUuid = 987 // UUID | A UUID string identifying this Reputation Policy.
let reputationPolicyRequest = ReputationPolicyRequest(name: "name_example", executionLogging: false, checkIp: false, checkUsername: false, threshold: 123) // ReputationPolicyRequest | 

PoliciesAPI.policiesReputationUpdate(policyUuid: policyUuid, reputationPolicyRequest: reputationPolicyRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Reputation Policy.
reputationPolicyRequest ReputationPolicyRequest

Return type

ReputationPolicy

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]

policiesReputationUsedByList

    open class func policiesReputationUsedByList(policyUuid: 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 policyUuid = 987 // UUID | A UUID string identifying this Reputation Policy.

PoliciesAPI.policiesReputationUsedByList(policyUuid: policyUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
policyUuid UUID A UUID string identifying this Reputation Policy.

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]