# \PropertymappingsApi
All URIs are relative to *http://localhost/api/v3*
[**propertymappings_all_destroy**](PropertymappingsApi.md#propertymappings_all_destroy) | **DELETE** /propertymappings/all/{pm_uuid}/ |
[**propertymappings_all_list**](PropertymappingsApi.md#propertymappings_all_list) | **GET** /propertymappings/all/ |
[**propertymappings_all_retrieve**](PropertymappingsApi.md#propertymappings_all_retrieve) | **GET** /propertymappings/all/{pm_uuid}/ |
[**propertymappings_all_test_create**](PropertymappingsApi.md#propertymappings_all_test_create) | **POST** /propertymappings/all/{pm_uuid}/test/ |
[**propertymappings_all_types_list**](PropertymappingsApi.md#propertymappings_all_types_list) | **GET** /propertymappings/all/types/ |
[**propertymappings_all_used_by_list**](PropertymappingsApi.md#propertymappings_all_used_by_list) | **GET** /propertymappings/all/{pm_uuid}/used_by/ |
[**propertymappings_ldap_create**](PropertymappingsApi.md#propertymappings_ldap_create) | **POST** /propertymappings/ldap/ |
[**propertymappings_ldap_destroy**](PropertymappingsApi.md#propertymappings_ldap_destroy) | **DELETE** /propertymappings/ldap/{pm_uuid}/ |
[**propertymappings_ldap_list**](PropertymappingsApi.md#propertymappings_ldap_list) | **GET** /propertymappings/ldap/ |
[**propertymappings_ldap_partial_update**](PropertymappingsApi.md#propertymappings_ldap_partial_update) | **PATCH** /propertymappings/ldap/{pm_uuid}/ |
[**propertymappings_ldap_retrieve**](PropertymappingsApi.md#propertymappings_ldap_retrieve) | **GET** /propertymappings/ldap/{pm_uuid}/ |
[**propertymappings_ldap_update**](PropertymappingsApi.md#propertymappings_ldap_update) | **PUT** /propertymappings/ldap/{pm_uuid}/ |
[**propertymappings_ldap_used_by_list**](PropertymappingsApi.md#propertymappings_ldap_used_by_list) | **GET** /propertymappings/ldap/{pm_uuid}/used_by/ |
[**propertymappings_notification_create**](PropertymappingsApi.md#propertymappings_notification_create) | **POST** /propertymappings/notification/ |
[**propertymappings_notification_destroy**](PropertymappingsApi.md#propertymappings_notification_destroy) | **DELETE** /propertymappings/notification/{pm_uuid}/ |
[**propertymappings_notification_list**](PropertymappingsApi.md#propertymappings_notification_list) | **GET** /propertymappings/notification/ |
[**propertymappings_notification_partial_update**](PropertymappingsApi.md#propertymappings_notification_partial_update) | **PATCH** /propertymappings/notification/{pm_uuid}/ |
[**propertymappings_notification_retrieve**](PropertymappingsApi.md#propertymappings_notification_retrieve) | **GET** /propertymappings/notification/{pm_uuid}/ |
[**propertymappings_notification_update**](PropertymappingsApi.md#propertymappings_notification_update) | **PUT** /propertymappings/notification/{pm_uuid}/ |
[**propertymappings_notification_used_by_list**](PropertymappingsApi.md#propertymappings_notification_used_by_list) | **GET** /propertymappings/notification/{pm_uuid}/used_by/ |
[**propertymappings_rac_create**](PropertymappingsApi.md#propertymappings_rac_create) | **POST** /propertymappings/rac/ |
[**propertymappings_rac_destroy**](PropertymappingsApi.md#propertymappings_rac_destroy) | **DELETE** /propertymappings/rac/{pm_uuid}/ |
[**propertymappings_rac_list**](PropertymappingsApi.md#propertymappings_rac_list) | **GET** /propertymappings/rac/ |
[**propertymappings_rac_partial_update**](PropertymappingsApi.md#propertymappings_rac_partial_update) | **PATCH** /propertymappings/rac/{pm_uuid}/ |
[**propertymappings_rac_retrieve**](PropertymappingsApi.md#propertymappings_rac_retrieve) | **GET** /propertymappings/rac/{pm_uuid}/ |
[**propertymappings_rac_update**](PropertymappingsApi.md#propertymappings_rac_update) | **PUT** /propertymappings/rac/{pm_uuid}/ |
[**propertymappings_rac_used_by_list**](PropertymappingsApi.md#propertymappings_rac_used_by_list) | **GET** /propertymappings/rac/{pm_uuid}/used_by/ |
[**propertymappings_saml_create**](PropertymappingsApi.md#propertymappings_saml_create) | **POST** /propertymappings/saml/ |
[**propertymappings_saml_destroy**](PropertymappingsApi.md#propertymappings_saml_destroy) | **DELETE** /propertymappings/saml/{pm_uuid}/ |
[**propertymappings_saml_list**](PropertymappingsApi.md#propertymappings_saml_list) | **GET** /propertymappings/saml/ |
[**propertymappings_saml_partial_update**](PropertymappingsApi.md#propertymappings_saml_partial_update) | **PATCH** /propertymappings/saml/{pm_uuid}/ |
[**propertymappings_saml_retrieve**](PropertymappingsApi.md#propertymappings_saml_retrieve) | **GET** /propertymappings/saml/{pm_uuid}/ |
[**propertymappings_saml_update**](PropertymappingsApi.md#propertymappings_saml_update) | **PUT** /propertymappings/saml/{pm_uuid}/ |
[**propertymappings_saml_used_by_list**](PropertymappingsApi.md#propertymappings_saml_used_by_list) | **GET** /propertymappings/saml/{pm_uuid}/used_by/ |
[**propertymappings_scim_create**](PropertymappingsApi.md#propertymappings_scim_create) | **POST** /propertymappings/scim/ |
[**propertymappings_scim_destroy**](PropertymappingsApi.md#propertymappings_scim_destroy) | **DELETE** /propertymappings/scim/{pm_uuid}/ |
[**propertymappings_scim_list**](PropertymappingsApi.md#propertymappings_scim_list) | **GET** /propertymappings/scim/ |
[**propertymappings_scim_partial_update**](PropertymappingsApi.md#propertymappings_scim_partial_update) | **PATCH** /propertymappings/scim/{pm_uuid}/ |
[**propertymappings_scim_retrieve**](PropertymappingsApi.md#propertymappings_scim_retrieve) | **GET** /propertymappings/scim/{pm_uuid}/ |
[**propertymappings_scim_update**](PropertymappingsApi.md#propertymappings_scim_update) | **PUT** /propertymappings/scim/{pm_uuid}/ |
[**propertymappings_scim_used_by_list**](PropertymappingsApi.md#propertymappings_scim_used_by_list) | **GET** /propertymappings/scim/{pm_uuid}/used_by/ |
[**propertymappings_scope_create**](PropertymappingsApi.md#propertymappings_scope_create) | **POST** /propertymappings/scope/ |
[**propertymappings_scope_destroy**](PropertymappingsApi.md#propertymappings_scope_destroy) | **DELETE** /propertymappings/scope/{pm_uuid}/ |
[**propertymappings_scope_list**](PropertymappingsApi.md#propertymappings_scope_list) | **GET** /propertymappings/scope/ |
[**propertymappings_scope_partial_update**](PropertymappingsApi.md#propertymappings_scope_partial_update) | **PATCH** /propertymappings/scope/{pm_uuid}/ |
[**propertymappings_scope_retrieve**](PropertymappingsApi.md#propertymappings_scope_retrieve) | **GET** /propertymappings/scope/{pm_uuid}/ |
[**propertymappings_scope_update**](PropertymappingsApi.md#propertymappings_scope_update) | **PUT** /propertymappings/scope/{pm_uuid}/ |
[**propertymappings_scope_used_by_list**](PropertymappingsApi.md#propertymappings_scope_used_by_list) | **GET** /propertymappings/scope/{pm_uuid}/used_by/ |
## propertymappings_all_destroy
> propertymappings_all_destroy(pm_uuid)
PropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Property Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_all_list
> models::PaginatedPropertyMappingList propertymappings_all_list(managed__isnull, ordering, page, page_size, search)
PropertyMapping Viewset
### Parameters
**managed__isnull** | Option<**bool**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedPropertyMappingList**](PaginatedPropertyMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_all_retrieve
> models::PropertyMapping propertymappings_all_retrieve(pm_uuid)
PropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Property Mapping. | [required] |
### Return type
[**models::PropertyMapping**](PropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_all_test_create
> models::PropertyMappingTestResult propertymappings_all_test_create(pm_uuid, policy_test_request, format_result)
Test Property Mapping
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Property Mapping. | [required] |
**policy_test_request** | [**PolicyTestRequest**](PolicyTestRequest.md) | | [required] |
**format_result** | Option<**bool**> | | |
### Return type
[**models::PropertyMappingTestResult**](PropertyMappingTestResult.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_all_types_list
> Vec<models::TypeCreate> propertymappings_all_types_list()
Get all creatable property-mapping types
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<models::TypeCreate>**](TypeCreate.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_all_used_by_list
> Vec<models::UsedBy> propertymappings_all_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Property Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_create
> models::LdapPropertyMapping propertymappings_ldap_create(ldap_property_mapping_request)
LDAP PropertyMapping Viewset
### Parameters
**ldap_property_mapping_request** | [**LdapPropertyMappingRequest**](LdapPropertyMappingRequest.md) | | [required] |
### Return type
[**models::LdapPropertyMapping**](LDAPPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_destroy
> propertymappings_ldap_destroy(pm_uuid)
LDAP PropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this LDAP Property Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_list
> models::PaginatedLdapPropertyMappingList propertymappings_ldap_list(expression, managed, name, object_field, ordering, page, page_size, pm_uuid, search)
LDAP PropertyMapping Viewset
### Parameters
**expression** | Option<**String**> | | |
**managed** | Option<[**Vec<String>**](String.md)> | | |
**name** | Option<**String**> | | |
**object_field** | Option<**String**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**pm_uuid** | Option<**uuid::Uuid**> | | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedLdapPropertyMappingList**](PaginatedLDAPPropertyMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_partial_update
> models::LdapPropertyMapping propertymappings_ldap_partial_update(pm_uuid, patched_ldap_property_mapping_request)
LDAP PropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this LDAP Property Mapping. | [required] |
**patched_ldap_property_mapping_request** | Option<[**PatchedLdapPropertyMappingRequest**](PatchedLdapPropertyMappingRequest.md)> | | |
### Return type
[**models::LdapPropertyMapping**](LDAPPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_retrieve
> models::LdapPropertyMapping propertymappings_ldap_retrieve(pm_uuid)
LDAP PropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this LDAP Property Mapping. | [required] |
### Return type
[**models::LdapPropertyMapping**](LDAPPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_update
> models::LdapPropertyMapping propertymappings_ldap_update(pm_uuid, ldap_property_mapping_request)
LDAP PropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this LDAP Property Mapping. | [required] |
**ldap_property_mapping_request** | [**LdapPropertyMappingRequest**](LdapPropertyMappingRequest.md) | | [required] |
### Return type
[**models::LdapPropertyMapping**](LDAPPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_ldap_used_by_list
> Vec<models::UsedBy> propertymappings_ldap_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this LDAP Property Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_create
> models::NotificationWebhookMapping propertymappings_notification_create(notification_webhook_mapping_request)
NotificationWebhookMapping Viewset
### Parameters
**notification_webhook_mapping_request** | [**NotificationWebhookMappingRequest**](NotificationWebhookMappingRequest.md) | | [required] |
### Return type
[**models::NotificationWebhookMapping**](NotificationWebhookMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_destroy
> propertymappings_notification_destroy(pm_uuid)
NotificationWebhookMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Webhook Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_list
> models::PaginatedNotificationWebhookMappingList propertymappings_notification_list(name, ordering, page, page_size, search)
NotificationWebhookMapping Viewset
### Parameters
**name** | Option<**String**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedNotificationWebhookMappingList**](PaginatedNotificationWebhookMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_partial_update
> models::NotificationWebhookMapping propertymappings_notification_partial_update(pm_uuid, patched_notification_webhook_mapping_request)
NotificationWebhookMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Webhook Mapping. | [required] |
**patched_notification_webhook_mapping_request** | Option<[**PatchedNotificationWebhookMappingRequest**](PatchedNotificationWebhookMappingRequest.md)> | | |
### Return type
[**models::NotificationWebhookMapping**](NotificationWebhookMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_retrieve
> models::NotificationWebhookMapping propertymappings_notification_retrieve(pm_uuid)
NotificationWebhookMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Webhook Mapping. | [required] |
### Return type
[**models::NotificationWebhookMapping**](NotificationWebhookMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_update
> models::NotificationWebhookMapping propertymappings_notification_update(pm_uuid, notification_webhook_mapping_request)
NotificationWebhookMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Webhook Mapping. | [required] |
**notification_webhook_mapping_request** | [**NotificationWebhookMappingRequest**](NotificationWebhookMappingRequest.md) | | [required] |
### Return type
[**models::NotificationWebhookMapping**](NotificationWebhookMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_notification_used_by_list
> Vec<models::UsedBy> propertymappings_notification_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Webhook Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_create
> models::RacPropertyMapping propertymappings_rac_create(rac_property_mapping_request)
RACPropertyMapping Viewset
### Parameters
**rac_property_mapping_request** | [**RacPropertyMappingRequest**](RacPropertyMappingRequest.md) | | [required] |
### Return type
[**models::RacPropertyMapping**](RACPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_destroy
> propertymappings_rac_destroy(pm_uuid)
RACPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this RAC Property Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_list
> models::PaginatedRacPropertyMappingList propertymappings_rac_list(managed, name, ordering, page, page_size, search)
RACPropertyMapping Viewset
### Parameters
**managed** | Option<[**Vec<String>**](String.md)> | | |
**name** | Option<**String**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedRacPropertyMappingList**](PaginatedRACPropertyMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_partial_update
> models::RacPropertyMapping propertymappings_rac_partial_update(pm_uuid, patched_rac_property_mapping_request)
RACPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this RAC Property Mapping. | [required] |
**patched_rac_property_mapping_request** | Option<[**PatchedRacPropertyMappingRequest**](PatchedRacPropertyMappingRequest.md)> | | |
### Return type
[**models::RacPropertyMapping**](RACPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_retrieve
> models::RacPropertyMapping propertymappings_rac_retrieve(pm_uuid)
RACPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this RAC Property Mapping. | [required] |
### Return type
[**models::RacPropertyMapping**](RACPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_update
> models::RacPropertyMapping propertymappings_rac_update(pm_uuid, rac_property_mapping_request)
RACPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this RAC Property Mapping. | [required] |
**rac_property_mapping_request** | [**RacPropertyMappingRequest**](RacPropertyMappingRequest.md) | | [required] |
### Return type
[**models::RacPropertyMapping**](RACPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_rac_used_by_list
> Vec<models::UsedBy> propertymappings_rac_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this RAC Property Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_create
> models::SamlPropertyMapping propertymappings_saml_create(saml_property_mapping_request)
SAMLPropertyMapping Viewset
### Parameters
**saml_property_mapping_request** | [**SamlPropertyMappingRequest**](SamlPropertyMappingRequest.md) | | [required] |
### Return type
[**models::SamlPropertyMapping**](SAMLPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_destroy
> propertymappings_saml_destroy(pm_uuid)
SAMLPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SAML Property Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_list
> models::PaginatedSamlPropertyMappingList propertymappings_saml_list(expression, friendly_name, managed, name, ordering, page, page_size, pm_uuid, saml_name, search)
SAMLPropertyMapping Viewset
### Parameters
**expression** | Option<**String**> | | |
**friendly_name** | Option<**String**> | | |
**managed** | Option<[**Vec<String>**](String.md)> | | |
**name** | Option<**String**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**pm_uuid** | Option<**uuid::Uuid**> | | |
**saml_name** | Option<**String**> | | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedSamlPropertyMappingList**](PaginatedSAMLPropertyMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_partial_update
> models::SamlPropertyMapping propertymappings_saml_partial_update(pm_uuid, patched_saml_property_mapping_request)
SAMLPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SAML Property Mapping. | [required] |
**patched_saml_property_mapping_request** | Option<[**PatchedSamlPropertyMappingRequest**](PatchedSamlPropertyMappingRequest.md)> | | |
### Return type
[**models::SamlPropertyMapping**](SAMLPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_retrieve
> models::SamlPropertyMapping propertymappings_saml_retrieve(pm_uuid)
SAMLPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SAML Property Mapping. | [required] |
### Return type
[**models::SamlPropertyMapping**](SAMLPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_update
> models::SamlPropertyMapping propertymappings_saml_update(pm_uuid, saml_property_mapping_request)
SAMLPropertyMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SAML Property Mapping. | [required] |
**saml_property_mapping_request** | [**SamlPropertyMappingRequest**](SamlPropertyMappingRequest.md) | | [required] |
### Return type
[**models::SamlPropertyMapping**](SAMLPropertyMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_saml_used_by_list
> Vec<models::UsedBy> propertymappings_saml_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SAML Property Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_create
> models::ScimMapping propertymappings_scim_create(scim_mapping_request)
SCIMMapping Viewset
### Parameters
**scim_mapping_request** | [**ScimMappingRequest**](ScimMappingRequest.md) | | [required] |
### Return type
[**models::ScimMapping**](SCIMMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_destroy
> propertymappings_scim_destroy(pm_uuid)
SCIMMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SCIM Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_list
> models::PaginatedScimMappingList propertymappings_scim_list(expression, managed, name, ordering, page, page_size, pm_uuid, search)
SCIMMapping Viewset
### Parameters
**expression** | Option<**String**> | | |
**managed** | Option<[**Vec<String>**](String.md)> | | |
**name** | Option<**String**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**pm_uuid** | Option<**uuid::Uuid**> | | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedScimMappingList**](PaginatedSCIMMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_partial_update
> models::ScimMapping propertymappings_scim_partial_update(pm_uuid, patched_scim_mapping_request)
SCIMMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SCIM Mapping. | [required] |
**patched_scim_mapping_request** | Option<[**PatchedScimMappingRequest**](PatchedScimMappingRequest.md)> | | |
### Return type
[**models::ScimMapping**](SCIMMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_retrieve
> models::ScimMapping propertymappings_scim_retrieve(pm_uuid)
SCIMMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SCIM Mapping. | [required] |
### Return type
[**models::ScimMapping**](SCIMMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_update
> models::ScimMapping propertymappings_scim_update(pm_uuid, scim_mapping_request)
SCIMMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SCIM Mapping. | [required] |
**scim_mapping_request** | [**ScimMappingRequest**](ScimMappingRequest.md) | | [required] |
### Return type
[**models::ScimMapping**](SCIMMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scim_used_by_list
> Vec<models::UsedBy> propertymappings_scim_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this SCIM Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_create
> models::ScopeMapping propertymappings_scope_create(scope_mapping_request)
ScopeMapping Viewset
### Parameters
**scope_mapping_request** | [**ScopeMappingRequest**](ScopeMappingRequest.md) | | [required] |
### Return type
[**models::ScopeMapping**](ScopeMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_destroy
> propertymappings_scope_destroy(pm_uuid)
ScopeMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Scope Mapping. | [required] |
### Return type
(empty response body)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_list
> models::PaginatedScopeMappingList propertymappings_scope_list(managed, name, ordering, page, page_size, scope_name, search)
ScopeMapping Viewset
### Parameters
**managed** | Option<[**Vec<String>**](String.md)> | | |
**name** | Option<**String**> | | |
**ordering** | Option<**String**> | Which field to use when ordering the results. | |
**page** | Option<**i32**> | A page number within the paginated result set. | |
**page_size** | Option<**i32**> | Number of results to return per page. | |
**scope_name** | Option<**String**> | | |
**search** | Option<**String**> | A search term. | |
### Return type
[**models::PaginatedScopeMappingList**](PaginatedScopeMappingList.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_partial_update
> models::ScopeMapping propertymappings_scope_partial_update(pm_uuid, patched_scope_mapping_request)
ScopeMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Scope Mapping. | [required] |
**patched_scope_mapping_request** | Option<[**PatchedScopeMappingRequest**](PatchedScopeMappingRequest.md)> | | |
### Return type
[**models::ScopeMapping**](ScopeMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_retrieve
> models::ScopeMapping propertymappings_scope_retrieve(pm_uuid)
ScopeMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Scope Mapping. | [required] |
### Return type
[**models::ScopeMapping**](ScopeMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_update
> models::ScopeMapping propertymappings_scope_update(pm_uuid, scope_mapping_request)
ScopeMapping Viewset
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Scope Mapping. | [required] |
**scope_mapping_request** | [**ScopeMappingRequest**](ScopeMappingRequest.md) | | [required] |
### Return type
[**models::ScopeMapping**](ScopeMapping.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## propertymappings_scope_used_by_list
> Vec<models::UsedBy> propertymappings_scope_used_by_list(pm_uuid)
Get a list of all objects that use this object
### Parameters
**pm_uuid** | **uuid::Uuid** | A UUID string identifying this Scope Mapping. | [required] |
### Return type
[**Vec<models::UsedBy>**](UsedBy.md)
### Authorization
[authentik](../README.md#authentik)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)