ProvidersAPI.md

ProvidersAPI

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

Method	HTTP request	Description
providersAllDestroy	DELETE /providers/all/{id}/
providersAllList	GET /providers/all/
providersAllRetrieve	GET /providers/all/{id}/
providersAllTypesList	GET /providers/all/types/
providersAllUsedByList	GET /providers/all/{id}/used_by/
providersLdapCreate	POST /providers/ldap/
providersLdapDestroy	DELETE /providers/ldap/{id}/
providersLdapList	GET /providers/ldap/
providersLdapPartialUpdate	PATCH /providers/ldap/{id}/
providersLdapRetrieve	GET /providers/ldap/{id}/
providersLdapUpdate	PUT /providers/ldap/{id}/
providersLdapUsedByList	GET /providers/ldap/{id}/used_by/
providersOauth2Create	POST /providers/oauth2/
providersOauth2Destroy	DELETE /providers/oauth2/{id}/
providersOauth2List	GET /providers/oauth2/
providersOauth2PartialUpdate	PATCH /providers/oauth2/{id}/
providersOauth2PreviewUserRetrieve	GET /providers/oauth2/{id}/preview_user/
providersOauth2Retrieve	GET /providers/oauth2/{id}/
providersOauth2SetupUrlsRetrieve	GET /providers/oauth2/{id}/setup_urls/
providersOauth2Update	PUT /providers/oauth2/{id}/
providersOauth2UsedByList	GET /providers/oauth2/{id}/used_by/
providersProxyCreate	POST /providers/proxy/
providersProxyDestroy	DELETE /providers/proxy/{id}/
providersProxyList	GET /providers/proxy/
providersProxyPartialUpdate	PATCH /providers/proxy/{id}/
providersProxyRetrieve	GET /providers/proxy/{id}/
providersProxyUpdate	PUT /providers/proxy/{id}/
providersProxyUsedByList	GET /providers/proxy/{id}/used_by/
providersRacCreate	POST /providers/rac/
providersRacDestroy	DELETE /providers/rac/{id}/
providersRacList	GET /providers/rac/
providersRacPartialUpdate	PATCH /providers/rac/{id}/
providersRacRetrieve	GET /providers/rac/{id}/
providersRacUpdate	PUT /providers/rac/{id}/
providersRacUsedByList	GET /providers/rac/{id}/used_by/
providersRadiusCreate	POST /providers/radius/
providersRadiusDestroy	DELETE /providers/radius/{id}/
providersRadiusList	GET /providers/radius/
providersRadiusPartialUpdate	PATCH /providers/radius/{id}/
providersRadiusRetrieve	GET /providers/radius/{id}/
providersRadiusUpdate	PUT /providers/radius/{id}/
providersRadiusUsedByList	GET /providers/radius/{id}/used_by/
providersSamlCreate	POST /providers/saml/
providersSamlDestroy	DELETE /providers/saml/{id}/
providersSamlImportMetadataCreate	POST /providers/saml/import_metadata/
providersSamlList	GET /providers/saml/
providersSamlMetadataRetrieve	GET /providers/saml/{id}/metadata/
providersSamlPartialUpdate	PATCH /providers/saml/{id}/
providersSamlPreviewUserRetrieve	GET /providers/saml/{id}/preview_user/
providersSamlRetrieve	GET /providers/saml/{id}/
providersSamlUpdate	PUT /providers/saml/{id}/
providersSamlUsedByList	GET /providers/saml/{id}/used_by/
providersScimCreate	POST /providers/scim/
providersScimDestroy	DELETE /providers/scim/{id}/
providersScimList	GET /providers/scim/
providersScimPartialUpdate	PATCH /providers/scim/{id}/
providersScimRetrieve	GET /providers/scim/{id}/
providersScimSyncStatusRetrieve	GET /providers/scim/{id}/sync_status/
providersScimUpdate	PUT /providers/scim/{id}/
providersScimUsedByList	GET /providers/scim/{id}/used_by/

providersAllDestroy

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

Provider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this provider.

ProvidersAPI.providersAllDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

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]

providersAllList

    open class func providersAllList(applicationIsnull: Bool? = nil, backchannelOnly: Bool? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedProviderList?, _ error: Error?) -> Void)

Provider 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 applicationIsnull = true // Bool |  (optional)
let backchannelOnly = 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)

ProvidersAPI.providersAllList(applicationIsnull: applicationIsnull, backchannelOnly: backchannelOnly, 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
applicationIsnull	Bool		[optional]
backchannelOnly	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

PaginatedProviderList

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]

providersAllRetrieve

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

Provider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this provider.

ProvidersAPI.providersAllRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

Return type

Provider

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]

providersAllTypesList

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

Get all creatable provider 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


ProvidersAPI.providersAllTypesList() { (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]

providersAllUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this provider.

ProvidersAPI.providersAllUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

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]

providersLdapCreate

    open class func providersLdapCreate(lDAPProviderRequest: LDAPProviderRequest, completion: @escaping (_ data: LDAPProvider?, _ error: Error?) -> Void)

LDAPProvider 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 lDAPProviderRequest = LDAPProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], baseDn: "baseDn_example", searchGroup: 123, certificate: 123, tlsServerName: "tlsServerName_example", uidStartNumber: 123, gidStartNumber: 123, searchMode: LDAPAPIAccessMode(), bindMode: nil, mfaSupport: false) // LDAPProviderRequest | 

ProvidersAPI.providersLdapCreate(lDAPProviderRequest: lDAPProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
lDAPProviderRequest	LDAPProviderRequest

Return type

LDAPProvider

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]

providersLdapDestroy

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

LDAPProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this LDAP Provider.

ProvidersAPI.providersLdapDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this LDAP Provider.

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]

providersLdapList

    open class func providersLdapList(applicationIsnull: Bool? = nil, authorizationFlowSlugIexact: String? = nil, baseDnIexact: String? = nil, certificateKpUuidIexact: UUID? = nil, certificateNameIexact: String? = nil, gidStartNumberIexact: Int? = nil, nameIexact: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, searchGroupGroupUuidIexact: UUID? = nil, searchGroupNameIexact: String? = nil, tlsServerNameIexact: String? = nil, uidStartNumberIexact: Int? = nil, completion: @escaping (_ data: PaginatedLDAPProviderList?, _ error: Error?) -> Void)

LDAPProvider 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 applicationIsnull = true // Bool |  (optional)
let authorizationFlowSlugIexact = "authorizationFlowSlugIexact_example" // String |  (optional)
let baseDnIexact = "baseDnIexact_example" // String |  (optional)
let certificateKpUuidIexact = 987 // UUID |  (optional)
let certificateNameIexact = "certificateNameIexact_example" // String |  (optional)
let gidStartNumberIexact = 987 // Int |  (optional)
let nameIexact = "nameIexact_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let searchGroupGroupUuidIexact = 987 // UUID |  (optional)
let searchGroupNameIexact = "searchGroupNameIexact_example" // String |  (optional)
let tlsServerNameIexact = "tlsServerNameIexact_example" // String |  (optional)
let uidStartNumberIexact = 987 // Int |  (optional)

ProvidersAPI.providersLdapList(applicationIsnull: applicationIsnull, authorizationFlowSlugIexact: authorizationFlowSlugIexact, baseDnIexact: baseDnIexact, certificateKpUuidIexact: certificateKpUuidIexact, certificateNameIexact: certificateNameIexact, gidStartNumberIexact: gidStartNumberIexact, nameIexact: nameIexact, ordering: ordering, page: page, pageSize: pageSize, search: search, searchGroupGroupUuidIexact: searchGroupGroupUuidIexact, searchGroupNameIexact: searchGroupNameIexact, tlsServerNameIexact: tlsServerNameIexact, uidStartNumberIexact: uidStartNumberIexact) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
applicationIsnull	Bool		[optional]
authorizationFlowSlugIexact	String		[optional]
baseDnIexact	String		[optional]
certificateKpUuidIexact	UUID		[optional]
certificateNameIexact	String		[optional]
gidStartNumberIexact	Int		[optional]
nameIexact	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]
searchGroupGroupUuidIexact	UUID		[optional]
searchGroupNameIexact	String		[optional]
tlsServerNameIexact	String		[optional]
uidStartNumberIexact	Int		[optional]

Return type

PaginatedLDAPProviderList

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]

providersLdapPartialUpdate

    open class func providersLdapPartialUpdate(id: Int, patchedLDAPProviderRequest: PatchedLDAPProviderRequest? = nil, completion: @escaping (_ data: LDAPProvider?, _ error: Error?) -> Void)

LDAPProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this LDAP Provider.
let patchedLDAPProviderRequest = PatchedLDAPProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], baseDn: "baseDn_example", searchGroup: 123, certificate: 123, tlsServerName: "tlsServerName_example", uidStartNumber: 123, gidStartNumber: 123, searchMode: LDAPAPIAccessMode(), bindMode: nil, mfaSupport: false) // PatchedLDAPProviderRequest |  (optional)

ProvidersAPI.providersLdapPartialUpdate(id: id, patchedLDAPProviderRequest: patchedLDAPProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this LDAP Provider.
patchedLDAPProviderRequest	PatchedLDAPProviderRequest		[optional]

Return type

LDAPProvider

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]

providersLdapRetrieve

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

LDAPProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this LDAP Provider.

ProvidersAPI.providersLdapRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this LDAP Provider.

Return type

LDAPProvider

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]

providersLdapUpdate

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

LDAPProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this LDAP Provider.
let lDAPProviderRequest = LDAPProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], baseDn: "baseDn_example", searchGroup: 123, certificate: 123, tlsServerName: "tlsServerName_example", uidStartNumber: 123, gidStartNumber: 123, searchMode: LDAPAPIAccessMode(), bindMode: nil, mfaSupport: false) // LDAPProviderRequest | 

ProvidersAPI.providersLdapUpdate(id: id, lDAPProviderRequest: lDAPProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this LDAP Provider.
lDAPProviderRequest	LDAPProviderRequest

Return type

LDAPProvider

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]

providersLdapUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this LDAP Provider.

ProvidersAPI.providersLdapUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this LDAP Provider.

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]

providersOauth2Create

    open class func providersOauth2Create(oAuth2ProviderRequest: OAuth2ProviderRequest, completion: @escaping (_ data: OAuth2Provider?, _ error: Error?) -> Void)

OAuth2Provider 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 oAuth2ProviderRequest = OAuth2ProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], clientType: ClientTypeEnum(), clientId: "clientId_example", clientSecret: "clientSecret_example", accessCodeValidity: "accessCodeValidity_example", accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example", includeClaimsInIdToken: false, signingKey: 123, redirectUris: "redirectUris_example", subMode: SubModeEnum(), issuerMode: IssuerModeEnum(), jwksSources: [123]) // OAuth2ProviderRequest | 

ProvidersAPI.providersOauth2Create(oAuth2ProviderRequest: oAuth2ProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
oAuth2ProviderRequest	OAuth2ProviderRequest

Return type

OAuth2Provider

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]

providersOauth2Destroy

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

OAuth2Provider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.

ProvidersAPI.providersOauth2Destroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.

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]

providersOauth2List

    open class func providersOauth2List(accessCodeValidity: String? = nil, accessTokenValidity: String? = nil, application: UUID? = nil, authorizationFlow: UUID? = nil, clientId: String? = nil, clientType: ClientType_providersOauth2List? = nil, includeClaimsInIdToken: Bool? = nil, issuerMode: IssuerMode_providersOauth2List? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, propertyMappings: [UUID]? = nil, redirectUris: String? = nil, refreshTokenValidity: String? = nil, search: String? = nil, signingKey: UUID? = nil, subMode: SubMode_providersOauth2List? = nil, completion: @escaping (_ data: PaginatedOAuth2ProviderList?, _ error: Error?) -> Void)

OAuth2Provider 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 accessCodeValidity = "accessCodeValidity_example" // String |  (optional)
let accessTokenValidity = "accessTokenValidity_example" // String |  (optional)
let application = 987 // UUID |  (optional)
let authorizationFlow = 987 // UUID |  (optional)
let clientId = "clientId_example" // String |  (optional)
let clientType = "clientType_example" // String | Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable  * `confidential` - Confidential * `public` - Public (optional)
let includeClaimsInIdToken = true // Bool |  (optional)
let issuerMode = "issuerMode_example" // String | Configure how the issuer field of the ID Token should be filled.  * `global` - Same identifier is used for all providers * `per_provider` - Each provider has a different issuer, based on the application slug. (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 propertyMappings = [123] // [UUID] |  (optional)
let redirectUris = "redirectUris_example" // String |  (optional)
let refreshTokenValidity = "refreshTokenValidity_example" // String |  (optional)
let search = "search_example" // String | A search term. (optional)
let signingKey = 987 // UUID |  (optional)
let subMode = "subMode_example" // String | Configure what data should be used as unique User Identifier. For most cases, the default should be fine.  * `hashed_user_id` - Based on the Hashed User ID * `user_id` - Based on user ID * `user_uuid` - Based on user UUID * `user_username` - Based on the username * `user_email` - Based on the User's Email. This is recommended over the UPN method. * `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains. (optional)

ProvidersAPI.providersOauth2List(accessCodeValidity: accessCodeValidity, accessTokenValidity: accessTokenValidity, application: application, authorizationFlow: authorizationFlow, clientId: clientId, clientType: clientType, includeClaimsInIdToken: includeClaimsInIdToken, issuerMode: issuerMode, name: name, ordering: ordering, page: page, pageSize: pageSize, propertyMappings: propertyMappings, redirectUris: redirectUris, refreshTokenValidity: refreshTokenValidity, search: search, signingKey: signingKey, subMode: subMode) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
accessCodeValidity	String		[optional]
accessTokenValidity	String		[optional]
application	UUID		[optional]
authorizationFlow	UUID		[optional]
clientId	String		[optional]
clientType	String	Confidential clients are capable of maintaining the confidentiality of their credentials. Public clients are incapable * `confidential` - Confidential * `public` - Public	[optional]
includeClaimsInIdToken	Bool		[optional]
issuerMode	String	Configure how the issuer field of the ID Token should be filled. * `global` - Same identifier is used for all providers * `per_provider` - Each provider has a different issuer, based on the application slug.	[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]
propertyMappings	[UUID]		[optional]
redirectUris	String		[optional]
refreshTokenValidity	String		[optional]
search	String	A search term.	[optional]
signingKey	UUID		[optional]
subMode	String	Configure what data should be used as unique User Identifier. For most cases, the default should be fine. * `hashed_user_id` - Based on the Hashed User ID * `user_id` - Based on user ID * `user_uuid` - Based on user UUID * `user_username` - Based on the username * `user_email` - Based on the User's Email. This is recommended over the UPN method. * `user_upn` - Based on the User's UPN, only works if user has a 'upn' attribute set. Use this method only if you have different UPN and Mail domains.	[optional]

Return type

PaginatedOAuth2ProviderList

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]

providersOauth2PartialUpdate

    open class func providersOauth2PartialUpdate(id: Int, patchedOAuth2ProviderRequest: PatchedOAuth2ProviderRequest? = nil, completion: @escaping (_ data: OAuth2Provider?, _ error: Error?) -> Void)

OAuth2Provider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.
let patchedOAuth2ProviderRequest = PatchedOAuth2ProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], clientType: ClientTypeEnum(), clientId: "clientId_example", clientSecret: "clientSecret_example", accessCodeValidity: "accessCodeValidity_example", accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example", includeClaimsInIdToken: false, signingKey: 123, redirectUris: "redirectUris_example", subMode: SubModeEnum(), issuerMode: IssuerModeEnum(), jwksSources: [123]) // PatchedOAuth2ProviderRequest |  (optional)

ProvidersAPI.providersOauth2PartialUpdate(id: id, patchedOAuth2ProviderRequest: patchedOAuth2ProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.
patchedOAuth2ProviderRequest	PatchedOAuth2ProviderRequest		[optional]

Return type

OAuth2Provider

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]

providersOauth2PreviewUserRetrieve

    open class func providersOauth2PreviewUserRetrieve(id: Int, forUser: Int? = nil, completion: @escaping (_ data: PropertyMappingPreview?, _ error: Error?) -> Void)

Preview user data for provider

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.
let forUser = 987 // Int |  (optional)

ProvidersAPI.providersOauth2PreviewUserRetrieve(id: id, forUser: forUser) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.
forUser	Int		[optional]

Return type

PropertyMappingPreview

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]

providersOauth2Retrieve

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

OAuth2Provider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.

ProvidersAPI.providersOauth2Retrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.

Return type

OAuth2Provider

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]

providersOauth2SetupUrlsRetrieve

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

Get Providers setup URLs

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.

ProvidersAPI.providersOauth2SetupUrlsRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.

Return type

OAuth2ProviderSetupURLs

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]

providersOauth2Update

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

OAuth2Provider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.
let oAuth2ProviderRequest = OAuth2ProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], clientType: ClientTypeEnum(), clientId: "clientId_example", clientSecret: "clientSecret_example", accessCodeValidity: "accessCodeValidity_example", accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example", includeClaimsInIdToken: false, signingKey: 123, redirectUris: "redirectUris_example", subMode: SubModeEnum(), issuerMode: IssuerModeEnum(), jwksSources: [123]) // OAuth2ProviderRequest | 

ProvidersAPI.providersOauth2Update(id: id, oAuth2ProviderRequest: oAuth2ProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.
oAuth2ProviderRequest	OAuth2ProviderRequest

Return type

OAuth2Provider

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]

providersOauth2UsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this OAuth2/OpenID Provider.

ProvidersAPI.providersOauth2UsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this OAuth2/OpenID Provider.

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]

providersProxyCreate

    open class func providersProxyCreate(proxyProviderRequest: ProxyProviderRequest, completion: @escaping (_ data: ProxyProvider?, _ error: Error?) -> Void)

ProxyProvider 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 proxyProviderRequest = ProxyProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], internalHost: "internalHost_example", externalHost: "externalHost_example", internalHostSslValidation: false, certificate: 123, skipPathRegex: "skipPathRegex_example", basicAuthEnabled: false, basicAuthPasswordAttribute: "basicAuthPasswordAttribute_example", basicAuthUserAttribute: "basicAuthUserAttribute_example", mode: ProxyMode(), interceptHeaderAuth: false, cookieDomain: "cookieDomain_example", jwksSources: [123], accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example") // ProxyProviderRequest | 

ProvidersAPI.providersProxyCreate(proxyProviderRequest: proxyProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
proxyProviderRequest	ProxyProviderRequest

Return type

ProxyProvider

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]

providersProxyDestroy

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

ProxyProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Proxy Provider.

ProvidersAPI.providersProxyDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Proxy Provider.

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]

providersProxyList

    open class func providersProxyList(applicationIsnull: Bool? = nil, authorizationFlowSlugIexact: String? = nil, basicAuthEnabledIexact: Bool? = nil, basicAuthPasswordAttributeIexact: String? = nil, basicAuthUserAttributeIexact: String? = nil, certificateKpUuidIexact: UUID? = nil, certificateNameIexact: String? = nil, cookieDomainIexact: String? = nil, externalHostIexact: String? = nil, internalHostIexact: String? = nil, internalHostSslValidationIexact: Bool? = nil, modeIexact: String? = nil, nameIexact: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, propertyMappingsIexact: [UUID]? = nil, redirectUrisIexact: String? = nil, search: String? = nil, skipPathRegexIexact: String? = nil, completion: @escaping (_ data: PaginatedProxyProviderList?, _ error: Error?) -> Void)

ProxyProvider 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 applicationIsnull = true // Bool |  (optional)
let authorizationFlowSlugIexact = "authorizationFlowSlugIexact_example" // String |  (optional)
let basicAuthEnabledIexact = true // Bool |  (optional)
let basicAuthPasswordAttributeIexact = "basicAuthPasswordAttributeIexact_example" // String |  (optional)
let basicAuthUserAttributeIexact = "basicAuthUserAttributeIexact_example" // String |  (optional)
let certificateKpUuidIexact = 987 // UUID |  (optional)
let certificateNameIexact = "certificateNameIexact_example" // String |  (optional)
let cookieDomainIexact = "cookieDomainIexact_example" // String |  (optional)
let externalHostIexact = "externalHostIexact_example" // String |  (optional)
let internalHostIexact = "internalHostIexact_example" // String |  (optional)
let internalHostSslValidationIexact = true // Bool |  (optional)
let modeIexact = "modeIexact_example" // String |  (optional)
let nameIexact = "nameIexact_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 propertyMappingsIexact = [123] // [UUID] |  (optional)
let redirectUrisIexact = "redirectUrisIexact_example" // String |  (optional)
let search = "search_example" // String | A search term. (optional)
let skipPathRegexIexact = "skipPathRegexIexact_example" // String |  (optional)

ProvidersAPI.providersProxyList(applicationIsnull: applicationIsnull, authorizationFlowSlugIexact: authorizationFlowSlugIexact, basicAuthEnabledIexact: basicAuthEnabledIexact, basicAuthPasswordAttributeIexact: basicAuthPasswordAttributeIexact, basicAuthUserAttributeIexact: basicAuthUserAttributeIexact, certificateKpUuidIexact: certificateKpUuidIexact, certificateNameIexact: certificateNameIexact, cookieDomainIexact: cookieDomainIexact, externalHostIexact: externalHostIexact, internalHostIexact: internalHostIexact, internalHostSslValidationIexact: internalHostSslValidationIexact, modeIexact: modeIexact, nameIexact: nameIexact, ordering: ordering, page: page, pageSize: pageSize, propertyMappingsIexact: propertyMappingsIexact, redirectUrisIexact: redirectUrisIexact, search: search, skipPathRegexIexact: skipPathRegexIexact) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
applicationIsnull	Bool		[optional]
authorizationFlowSlugIexact	String		[optional]
basicAuthEnabledIexact	Bool		[optional]
basicAuthPasswordAttributeIexact	String		[optional]
basicAuthUserAttributeIexact	String		[optional]
certificateKpUuidIexact	UUID		[optional]
certificateNameIexact	String		[optional]
cookieDomainIexact	String		[optional]
externalHostIexact	String		[optional]
internalHostIexact	String		[optional]
internalHostSslValidationIexact	Bool		[optional]
modeIexact	String		[optional]
nameIexact	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]
propertyMappingsIexact	[UUID]		[optional]
redirectUrisIexact	String		[optional]
search	String	A search term.	[optional]
skipPathRegexIexact	String		[optional]

Return type

PaginatedProxyProviderList

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]

providersProxyPartialUpdate

    open class func providersProxyPartialUpdate(id: Int, patchedProxyProviderRequest: PatchedProxyProviderRequest? = nil, completion: @escaping (_ data: ProxyProvider?, _ error: Error?) -> Void)

ProxyProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Proxy Provider.
let patchedProxyProviderRequest = PatchedProxyProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], internalHost: "internalHost_example", externalHost: "externalHost_example", internalHostSslValidation: false, certificate: 123, skipPathRegex: "skipPathRegex_example", basicAuthEnabled: false, basicAuthPasswordAttribute: "basicAuthPasswordAttribute_example", basicAuthUserAttribute: "basicAuthUserAttribute_example", mode: ProxyMode(), interceptHeaderAuth: false, cookieDomain: "cookieDomain_example", jwksSources: [123], accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example") // PatchedProxyProviderRequest |  (optional)

ProvidersAPI.providersProxyPartialUpdate(id: id, patchedProxyProviderRequest: patchedProxyProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Proxy Provider.
patchedProxyProviderRequest	PatchedProxyProviderRequest		[optional]

Return type

ProxyProvider

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]

providersProxyRetrieve

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

ProxyProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Proxy Provider.

ProvidersAPI.providersProxyRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Proxy Provider.

Return type

ProxyProvider

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]

providersProxyUpdate

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

ProxyProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Proxy Provider.
let proxyProviderRequest = ProxyProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], internalHost: "internalHost_example", externalHost: "externalHost_example", internalHostSslValidation: false, certificate: 123, skipPathRegex: "skipPathRegex_example", basicAuthEnabled: false, basicAuthPasswordAttribute: "basicAuthPasswordAttribute_example", basicAuthUserAttribute: "basicAuthUserAttribute_example", mode: ProxyMode(), interceptHeaderAuth: false, cookieDomain: "cookieDomain_example", jwksSources: [123], accessTokenValidity: "accessTokenValidity_example", refreshTokenValidity: "refreshTokenValidity_example") // ProxyProviderRequest | 

ProvidersAPI.providersProxyUpdate(id: id, proxyProviderRequest: proxyProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Proxy Provider.
proxyProviderRequest	ProxyProviderRequest

Return type

ProxyProvider

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]

providersProxyUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this Proxy Provider.

ProvidersAPI.providersProxyUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Proxy Provider.

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]

providersRacCreate

    open class func providersRacCreate(rACProviderRequest: RACProviderRequest, completion: @escaping (_ data: RACProvider?, _ error: Error?) -> Void)

RACProvider 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 rACProviderRequest = RACProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], settings: "TODO", connectionExpiry: "connectionExpiry_example") // RACProviderRequest | 

ProvidersAPI.providersRacCreate(rACProviderRequest: rACProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
rACProviderRequest	RACProviderRequest

Return type

RACProvider

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]

providersRacDestroy

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

RACProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this RAC Provider.

ProvidersAPI.providersRacDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this RAC Provider.

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]

providersRacList

    open class func providersRacList(applicationIsnull: Bool? = nil, nameIexact: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedRACProviderList?, _ error: Error?) -> Void)

RACProvider 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 applicationIsnull = true // Bool |  (optional)
let nameIexact = "nameIexact_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)

ProvidersAPI.providersRacList(applicationIsnull: applicationIsnull, nameIexact: nameIexact, 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
applicationIsnull	Bool		[optional]
nameIexact	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

PaginatedRACProviderList

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]

providersRacPartialUpdate

    open class func providersRacPartialUpdate(id: Int, patchedRACProviderRequest: PatchedRACProviderRequest? = nil, completion: @escaping (_ data: RACProvider?, _ error: Error?) -> Void)

RACProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this RAC Provider.
let patchedRACProviderRequest = PatchedRACProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], settings: "TODO", connectionExpiry: "connectionExpiry_example") // PatchedRACProviderRequest |  (optional)

ProvidersAPI.providersRacPartialUpdate(id: id, patchedRACProviderRequest: patchedRACProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this RAC Provider.
patchedRACProviderRequest	PatchedRACProviderRequest		[optional]

Return type

RACProvider

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]

providersRacRetrieve

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

RACProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this RAC Provider.

ProvidersAPI.providersRacRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this RAC Provider.

Return type

RACProvider

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]

providersRacUpdate

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

RACProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this RAC Provider.
let rACProviderRequest = RACProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], settings: "TODO", connectionExpiry: "connectionExpiry_example") // RACProviderRequest | 

ProvidersAPI.providersRacUpdate(id: id, rACProviderRequest: rACProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this RAC Provider.
rACProviderRequest	RACProviderRequest

Return type

RACProvider

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]

providersRacUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this RAC Provider.

ProvidersAPI.providersRacUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this RAC Provider.

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]

providersRadiusCreate

    open class func providersRadiusCreate(radiusProviderRequest: RadiusProviderRequest, completion: @escaping (_ data: RadiusProvider?, _ error: Error?) -> Void)

RadiusProvider 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 radiusProviderRequest = RadiusProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], clientNetworks: "clientNetworks_example", sharedSecret: "sharedSecret_example", mfaSupport: false) // RadiusProviderRequest | 

ProvidersAPI.providersRadiusCreate(radiusProviderRequest: radiusProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
radiusProviderRequest	RadiusProviderRequest

Return type

RadiusProvider

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]

providersRadiusDestroy

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

RadiusProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Radius Provider.

ProvidersAPI.providersRadiusDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Radius Provider.

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]

providersRadiusList

    open class func providersRadiusList(applicationIsnull: Bool? = nil, authorizationFlowSlugIexact: String? = nil, clientNetworksIexact: String? = nil, nameIexact: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, completion: @escaping (_ data: PaginatedRadiusProviderList?, _ error: Error?) -> Void)

RadiusProvider 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 applicationIsnull = true // Bool |  (optional)
let authorizationFlowSlugIexact = "authorizationFlowSlugIexact_example" // String |  (optional)
let clientNetworksIexact = "clientNetworksIexact_example" // String |  (optional)
let nameIexact = "nameIexact_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)

ProvidersAPI.providersRadiusList(applicationIsnull: applicationIsnull, authorizationFlowSlugIexact: authorizationFlowSlugIexact, clientNetworksIexact: clientNetworksIexact, nameIexact: nameIexact, 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
applicationIsnull	Bool		[optional]
authorizationFlowSlugIexact	String		[optional]
clientNetworksIexact	String		[optional]
nameIexact	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

PaginatedRadiusProviderList

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]

providersRadiusPartialUpdate

    open class func providersRadiusPartialUpdate(id: Int, patchedRadiusProviderRequest: PatchedRadiusProviderRequest? = nil, completion: @escaping (_ data: RadiusProvider?, _ error: Error?) -> Void)

RadiusProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Radius Provider.
let patchedRadiusProviderRequest = PatchedRadiusProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], clientNetworks: "clientNetworks_example", sharedSecret: "sharedSecret_example", mfaSupport: false) // PatchedRadiusProviderRequest |  (optional)

ProvidersAPI.providersRadiusPartialUpdate(id: id, patchedRadiusProviderRequest: patchedRadiusProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Radius Provider.
patchedRadiusProviderRequest	PatchedRadiusProviderRequest		[optional]

Return type

RadiusProvider

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]

providersRadiusRetrieve

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

RadiusProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Radius Provider.

ProvidersAPI.providersRadiusRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Radius Provider.

Return type

RadiusProvider

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]

providersRadiusUpdate

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

RadiusProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this Radius Provider.
let radiusProviderRequest = RadiusProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], clientNetworks: "clientNetworks_example", sharedSecret: "sharedSecret_example", mfaSupport: false) // RadiusProviderRequest | 

ProvidersAPI.providersRadiusUpdate(id: id, radiusProviderRequest: radiusProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Radius Provider.
radiusProviderRequest	RadiusProviderRequest

Return type

RadiusProvider

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]

providersRadiusUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this Radius Provider.

ProvidersAPI.providersRadiusUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this Radius Provider.

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]

providersSamlCreate

    open class func providersSamlCreate(sAMLProviderRequest: SAMLProviderRequest, completion: @escaping (_ data: SAMLProvider?, _ error: Error?) -> Void)

SAMLProvider 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 sAMLProviderRequest = SAMLProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], acsUrl: "acsUrl_example", audience: "audience_example", issuer: "issuer_example", assertionValidNotBefore: "assertionValidNotBefore_example", assertionValidNotOnOrAfter: "assertionValidNotOnOrAfter_example", sessionValidNotOnOrAfter: "sessionValidNotOnOrAfter_example", nameIdMapping: 123, digestAlgorithm: DigestAlgorithmEnum(), signatureAlgorithm: SignatureAlgorithmEnum(), signingKp: 123, verificationKp: 123, spBinding: SpBindingEnum(), defaultRelayState: "defaultRelayState_example") // SAMLProviderRequest | 

ProvidersAPI.providersSamlCreate(sAMLProviderRequest: sAMLProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sAMLProviderRequest	SAMLProviderRequest

Return type

SAMLProvider

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]

providersSamlDestroy

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

SAMLProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.

ProvidersAPI.providersSamlDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

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]

providersSamlImportMetadataCreate

    open class func providersSamlImportMetadataCreate(name: String, authorizationFlow: UUID, file: URL, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Create provider from SAML Metadata

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 | 
let authorizationFlow = 987 // UUID | 
let file = URL(string: "https://example.com")! // URL | 

ProvidersAPI.providersSamlImportMetadataCreate(name: name, authorizationFlow: authorizationFlow, file: file) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String
authorizationFlow	UUID
file	URL

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

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

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

providersSamlList

    open class func providersSamlList(acsUrl: String? = nil, assertionValidNotBefore: String? = nil, assertionValidNotOnOrAfter: String? = nil, audience: String? = nil, authenticationFlow: UUID? = nil, authorizationFlow: UUID? = nil, backchannelApplication: UUID? = nil, defaultRelayState: String? = nil, digestAlgorithm: DigestAlgorithm_providersSamlList? = nil, isBackchannel: Bool? = nil, issuer: String? = nil, name: String? = nil, nameIdMapping: UUID? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, propertyMappings: [UUID]? = nil, search: String? = nil, sessionValidNotOnOrAfter: String? = nil, signatureAlgorithm: SignatureAlgorithm_providersSamlList? = nil, signingKp: UUID? = nil, spBinding: SpBinding_providersSamlList? = nil, verificationKp: UUID? = nil, completion: @escaping (_ data: PaginatedSAMLProviderList?, _ error: Error?) -> Void)

SAMLProvider 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 acsUrl = "acsUrl_example" // String |  (optional)
let assertionValidNotBefore = "assertionValidNotBefore_example" // String |  (optional)
let assertionValidNotOnOrAfter = "assertionValidNotOnOrAfter_example" // String |  (optional)
let audience = "audience_example" // String |  (optional)
let authenticationFlow = 987 // UUID |  (optional)
let authorizationFlow = 987 // UUID |  (optional)
let backchannelApplication = 987 // UUID |  (optional)
let defaultRelayState = "defaultRelayState_example" // String |  (optional)
let digestAlgorithm = "digestAlgorithm_example" // String | * `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1 * `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256 * `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384 * `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512 (optional)
let isBackchannel = true // Bool |  (optional)
let issuer = "issuer_example" // String |  (optional)
let name = "name_example" // String |  (optional)
let nameIdMapping = 987 // UUID |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let propertyMappings = [123] // [UUID] |  (optional)
let search = "search_example" // String | A search term. (optional)
let sessionValidNotOnOrAfter = "sessionValidNotOnOrAfter_example" // String |  (optional)
let signatureAlgorithm = "signatureAlgorithm_example" // String | * `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512 * `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1 (optional)
let signingKp = 987 // UUID |  (optional)
let spBinding = "spBinding_example" // String | This determines how authentik sends the response back to the Service Provider.  * `redirect` - Redirect * `post` - Post (optional)
let verificationKp = 987 // UUID |  (optional)

ProvidersAPI.providersSamlList(acsUrl: acsUrl, assertionValidNotBefore: assertionValidNotBefore, assertionValidNotOnOrAfter: assertionValidNotOnOrAfter, audience: audience, authenticationFlow: authenticationFlow, authorizationFlow: authorizationFlow, backchannelApplication: backchannelApplication, defaultRelayState: defaultRelayState, digestAlgorithm: digestAlgorithm, isBackchannel: isBackchannel, issuer: issuer, name: name, nameIdMapping: nameIdMapping, ordering: ordering, page: page, pageSize: pageSize, propertyMappings: propertyMappings, search: search, sessionValidNotOnOrAfter: sessionValidNotOnOrAfter, signatureAlgorithm: signatureAlgorithm, signingKp: signingKp, spBinding: spBinding, verificationKp: verificationKp) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
acsUrl	String		[optional]
assertionValidNotBefore	String		[optional]
assertionValidNotOnOrAfter	String		[optional]
audience	String		[optional]
authenticationFlow	UUID		[optional]
authorizationFlow	UUID		[optional]
backchannelApplication	UUID		[optional]
defaultRelayState	String		[optional]
digestAlgorithm	String	* `http://www.w3.org/2000/09/xmldsig#sha1` - SHA1 * `http://www.w3.org/2001/04/xmlenc#sha256` - SHA256 * `http://www.w3.org/2001/04/xmldsig-more#sha384` - SHA384 * `http://www.w3.org/2001/04/xmlenc#sha512` - SHA512	[optional]
isBackchannel	Bool		[optional]
issuer	String		[optional]
name	String		[optional]
nameIdMapping	UUID		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
propertyMappings	[UUID]		[optional]
search	String	A search term.	[optional]
sessionValidNotOnOrAfter	String		[optional]
signatureAlgorithm	String	* `http://www.w3.org/2000/09/xmldsig#rsa-sha1` - RSA-SHA1 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` - RSA-SHA256 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha384` - RSA-SHA384 * `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512` - RSA-SHA512 * `http://www.w3.org/2000/09/xmldsig#dsa-sha1` - DSA-SHA1	[optional]
signingKp	UUID		[optional]
spBinding	String	This determines how authentik sends the response back to the Service Provider. * `redirect` - Redirect * `post` - Post	[optional]
verificationKp	UUID		[optional]

Return type

PaginatedSAMLProviderList

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]

providersSamlMetadataRetrieve

    open class func providersSamlMetadataRetrieve(id: Int, download: Bool? = nil, forceBinding: ForceBinding_providersSamlMetadataRetrieve? = nil, completion: @escaping (_ data: SAMLMetadata?, _ error: Error?) -> Void)

Return metadata as XML string

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let download = true // Bool |  (optional)
let forceBinding = "forceBinding_example" // String | Optionally force the metadata to only include one binding. (optional)

ProvidersAPI.providersSamlMetadataRetrieve(id: id, download: download, forceBinding: forceBinding) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
download	Bool		[optional]
forceBinding	String	Optionally force the metadata to only include one binding.	[optional]

Return type

SAMLMetadata

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]

providersSamlPartialUpdate

    open class func providersSamlPartialUpdate(id: Int, patchedSAMLProviderRequest: PatchedSAMLProviderRequest? = nil, completion: @escaping (_ data: SAMLProvider?, _ error: Error?) -> Void)

SAMLProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let patchedSAMLProviderRequest = PatchedSAMLProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], acsUrl: "acsUrl_example", audience: "audience_example", issuer: "issuer_example", assertionValidNotBefore: "assertionValidNotBefore_example", assertionValidNotOnOrAfter: "assertionValidNotOnOrAfter_example", sessionValidNotOnOrAfter: "sessionValidNotOnOrAfter_example", nameIdMapping: 123, digestAlgorithm: DigestAlgorithmEnum(), signatureAlgorithm: SignatureAlgorithmEnum(), signingKp: 123, verificationKp: 123, spBinding: SpBindingEnum(), defaultRelayState: "defaultRelayState_example") // PatchedSAMLProviderRequest |  (optional)

ProvidersAPI.providersSamlPartialUpdate(id: id, patchedSAMLProviderRequest: patchedSAMLProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
patchedSAMLProviderRequest	PatchedSAMLProviderRequest		[optional]

Return type

SAMLProvider

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]

providersSamlPreviewUserRetrieve

    open class func providersSamlPreviewUserRetrieve(id: Int, forUser: Int? = nil, completion: @escaping (_ data: PropertyMappingPreview?, _ error: Error?) -> Void)

Preview user data for provider

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let forUser = 987 // Int |  (optional)

ProvidersAPI.providersSamlPreviewUserRetrieve(id: id, forUser: forUser) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
forUser	Int		[optional]

Return type

PropertyMappingPreview

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]

providersSamlRetrieve

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

SAMLProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.

ProvidersAPI.providersSamlRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

Return type

SAMLProvider

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]

providersSamlUpdate

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

SAMLProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.
let sAMLProviderRequest = SAMLProviderRequest(name: "name_example", authenticationFlow: 123, authorizationFlow: 123, propertyMappings: [123], acsUrl: "acsUrl_example", audience: "audience_example", issuer: "issuer_example", assertionValidNotBefore: "assertionValidNotBefore_example", assertionValidNotOnOrAfter: "assertionValidNotOnOrAfter_example", sessionValidNotOnOrAfter: "sessionValidNotOnOrAfter_example", nameIdMapping: 123, digestAlgorithm: DigestAlgorithmEnum(), signatureAlgorithm: SignatureAlgorithmEnum(), signingKp: 123, verificationKp: 123, spBinding: SpBindingEnum(), defaultRelayState: "defaultRelayState_example") // SAMLProviderRequest | 

ProvidersAPI.providersSamlUpdate(id: id, sAMLProviderRequest: sAMLProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.
sAMLProviderRequest	SAMLProviderRequest

Return type

SAMLProvider

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]

providersSamlUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this SAML Provider.

ProvidersAPI.providersSamlUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SAML Provider.

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]

providersScimCreate

    open class func providersScimCreate(sCIMProviderRequest: SCIMProviderRequest, completion: @escaping (_ data: SCIMProvider?, _ error: Error?) -> Void)

SCIMProvider 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 sCIMProviderRequest = SCIMProviderRequest(name: "name_example", propertyMappings: [123], propertyMappingsGroup: [123], url: "url_example", token: "token_example", excludeUsersServiceAccount: false, filterGroup: 123) // SCIMProviderRequest | 

ProvidersAPI.providersScimCreate(sCIMProviderRequest: sCIMProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
sCIMProviderRequest	SCIMProviderRequest

Return type

SCIMProvider

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]

providersScimDestroy

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

SCIMProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SCIM Provider.

ProvidersAPI.providersScimDestroy(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SCIM Provider.

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]

providersScimList

    open class func providersScimList(excludeUsersServiceAccount: Bool? = nil, filterGroup: UUID? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, url: String? = nil, completion: @escaping (_ data: PaginatedSCIMProviderList?, _ error: Error?) -> Void)

SCIMProvider 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 excludeUsersServiceAccount = true // Bool |  (optional)
let filterGroup = 987 // UUID |  (optional)
let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let url = "url_example" // String |  (optional)

ProvidersAPI.providersScimList(excludeUsersServiceAccount: excludeUsersServiceAccount, filterGroup: filterGroup, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, url: url) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
excludeUsersServiceAccount	Bool		[optional]
filterGroup	UUID		[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]
url	String		[optional]

Return type

PaginatedSCIMProviderList

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]

providersScimPartialUpdate

    open class func providersScimPartialUpdate(id: Int, patchedSCIMProviderRequest: PatchedSCIMProviderRequest? = nil, completion: @escaping (_ data: SCIMProvider?, _ error: Error?) -> Void)

SCIMProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SCIM Provider.
let patchedSCIMProviderRequest = PatchedSCIMProviderRequest(name: "name_example", propertyMappings: [123], propertyMappingsGroup: [123], url: "url_example", token: "token_example", excludeUsersServiceAccount: false, filterGroup: 123) // PatchedSCIMProviderRequest |  (optional)

ProvidersAPI.providersScimPartialUpdate(id: id, patchedSCIMProviderRequest: patchedSCIMProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SCIM Provider.
patchedSCIMProviderRequest	PatchedSCIMProviderRequest		[optional]

Return type

SCIMProvider

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]

providersScimRetrieve

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

SCIMProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SCIM Provider.

ProvidersAPI.providersScimRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SCIM Provider.

Return type

SCIMProvider

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]

providersScimSyncStatusRetrieve

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

Get provider's sync status

Example

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

let id = 987 // Int | A unique integer value identifying this SCIM Provider.

ProvidersAPI.providersScimSyncStatusRetrieve(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SCIM Provider.

Return type

SCIMSyncStatus

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]

providersScimUpdate

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

SCIMProvider Viewset

Example

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

let id = 987 // Int | A unique integer value identifying this SCIM Provider.
let sCIMProviderRequest = SCIMProviderRequest(name: "name_example", propertyMappings: [123], propertyMappingsGroup: [123], url: "url_example", token: "token_example", excludeUsersServiceAccount: false, filterGroup: 123) // SCIMProviderRequest | 

ProvidersAPI.providersScimUpdate(id: id, sCIMProviderRequest: sCIMProviderRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SCIM Provider.
sCIMProviderRequest	SCIMProviderRequest

Return type

SCIMProvider

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]

providersScimUsedByList

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

Get a list of all objects that use this object

Example

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

let id = 987 // Int | A unique integer value identifying this SCIM Provider.

ProvidersAPI.providersScimUsedByList(id: id) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	Int	A unique integer value identifying this SCIM Provider.

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]