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

Latest commit

 

History

History
2559 lines (1836 loc) · 80.9 KB

PropertymappingsApi.md

File metadata and controls

2559 lines (1836 loc) · 80.9 KB
Raw

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

propertymappingsAllDestroy(pmUuid)

PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Property Mapping.
try {
    apiInstance.propertymappingsAllDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsAllDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsAllDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsAllList

PaginatedPropertyMappingList propertymappingsAllList(managedIsnull, ordering, page, pageSize, search)

PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val managedIsnull : kotlin.Boolean = true // kotlin.Boolean | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedPropertyMappingList = apiInstance.propertymappingsAllList(managedIsnull, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsAllList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsAllList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
managedIsnull kotlin.Boolean [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedPropertyMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsAllRetrieve

PropertyMapping propertymappingsAllRetrieve(pmUuid)

PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Property Mapping.
try {
    val result : PropertyMapping = apiInstance.propertymappingsAllRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsAllRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsAllRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

PropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsAllTestCreate

PropertyMappingTestResult propertymappingsAllTestCreate(pmUuid, policyTestRequest, formatResult)

Test Property Mapping

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Property Mapping.
val policyTestRequest : PolicyTestRequest =  // PolicyTestRequest | 
val formatResult : kotlin.Boolean = true // kotlin.Boolean | 
try {
    val result : PropertyMappingTestResult = apiInstance.propertymappingsAllTestCreate(pmUuid, policyTestRequest, formatResult)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsAllTestCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsAllTestCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pmUuid java.util.UUID A UUID string identifying this Property Mapping.
policyTestRequest PolicyTestRequest
formatResult kotlin.Boolean [optional]

Return type

PropertyMappingTestResult

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsAllTypesList

kotlin.collections.List<TypeCreate> propertymappingsAllTypesList()

Get all creatable property-mapping types

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
try {
    val result : kotlin.collections.List<TypeCreate> = apiInstance.propertymappingsAllTypesList()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsAllTypesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsAllTypesList")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<TypeCreate>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsAllUsedByList

kotlin.collections.List<UsedBy> propertymappingsAllUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Property Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsAllUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsAllUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsAllUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapCreate

LDAPPropertyMapping propertymappingsLdapCreate(ldAPPropertyMappingRequest)

LDAP PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val ldAPPropertyMappingRequest : LDAPPropertyMappingRequest =  // LDAPPropertyMappingRequest | 
try {
    val result : LDAPPropertyMapping = apiInstance.propertymappingsLdapCreate(ldAPPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
ldAPPropertyMappingRequest LDAPPropertyMappingRequest

Return type

LDAPPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapDestroy

propertymappingsLdapDestroy(pmUuid)

LDAP PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this LDAP Property Mapping.
try {
    apiInstance.propertymappingsLdapDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapList

PaginatedLDAPPropertyMappingList propertymappingsLdapList(expression, managed, name, objectField, ordering, page, pageSize, pmUuid, search)

LDAP PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val expression : kotlin.String = expression_example // kotlin.String | 
val managed : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val name : kotlin.String = name_example // kotlin.String | 
val objectField : kotlin.String = objectField_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedLDAPPropertyMappingList = apiInstance.propertymappingsLdapList(expression, managed, name, objectField, ordering, page, pageSize, pmUuid, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
expression kotlin.String [optional]
managed kotlin.collections.List<kotlin.String> [optional]
name kotlin.String [optional]
objectField kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
pmUuid java.util.UUID [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedLDAPPropertyMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapPartialUpdate

LDAPPropertyMapping propertymappingsLdapPartialUpdate(pmUuid, patchedLDAPPropertyMappingRequest)

LDAP PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this LDAP Property Mapping.
val patchedLDAPPropertyMappingRequest : PatchedLDAPPropertyMappingRequest =  // PatchedLDAPPropertyMappingRequest | 
try {
    val result : LDAPPropertyMapping = apiInstance.propertymappingsLdapPartialUpdate(pmUuid, patchedLDAPPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

LDAPPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapRetrieve

LDAPPropertyMapping propertymappingsLdapRetrieve(pmUuid)

LDAP PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this LDAP Property Mapping.
try {
    val result : LDAPPropertyMapping = apiInstance.propertymappingsLdapRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

LDAPPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapUpdate

LDAPPropertyMapping propertymappingsLdapUpdate(pmUuid, ldAPPropertyMappingRequest)

LDAP PropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this LDAP Property Mapping.
val ldAPPropertyMappingRequest : LDAPPropertyMappingRequest =  // LDAPPropertyMappingRequest | 
try {
    val result : LDAPPropertyMapping = apiInstance.propertymappingsLdapUpdate(pmUuid, ldAPPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pmUuid java.util.UUID A UUID string identifying this LDAP Property Mapping.
ldAPPropertyMappingRequest LDAPPropertyMappingRequest

Return type

LDAPPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsLdapUsedByList

kotlin.collections.List<UsedBy> propertymappingsLdapUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this LDAP Property Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsLdapUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsLdapUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsLdapUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationCreate

NotificationWebhookMapping propertymappingsNotificationCreate(notificationWebhookMappingRequest)

NotificationWebhookMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val notificationWebhookMappingRequest : NotificationWebhookMappingRequest =  // NotificationWebhookMappingRequest | 
try {
    val result : NotificationWebhookMapping = apiInstance.propertymappingsNotificationCreate(notificationWebhookMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
notificationWebhookMappingRequest NotificationWebhookMappingRequest

Return type

NotificationWebhookMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationDestroy

propertymappingsNotificationDestroy(pmUuid)

NotificationWebhookMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Webhook Mapping.
try {
    apiInstance.propertymappingsNotificationDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationList

PaginatedNotificationWebhookMappingList propertymappingsNotificationList(name, ordering, page, pageSize, search)

NotificationWebhookMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedNotificationWebhookMappingList = apiInstance.propertymappingsNotificationList(name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedNotificationWebhookMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationPartialUpdate

NotificationWebhookMapping propertymappingsNotificationPartialUpdate(pmUuid, patchedNotificationWebhookMappingRequest)

NotificationWebhookMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Webhook Mapping.
val patchedNotificationWebhookMappingRequest : PatchedNotificationWebhookMappingRequest =  // PatchedNotificationWebhookMappingRequest | 
try {
    val result : NotificationWebhookMapping = apiInstance.propertymappingsNotificationPartialUpdate(pmUuid, patchedNotificationWebhookMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationWebhookMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationRetrieve

NotificationWebhookMapping propertymappingsNotificationRetrieve(pmUuid)

NotificationWebhookMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Webhook Mapping.
try {
    val result : NotificationWebhookMapping = apiInstance.propertymappingsNotificationRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationWebhookMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationUpdate

NotificationWebhookMapping propertymappingsNotificationUpdate(pmUuid, notificationWebhookMappingRequest)

NotificationWebhookMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Webhook Mapping.
val notificationWebhookMappingRequest : NotificationWebhookMappingRequest =  // NotificationWebhookMappingRequest | 
try {
    val result : NotificationWebhookMapping = apiInstance.propertymappingsNotificationUpdate(pmUuid, notificationWebhookMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationWebhookMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsNotificationUsedByList

kotlin.collections.List<UsedBy> propertymappingsNotificationUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Webhook Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsNotificationUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsNotificationUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsNotificationUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacCreate

RACPropertyMapping propertymappingsRacCreate(raCPropertyMappingRequest)

RACPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val raCPropertyMappingRequest : RACPropertyMappingRequest =  // RACPropertyMappingRequest | 
try {
    val result : RACPropertyMapping = apiInstance.propertymappingsRacCreate(raCPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
raCPropertyMappingRequest RACPropertyMappingRequest

Return type

RACPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacDestroy

propertymappingsRacDestroy(pmUuid)

RACPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this RAC Property Mapping.
try {
    apiInstance.propertymappingsRacDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacList

PaginatedRACPropertyMappingList propertymappingsRacList(managed, name, ordering, page, pageSize, search)

RACPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val managed : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedRACPropertyMappingList = apiInstance.propertymappingsRacList(managed, name, ordering, page, pageSize, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
managed kotlin.collections.List<kotlin.String> [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedRACPropertyMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacPartialUpdate

RACPropertyMapping propertymappingsRacPartialUpdate(pmUuid, patchedRACPropertyMappingRequest)

RACPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this RAC Property Mapping.
val patchedRACPropertyMappingRequest : PatchedRACPropertyMappingRequest =  // PatchedRACPropertyMappingRequest | 
try {
    val result : RACPropertyMapping = apiInstance.propertymappingsRacPartialUpdate(pmUuid, patchedRACPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

RACPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacRetrieve

RACPropertyMapping propertymappingsRacRetrieve(pmUuid)

RACPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this RAC Property Mapping.
try {
    val result : RACPropertyMapping = apiInstance.propertymappingsRacRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

RACPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacUpdate

RACPropertyMapping propertymappingsRacUpdate(pmUuid, raCPropertyMappingRequest)

RACPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this RAC Property Mapping.
val raCPropertyMappingRequest : RACPropertyMappingRequest =  // RACPropertyMappingRequest | 
try {
    val result : RACPropertyMapping = apiInstance.propertymappingsRacUpdate(pmUuid, raCPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pmUuid java.util.UUID A UUID string identifying this RAC Property Mapping.
raCPropertyMappingRequest RACPropertyMappingRequest

Return type

RACPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsRacUsedByList

kotlin.collections.List<UsedBy> propertymappingsRacUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this RAC Property Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsRacUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsRacUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsRacUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlCreate

SAMLPropertyMapping propertymappingsSamlCreate(saMLPropertyMappingRequest)

SAMLPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val saMLPropertyMappingRequest : SAMLPropertyMappingRequest =  // SAMLPropertyMappingRequest | 
try {
    val result : SAMLPropertyMapping = apiInstance.propertymappingsSamlCreate(saMLPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
saMLPropertyMappingRequest SAMLPropertyMappingRequest

Return type

SAMLPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlDestroy

propertymappingsSamlDestroy(pmUuid)

SAMLPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SAML Property Mapping.
try {
    apiInstance.propertymappingsSamlDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlList

PaginatedSAMLPropertyMappingList propertymappingsSamlList(expression, friendlyName, managed, name, ordering, page, pageSize, pmUuid, samlName, search)

SAMLPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val expression : kotlin.String = expression_example // kotlin.String | 
val friendlyName : kotlin.String = friendlyName_example // kotlin.String | 
val managed : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val samlName : kotlin.String = samlName_example // kotlin.String | 
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedSAMLPropertyMappingList = apiInstance.propertymappingsSamlList(expression, friendlyName, managed, name, ordering, page, pageSize, pmUuid, samlName, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
expression kotlin.String [optional]
friendlyName kotlin.String [optional]
managed kotlin.collections.List<kotlin.String> [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
pmUuid java.util.UUID [optional]
samlName kotlin.String [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedSAMLPropertyMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlPartialUpdate

SAMLPropertyMapping propertymappingsSamlPartialUpdate(pmUuid, patchedSAMLPropertyMappingRequest)

SAMLPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SAML Property Mapping.
val patchedSAMLPropertyMappingRequest : PatchedSAMLPropertyMappingRequest =  // PatchedSAMLPropertyMappingRequest | 
try {
    val result : SAMLPropertyMapping = apiInstance.propertymappingsSamlPartialUpdate(pmUuid, patchedSAMLPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

SAMLPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlRetrieve

SAMLPropertyMapping propertymappingsSamlRetrieve(pmUuid)

SAMLPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SAML Property Mapping.
try {
    val result : SAMLPropertyMapping = apiInstance.propertymappingsSamlRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

SAMLPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlUpdate

SAMLPropertyMapping propertymappingsSamlUpdate(pmUuid, saMLPropertyMappingRequest)

SAMLPropertyMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SAML Property Mapping.
val saMLPropertyMappingRequest : SAMLPropertyMappingRequest =  // SAMLPropertyMappingRequest | 
try {
    val result : SAMLPropertyMapping = apiInstance.propertymappingsSamlUpdate(pmUuid, saMLPropertyMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pmUuid java.util.UUID A UUID string identifying this SAML Property Mapping.
saMLPropertyMappingRequest SAMLPropertyMappingRequest

Return type

SAMLPropertyMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsSamlUsedByList

kotlin.collections.List<UsedBy> propertymappingsSamlUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SAML Property Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsSamlUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsSamlUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsSamlUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimCreate

SCIMMapping propertymappingsScimCreate(scIMMappingRequest)

SCIMMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val scIMMappingRequest : SCIMMappingRequest =  // SCIMMappingRequest | 
try {
    val result : SCIMMapping = apiInstance.propertymappingsScimCreate(scIMMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
scIMMappingRequest SCIMMappingRequest

Return type

SCIMMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimDestroy

propertymappingsScimDestroy(pmUuid)

SCIMMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SCIM Mapping.
try {
    apiInstance.propertymappingsScimDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimList

PaginatedSCIMMappingList propertymappingsScimList(expression, managed, name, ordering, page, pageSize, pmUuid, search)

SCIMMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val expression : kotlin.String = expression_example // kotlin.String | 
val managed : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedSCIMMappingList = apiInstance.propertymappingsScimList(expression, managed, name, ordering, page, pageSize, pmUuid, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
expression kotlin.String [optional]
managed kotlin.collections.List<kotlin.String> [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
pmUuid java.util.UUID [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedSCIMMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimPartialUpdate

SCIMMapping propertymappingsScimPartialUpdate(pmUuid, patchedSCIMMappingRequest)

SCIMMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SCIM Mapping.
val patchedSCIMMappingRequest : PatchedSCIMMappingRequest =  // PatchedSCIMMappingRequest | 
try {
    val result : SCIMMapping = apiInstance.propertymappingsScimPartialUpdate(pmUuid, patchedSCIMMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

SCIMMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimRetrieve

SCIMMapping propertymappingsScimRetrieve(pmUuid)

SCIMMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SCIM Mapping.
try {
    val result : SCIMMapping = apiInstance.propertymappingsScimRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

SCIMMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimUpdate

SCIMMapping propertymappingsScimUpdate(pmUuid, scIMMappingRequest)

SCIMMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SCIM Mapping.
val scIMMappingRequest : SCIMMappingRequest =  // SCIMMappingRequest | 
try {
    val result : SCIMMapping = apiInstance.propertymappingsScimUpdate(pmUuid, scIMMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimUpdate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pmUuid java.util.UUID A UUID string identifying this SCIM Mapping.
scIMMappingRequest SCIMMappingRequest

Return type

SCIMMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScimUsedByList

kotlin.collections.List<UsedBy> propertymappingsScimUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this SCIM Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsScimUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScimUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScimUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopeCreate

ScopeMapping propertymappingsScopeCreate(scopeMappingRequest)

ScopeMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val scopeMappingRequest : ScopeMappingRequest =  // ScopeMappingRequest | 
try {
    val result : ScopeMapping = apiInstance.propertymappingsScopeCreate(scopeMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopeCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopeCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
scopeMappingRequest ScopeMappingRequest

Return type

ScopeMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopeDestroy

propertymappingsScopeDestroy(pmUuid)

ScopeMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Scope Mapping.
try {
    apiInstance.propertymappingsScopeDestroy(pmUuid)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopeDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopeDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopeList

PaginatedScopeMappingList propertymappingsScopeList(managed, name, ordering, page, pageSize, scopeName, search)

ScopeMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val managed : kotlin.collections.List<kotlin.String> =  // kotlin.collections.List<kotlin.String> | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val scopeName : kotlin.String = scopeName_example // kotlin.String | 
val search : kotlin.String = search_example // kotlin.String | A search term.
try {
    val result : PaginatedScopeMappingList = apiInstance.propertymappingsScopeList(managed, name, ordering, page, pageSize, scopeName, search)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopeList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopeList")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
managed kotlin.collections.List<kotlin.String> [optional]
name kotlin.String [optional]
ordering kotlin.String Which field to use when ordering the results. [optional]
page kotlin.Int A page number within the paginated result set. [optional]
pageSize kotlin.Int Number of results to return per page. [optional]
scopeName kotlin.String [optional]
search kotlin.String A search term. [optional]

Return type

PaginatedScopeMappingList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopePartialUpdate

ScopeMapping propertymappingsScopePartialUpdate(pmUuid, patchedScopeMappingRequest)

ScopeMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Scope Mapping.
val patchedScopeMappingRequest : PatchedScopeMappingRequest =  // PatchedScopeMappingRequest | 
try {
    val result : ScopeMapping = apiInstance.propertymappingsScopePartialUpdate(pmUuid, patchedScopeMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopePartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopePartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

ScopeMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopeRetrieve

ScopeMapping propertymappingsScopeRetrieve(pmUuid)

ScopeMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Scope Mapping.
try {
    val result : ScopeMapping = apiInstance.propertymappingsScopeRetrieve(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopeRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopeRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

ScopeMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopeUpdate

ScopeMapping propertymappingsScopeUpdate(pmUuid, scopeMappingRequest)

ScopeMapping Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Scope Mapping.
val scopeMappingRequest : ScopeMappingRequest =  // ScopeMappingRequest | 
try {
    val result : ScopeMapping = apiInstance.propertymappingsScopeUpdate(pmUuid, scopeMappingRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopeUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopeUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

ScopeMapping

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

propertymappingsScopeUsedByList

kotlin.collections.List<UsedBy> propertymappingsScopeUsedByList(pmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = PropertymappingsApi()
val pmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Scope Mapping.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.propertymappingsScopeUsedByList(pmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PropertymappingsApi#propertymappingsScopeUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PropertymappingsApi#propertymappingsScopeUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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