PropertymappingsAPI.md

PropertymappingsAPI

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

Method	HTTP request	Description
propertymappingsAllDestroy	DELETE /propertymappings/all/{pm_uuid}/
propertymappingsAllList	GET /propertymappings/all/
propertymappingsAllRetrieve	GET /propertymappings/all/{pm_uuid}/
propertymappingsAllTestCreate	POST /propertymappings/all/{pm_uuid}/test/
propertymappingsAllTypesList	GET /propertymappings/all/types/
propertymappingsAllUsedByList	GET /propertymappings/all/{pm_uuid}/used_by/
propertymappingsLdapCreate	POST /propertymappings/ldap/
propertymappingsLdapDestroy	DELETE /propertymappings/ldap/{pm_uuid}/
propertymappingsLdapList	GET /propertymappings/ldap/
propertymappingsLdapPartialUpdate	PATCH /propertymappings/ldap/{pm_uuid}/
propertymappingsLdapRetrieve	GET /propertymappings/ldap/{pm_uuid}/
propertymappingsLdapUpdate	PUT /propertymappings/ldap/{pm_uuid}/
propertymappingsLdapUsedByList	GET /propertymappings/ldap/{pm_uuid}/used_by/
propertymappingsNotificationCreate	POST /propertymappings/notification/
propertymappingsNotificationDestroy	DELETE /propertymappings/notification/{pm_uuid}/
propertymappingsNotificationList	GET /propertymappings/notification/
propertymappingsNotificationPartialUpdate	PATCH /propertymappings/notification/{pm_uuid}/
propertymappingsNotificationRetrieve	GET /propertymappings/notification/{pm_uuid}/
propertymappingsNotificationUpdate	PUT /propertymappings/notification/{pm_uuid}/
propertymappingsNotificationUsedByList	GET /propertymappings/notification/{pm_uuid}/used_by/
propertymappingsRacCreate	POST /propertymappings/rac/
propertymappingsRacDestroy	DELETE /propertymappings/rac/{pm_uuid}/
propertymappingsRacList	GET /propertymappings/rac/
propertymappingsRacPartialUpdate	PATCH /propertymappings/rac/{pm_uuid}/
propertymappingsRacRetrieve	GET /propertymappings/rac/{pm_uuid}/
propertymappingsRacUpdate	PUT /propertymappings/rac/{pm_uuid}/
propertymappingsRacUsedByList	GET /propertymappings/rac/{pm_uuid}/used_by/
propertymappingsSamlCreate	POST /propertymappings/saml/
propertymappingsSamlDestroy	DELETE /propertymappings/saml/{pm_uuid}/
propertymappingsSamlList	GET /propertymappings/saml/
propertymappingsSamlPartialUpdate	PATCH /propertymappings/saml/{pm_uuid}/
propertymappingsSamlRetrieve	GET /propertymappings/saml/{pm_uuid}/
propertymappingsSamlUpdate	PUT /propertymappings/saml/{pm_uuid}/
propertymappingsSamlUsedByList	GET /propertymappings/saml/{pm_uuid}/used_by/
propertymappingsScimCreate	POST /propertymappings/scim/
propertymappingsScimDestroy	DELETE /propertymappings/scim/{pm_uuid}/
propertymappingsScimList	GET /propertymappings/scim/
propertymappingsScimPartialUpdate	PATCH /propertymappings/scim/{pm_uuid}/
propertymappingsScimRetrieve	GET /propertymappings/scim/{pm_uuid}/
propertymappingsScimUpdate	PUT /propertymappings/scim/{pm_uuid}/
propertymappingsScimUsedByList	GET /propertymappings/scim/{pm_uuid}/used_by/
propertymappingsScopeCreate	POST /propertymappings/scope/
propertymappingsScopeDestroy	DELETE /propertymappings/scope/{pm_uuid}/
propertymappingsScopeList	GET /propertymappings/scope/
propertymappingsScopePartialUpdate	PATCH /propertymappings/scope/{pm_uuid}/
propertymappingsScopeRetrieve	GET /propertymappings/scope/{pm_uuid}/
propertymappingsScopeUpdate	PUT /propertymappings/scope/{pm_uuid}/
propertymappingsScopeUsedByList	GET /propertymappings/scope/{pm_uuid}/used_by/

propertymappingsAllDestroy

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

PropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Property Mapping.

PropertymappingsAPI.propertymappingsAllDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Property Mapping.

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]

propertymappingsAllList

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

PropertyMapping 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 managedIsnull = 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 search = "search_example" // String | A search term. (optional)

PropertymappingsAPI.propertymappingsAllList(managedIsnull: managedIsnull, 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
managedIsnull	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]
search	String	A search term.	[optional]

Return type

PaginatedPropertyMappingList

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]

propertymappingsAllRetrieve

    open class func propertymappingsAllRetrieve(pmUuid: UUID, completion: @escaping (_ data: PropertyMapping?, _ error: Error?) -> Void)

PropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Property Mapping.

PropertymappingsAPI.propertymappingsAllRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Property Mapping.

Return type

PropertyMapping

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]

propertymappingsAllTestCreate

    open class func propertymappingsAllTestCreate(pmUuid: UUID, policyTestRequest: PolicyTestRequest, formatResult: Bool? = nil, completion: @escaping (_ data: PropertyMappingTestResult?, _ error: Error?) -> Void)

Test Property Mapping

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 pmUuid = 987 // UUID | A UUID string identifying this Property Mapping.
let policyTestRequest = PolicyTestRequest(user: 123, context: "TODO") // PolicyTestRequest | 
let formatResult = true // Bool |  (optional)

PropertymappingsAPI.propertymappingsAllTestCreate(pmUuid: pmUuid, policyTestRequest: policyTestRequest, formatResult: formatResult) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Property Mapping.
policyTestRequest	PolicyTestRequest
formatResult	Bool		[optional]

Return type

PropertyMappingTestResult

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]

propertymappingsAllTypesList

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

Get all creatable property-mapping 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


PropertymappingsAPI.propertymappingsAllTypesList() { (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]

propertymappingsAllUsedByList

    open class func propertymappingsAllUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this Property Mapping.

PropertymappingsAPI.propertymappingsAllUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Property Mapping.

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]

propertymappingsLdapCreate

    open class func propertymappingsLdapCreate(lDAPPropertyMappingRequest: LDAPPropertyMappingRequest, completion: @escaping (_ data: LDAPPropertyMapping?, _ error: Error?) -> Void)

LDAP PropertyMapping 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 lDAPPropertyMappingRequest = LDAPPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", objectField: "objectField_example") // LDAPPropertyMappingRequest | 

PropertymappingsAPI.propertymappingsLdapCreate(lDAPPropertyMappingRequest: lDAPPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
lDAPPropertyMappingRequest	LDAPPropertyMappingRequest

Return type

LDAPPropertyMapping

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]

propertymappingsLdapDestroy

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

LDAP PropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this LDAP Property Mapping.

PropertymappingsAPI.propertymappingsLdapDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this LDAP Property Mapping.

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]

propertymappingsLdapList

    open class func propertymappingsLdapList(expression: String? = nil, managed: [String]? = nil, name: String? = nil, objectField: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, pmUuid: UUID? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedLDAPPropertyMappingList?, _ error: Error?) -> Void)

LDAP PropertyMapping 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 expression = "expression_example" // String |  (optional)
let managed = ["inner_example"] // [String] |  (optional)
let name = "name_example" // String |  (optional)
let objectField = "objectField_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 pmUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)

PropertymappingsAPI.propertymappingsLdapList(expression: expression, managed: managed, name: name, objectField: objectField, ordering: ordering, page: page, pageSize: pageSize, pmUuid: pmUuid, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
expression	String		[optional]
managed	[String]		[optional]
name	String		[optional]
objectField	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]
pmUuid	UUID		[optional]
search	String	A search term.	[optional]

Return type

PaginatedLDAPPropertyMappingList

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]

propertymappingsLdapPartialUpdate

    open class func propertymappingsLdapPartialUpdate(pmUuid: UUID, patchedLDAPPropertyMappingRequest: PatchedLDAPPropertyMappingRequest? = nil, completion: @escaping (_ data: LDAPPropertyMapping?, _ error: Error?) -> Void)

LDAP PropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this LDAP Property Mapping.
let patchedLDAPPropertyMappingRequest = PatchedLDAPPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", objectField: "objectField_example") // PatchedLDAPPropertyMappingRequest |  (optional)

PropertymappingsAPI.propertymappingsLdapPartialUpdate(pmUuid: pmUuid, patchedLDAPPropertyMappingRequest: patchedLDAPPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this LDAP Property Mapping.
patchedLDAPPropertyMappingRequest	PatchedLDAPPropertyMappingRequest		[optional]

Return type

LDAPPropertyMapping

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]

propertymappingsLdapRetrieve

    open class func propertymappingsLdapRetrieve(pmUuid: UUID, completion: @escaping (_ data: LDAPPropertyMapping?, _ error: Error?) -> Void)

LDAP PropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this LDAP Property Mapping.

PropertymappingsAPI.propertymappingsLdapRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this LDAP Property Mapping.

Return type

LDAPPropertyMapping

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]

propertymappingsLdapUpdate

    open class func propertymappingsLdapUpdate(pmUuid: UUID, lDAPPropertyMappingRequest: LDAPPropertyMappingRequest, completion: @escaping (_ data: LDAPPropertyMapping?, _ error: Error?) -> Void)

LDAP PropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this LDAP Property Mapping.
let lDAPPropertyMappingRequest = LDAPPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", objectField: "objectField_example") // LDAPPropertyMappingRequest | 

PropertymappingsAPI.propertymappingsLdapUpdate(pmUuid: pmUuid, lDAPPropertyMappingRequest: lDAPPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this LDAP Property Mapping.
lDAPPropertyMappingRequest	LDAPPropertyMappingRequest

Return type

LDAPPropertyMapping

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]

propertymappingsLdapUsedByList

    open class func propertymappingsLdapUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this LDAP Property Mapping.

PropertymappingsAPI.propertymappingsLdapUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this LDAP Property Mapping.

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]

propertymappingsNotificationCreate

    open class func propertymappingsNotificationCreate(notificationWebhookMappingRequest: NotificationWebhookMappingRequest, completion: @escaping (_ data: NotificationWebhookMapping?, _ error: Error?) -> Void)

NotificationWebhookMapping 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 notificationWebhookMappingRequest = NotificationWebhookMappingRequest(name: "name_example", expression: "expression_example") // NotificationWebhookMappingRequest | 

PropertymappingsAPI.propertymappingsNotificationCreate(notificationWebhookMappingRequest: notificationWebhookMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
notificationWebhookMappingRequest	NotificationWebhookMappingRequest

Return type

NotificationWebhookMapping

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]

propertymappingsNotificationDestroy

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

NotificationWebhookMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Webhook Mapping.

PropertymappingsAPI.propertymappingsNotificationDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Webhook Mapping.

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]

propertymappingsNotificationList

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

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

PropertymappingsAPI.propertymappingsNotificationList(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
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

PaginatedNotificationWebhookMappingList

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]

propertymappingsNotificationPartialUpdate

    open class func propertymappingsNotificationPartialUpdate(pmUuid: UUID, patchedNotificationWebhookMappingRequest: PatchedNotificationWebhookMappingRequest? = nil, completion: @escaping (_ data: NotificationWebhookMapping?, _ error: Error?) -> Void)

NotificationWebhookMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Webhook Mapping.
let patchedNotificationWebhookMappingRequest = PatchedNotificationWebhookMappingRequest(name: "name_example", expression: "expression_example") // PatchedNotificationWebhookMappingRequest |  (optional)

PropertymappingsAPI.propertymappingsNotificationPartialUpdate(pmUuid: pmUuid, patchedNotificationWebhookMappingRequest: patchedNotificationWebhookMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Webhook Mapping.
patchedNotificationWebhookMappingRequest	PatchedNotificationWebhookMappingRequest		[optional]

Return type

NotificationWebhookMapping

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]

propertymappingsNotificationRetrieve

    open class func propertymappingsNotificationRetrieve(pmUuid: UUID, completion: @escaping (_ data: NotificationWebhookMapping?, _ error: Error?) -> Void)

NotificationWebhookMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Webhook Mapping.

PropertymappingsAPI.propertymappingsNotificationRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Webhook Mapping.

Return type

NotificationWebhookMapping

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]

propertymappingsNotificationUpdate

    open class func propertymappingsNotificationUpdate(pmUuid: UUID, notificationWebhookMappingRequest: NotificationWebhookMappingRequest, completion: @escaping (_ data: NotificationWebhookMapping?, _ error: Error?) -> Void)

NotificationWebhookMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Webhook Mapping.
let notificationWebhookMappingRequest = NotificationWebhookMappingRequest(name: "name_example", expression: "expression_example") // NotificationWebhookMappingRequest | 

PropertymappingsAPI.propertymappingsNotificationUpdate(pmUuid: pmUuid, notificationWebhookMappingRequest: notificationWebhookMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Webhook Mapping.
notificationWebhookMappingRequest	NotificationWebhookMappingRequest

Return type

NotificationWebhookMapping

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]

propertymappingsNotificationUsedByList

    open class func propertymappingsNotificationUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this Webhook Mapping.

PropertymappingsAPI.propertymappingsNotificationUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Webhook Mapping.

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]

propertymappingsRacCreate

    open class func propertymappingsRacCreate(rACPropertyMappingRequest: RACPropertyMappingRequest, completion: @escaping (_ data: RACPropertyMapping?, _ error: Error?) -> Void)

RACPropertyMapping 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 rACPropertyMappingRequest = RACPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", staticSettings: "TODO") // RACPropertyMappingRequest | 

PropertymappingsAPI.propertymappingsRacCreate(rACPropertyMappingRequest: rACPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
rACPropertyMappingRequest	RACPropertyMappingRequest

Return type

RACPropertyMapping

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]

propertymappingsRacDestroy

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

RACPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this RAC Property Mapping.

PropertymappingsAPI.propertymappingsRacDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this RAC Property Mapping.

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]

propertymappingsRacList

    open class func propertymappingsRacList(managed: [String]? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedRACPropertyMappingList?, _ error: Error?) -> Void)

RACPropertyMapping 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 managed = ["inner_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)

PropertymappingsAPI.propertymappingsRacList(managed: managed, 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
managed	[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]

Return type

PaginatedRACPropertyMappingList

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]

propertymappingsRacPartialUpdate

    open class func propertymappingsRacPartialUpdate(pmUuid: UUID, patchedRACPropertyMappingRequest: PatchedRACPropertyMappingRequest? = nil, completion: @escaping (_ data: RACPropertyMapping?, _ error: Error?) -> Void)

RACPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this RAC Property Mapping.
let patchedRACPropertyMappingRequest = PatchedRACPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", staticSettings: "TODO") // PatchedRACPropertyMappingRequest |  (optional)

PropertymappingsAPI.propertymappingsRacPartialUpdate(pmUuid: pmUuid, patchedRACPropertyMappingRequest: patchedRACPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this RAC Property Mapping.
patchedRACPropertyMappingRequest	PatchedRACPropertyMappingRequest		[optional]

Return type

RACPropertyMapping

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]

propertymappingsRacRetrieve

    open class func propertymappingsRacRetrieve(pmUuid: UUID, completion: @escaping (_ data: RACPropertyMapping?, _ error: Error?) -> Void)

RACPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this RAC Property Mapping.

PropertymappingsAPI.propertymappingsRacRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this RAC Property Mapping.

Return type

RACPropertyMapping

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]

propertymappingsRacUpdate

    open class func propertymappingsRacUpdate(pmUuid: UUID, rACPropertyMappingRequest: RACPropertyMappingRequest, completion: @escaping (_ data: RACPropertyMapping?, _ error: Error?) -> Void)

RACPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this RAC Property Mapping.
let rACPropertyMappingRequest = RACPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", staticSettings: "TODO") // RACPropertyMappingRequest | 

PropertymappingsAPI.propertymappingsRacUpdate(pmUuid: pmUuid, rACPropertyMappingRequest: rACPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this RAC Property Mapping.
rACPropertyMappingRequest	RACPropertyMappingRequest

Return type

RACPropertyMapping

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]

propertymappingsRacUsedByList

    open class func propertymappingsRacUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this RAC Property Mapping.

PropertymappingsAPI.propertymappingsRacUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this RAC Property Mapping.

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]

propertymappingsSamlCreate

    open class func propertymappingsSamlCreate(sAMLPropertyMappingRequest: SAMLPropertyMappingRequest, completion: @escaping (_ data: SAMLPropertyMapping?, _ error: Error?) -> Void)

SAMLPropertyMapping 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 sAMLPropertyMappingRequest = SAMLPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", samlName: "samlName_example", friendlyName: "friendlyName_example") // SAMLPropertyMappingRequest | 

PropertymappingsAPI.propertymappingsSamlCreate(sAMLPropertyMappingRequest: sAMLPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sAMLPropertyMappingRequest	SAMLPropertyMappingRequest

Return type

SAMLPropertyMapping

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]

propertymappingsSamlDestroy

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

SAMLPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SAML Property Mapping.

PropertymappingsAPI.propertymappingsSamlDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SAML Property Mapping.

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]

propertymappingsSamlList

    open class func propertymappingsSamlList(expression: String? = nil, friendlyName: String? = nil, managed: [String]? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, pmUuid: UUID? = nil, samlName: String? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedSAMLPropertyMappingList?, _ error: Error?) -> Void)

SAMLPropertyMapping 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 expression = "expression_example" // String |  (optional)
let friendlyName = "friendlyName_example" // String |  (optional)
let managed = ["inner_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 pmUuid = 987 // UUID |  (optional)
let samlName = "samlName_example" // String |  (optional)
let search = "search_example" // String | A search term. (optional)

PropertymappingsAPI.propertymappingsSamlList(expression: expression, friendlyName: friendlyName, managed: managed, name: name, ordering: ordering, page: page, pageSize: pageSize, pmUuid: pmUuid, samlName: samlName, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
expression	String		[optional]
friendlyName	String		[optional]
managed	[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]
pmUuid	UUID		[optional]
samlName	String		[optional]
search	String	A search term.	[optional]

Return type

PaginatedSAMLPropertyMappingList

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]

propertymappingsSamlPartialUpdate

    open class func propertymappingsSamlPartialUpdate(pmUuid: UUID, patchedSAMLPropertyMappingRequest: PatchedSAMLPropertyMappingRequest? = nil, completion: @escaping (_ data: SAMLPropertyMapping?, _ error: Error?) -> Void)

SAMLPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SAML Property Mapping.
let patchedSAMLPropertyMappingRequest = PatchedSAMLPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", samlName: "samlName_example", friendlyName: "friendlyName_example") // PatchedSAMLPropertyMappingRequest |  (optional)

PropertymappingsAPI.propertymappingsSamlPartialUpdate(pmUuid: pmUuid, patchedSAMLPropertyMappingRequest: patchedSAMLPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SAML Property Mapping.
patchedSAMLPropertyMappingRequest	PatchedSAMLPropertyMappingRequest		[optional]

Return type

SAMLPropertyMapping

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]

propertymappingsSamlRetrieve

    open class func propertymappingsSamlRetrieve(pmUuid: UUID, completion: @escaping (_ data: SAMLPropertyMapping?, _ error: Error?) -> Void)

SAMLPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SAML Property Mapping.

PropertymappingsAPI.propertymappingsSamlRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SAML Property Mapping.

Return type

SAMLPropertyMapping

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]

propertymappingsSamlUpdate

    open class func propertymappingsSamlUpdate(pmUuid: UUID, sAMLPropertyMappingRequest: SAMLPropertyMappingRequest, completion: @escaping (_ data: SAMLPropertyMapping?, _ error: Error?) -> Void)

SAMLPropertyMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SAML Property Mapping.
let sAMLPropertyMappingRequest = SAMLPropertyMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", samlName: "samlName_example", friendlyName: "friendlyName_example") // SAMLPropertyMappingRequest | 

PropertymappingsAPI.propertymappingsSamlUpdate(pmUuid: pmUuid, sAMLPropertyMappingRequest: sAMLPropertyMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SAML Property Mapping.
sAMLPropertyMappingRequest	SAMLPropertyMappingRequest

Return type

SAMLPropertyMapping

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]

propertymappingsSamlUsedByList

    open class func propertymappingsSamlUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this SAML Property Mapping.

PropertymappingsAPI.propertymappingsSamlUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SAML Property Mapping.

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]

propertymappingsScimCreate

    open class func propertymappingsScimCreate(sCIMMappingRequest: SCIMMappingRequest, completion: @escaping (_ data: SCIMMapping?, _ error: Error?) -> Void)

SCIMMapping 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 sCIMMappingRequest = SCIMMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example") // SCIMMappingRequest | 

PropertymappingsAPI.propertymappingsScimCreate(sCIMMappingRequest: sCIMMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sCIMMappingRequest	SCIMMappingRequest

Return type

SCIMMapping

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]

propertymappingsScimDestroy

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

SCIMMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SCIM Mapping.

PropertymappingsAPI.propertymappingsScimDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SCIM Mapping.

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]

propertymappingsScimList

    open class func propertymappingsScimList(expression: String? = nil, managed: [String]? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, pmUuid: UUID? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedSCIMMappingList?, _ error: Error?) -> Void)

SCIMMapping 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 expression = "expression_example" // String |  (optional)
let managed = ["inner_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 pmUuid = 987 // UUID |  (optional)
let search = "search_example" // String | A search term. (optional)

PropertymappingsAPI.propertymappingsScimList(expression: expression, managed: managed, name: name, ordering: ordering, page: page, pageSize: pageSize, pmUuid: pmUuid, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
expression	String		[optional]
managed	[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]
pmUuid	UUID		[optional]
search	String	A search term.	[optional]

Return type

PaginatedSCIMMappingList

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]

propertymappingsScimPartialUpdate

    open class func propertymappingsScimPartialUpdate(pmUuid: UUID, patchedSCIMMappingRequest: PatchedSCIMMappingRequest? = nil, completion: @escaping (_ data: SCIMMapping?, _ error: Error?) -> Void)

SCIMMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SCIM Mapping.
let patchedSCIMMappingRequest = PatchedSCIMMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example") // PatchedSCIMMappingRequest |  (optional)

PropertymappingsAPI.propertymappingsScimPartialUpdate(pmUuid: pmUuid, patchedSCIMMappingRequest: patchedSCIMMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SCIM Mapping.
patchedSCIMMappingRequest	PatchedSCIMMappingRequest		[optional]

Return type

SCIMMapping

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]

propertymappingsScimRetrieve

    open class func propertymappingsScimRetrieve(pmUuid: UUID, completion: @escaping (_ data: SCIMMapping?, _ error: Error?) -> Void)

SCIMMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SCIM Mapping.

PropertymappingsAPI.propertymappingsScimRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SCIM Mapping.

Return type

SCIMMapping

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]

propertymappingsScimUpdate

    open class func propertymappingsScimUpdate(pmUuid: UUID, sCIMMappingRequest: SCIMMappingRequest, completion: @escaping (_ data: SCIMMapping?, _ error: Error?) -> Void)

SCIMMapping 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 pmUuid = 987 // UUID | A UUID string identifying this SCIM Mapping.
let sCIMMappingRequest = SCIMMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example") // SCIMMappingRequest | 

PropertymappingsAPI.propertymappingsScimUpdate(pmUuid: pmUuid, sCIMMappingRequest: sCIMMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SCIM Mapping.
sCIMMappingRequest	SCIMMappingRequest

Return type

SCIMMapping

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]

propertymappingsScimUsedByList

    open class func propertymappingsScimUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this SCIM Mapping.

PropertymappingsAPI.propertymappingsScimUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this SCIM Mapping.

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]

propertymappingsScopeCreate

    open class func propertymappingsScopeCreate(scopeMappingRequest: ScopeMappingRequest, completion: @escaping (_ data: ScopeMapping?, _ error: Error?) -> Void)

ScopeMapping 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 scopeMappingRequest = ScopeMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", scopeName: "scopeName_example", description: "description_example") // ScopeMappingRequest | 

PropertymappingsAPI.propertymappingsScopeCreate(scopeMappingRequest: scopeMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
scopeMappingRequest	ScopeMappingRequest

Return type

ScopeMapping

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]

propertymappingsScopeDestroy

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

ScopeMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Scope Mapping.

PropertymappingsAPI.propertymappingsScopeDestroy(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Scope Mapping.

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]

propertymappingsScopeList

    open class func propertymappingsScopeList(managed: [String]? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, scopeName: String? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedScopeMappingList?, _ error: Error?) -> Void)

ScopeMapping 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 managed = ["inner_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 scopeName = "scopeName_example" // String |  (optional)
let search = "search_example" // String | A search term. (optional)

PropertymappingsAPI.propertymappingsScopeList(managed: managed, name: name, ordering: ordering, page: page, pageSize: pageSize, scopeName: scopeName, search: search) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

PaginatedScopeMappingList

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]

propertymappingsScopePartialUpdate

    open class func propertymappingsScopePartialUpdate(pmUuid: UUID, patchedScopeMappingRequest: PatchedScopeMappingRequest? = nil, completion: @escaping (_ data: ScopeMapping?, _ error: Error?) -> Void)

ScopeMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Scope Mapping.
let patchedScopeMappingRequest = PatchedScopeMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", scopeName: "scopeName_example", description: "description_example") // PatchedScopeMappingRequest |  (optional)

PropertymappingsAPI.propertymappingsScopePartialUpdate(pmUuid: pmUuid, patchedScopeMappingRequest: patchedScopeMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Scope Mapping.
patchedScopeMappingRequest	PatchedScopeMappingRequest		[optional]

Return type

ScopeMapping

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]

propertymappingsScopeRetrieve

    open class func propertymappingsScopeRetrieve(pmUuid: UUID, completion: @escaping (_ data: ScopeMapping?, _ error: Error?) -> Void)

ScopeMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Scope Mapping.

PropertymappingsAPI.propertymappingsScopeRetrieve(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Scope Mapping.

Return type

ScopeMapping

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]

propertymappingsScopeUpdate

    open class func propertymappingsScopeUpdate(pmUuid: UUID, scopeMappingRequest: ScopeMappingRequest, completion: @escaping (_ data: ScopeMapping?, _ error: Error?) -> Void)

ScopeMapping 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 pmUuid = 987 // UUID | A UUID string identifying this Scope Mapping.
let scopeMappingRequest = ScopeMappingRequest(managed: "managed_example", name: "name_example", expression: "expression_example", scopeName: "scopeName_example", description: "description_example") // ScopeMappingRequest | 

PropertymappingsAPI.propertymappingsScopeUpdate(pmUuid: pmUuid, scopeMappingRequest: scopeMappingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Scope Mapping.
scopeMappingRequest	ScopeMappingRequest

Return type

ScopeMapping

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]

propertymappingsScopeUsedByList

    open class func propertymappingsScopeUsedByList(pmUuid: 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 pmUuid = 987 // UUID | A UUID string identifying this Scope Mapping.

PropertymappingsAPI.propertymappingsScopeUsedByList(pmUuid: pmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
pmUuid	UUID	A UUID string identifying this Scope Mapping.

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]