openapi-client-udm/docs/UsersPasswdApi.md

# openapi_client_udm.UsersPasswdApi

All URIs are relative to *https://ucs.sawtooth.claremontmakerspace.org/univention/udm*

Method | HTTP request | Description
------------- | ------------- | -------------
[**udm_users_passwd_object**](UsersPasswdApi.md#udm_users_passwd_object) | **GET** /users/passwd/{dn} |  Get a representation of the Password object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object. 
[**udm_users_passwd_object_modify**](UsersPasswdApi.md#udm_users_passwd_object_modify) | **PUT** /users/passwd/{dn} | Modify or move an Password object
[**udm_users_passwd_object_update**](UsersPasswdApi.md#udm_users_passwd_object_update) | **PATCH** /users/passwd/{dn} | Modify an Password object (moving is currently not possible)


# **udm_users_passwd_object**
> UsersPasswd udm_users_passwd_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)

 Get a representation of the Password object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object. 

### Example

* Basic Authentication (basic):
```python
from __future__ import print_function
import time
import openapi_client_udm
from openapi_client_udm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client_udm.Configuration(
    host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic
configuration = openapi_client_udm.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with openapi_client_udm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client_udm.UsersPasswdApi(api_client)
    dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
user_agent = '' # str | The user agent. (optional)
accept_language = '' # str | The accepted response languages. (optional)
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)

    try:
        #  Get a representation of the Password object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object. 
        api_response = api_instance.udm_users_passwd_object(dn, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersPasswdApi->udm_users_passwd_object: %s\n" % e)
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). | 
 **user_agent** | **str**| The user agent. | [optional] 
 **accept_language** | **str**| The accepted response languages. | [optional] 
 **if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional] 
 **if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional] 
 **x_request_id** | **str**| A request-ID used for logging and tracing. | [optional] 

### Return type

[**UsersPasswd**](UsersPasswd.md)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/hal+json, text/html

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Bad request syntax. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**401** | Unauthorized. No Authorization provided or wrong credentials. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**403** | Forbidden (e.g. unsupported operation) |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**422** | Validation of input parameters failed. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**500** | Internal server errror. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**503** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**502** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**504** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**200** | Success |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Etag -  <br>  * Last-Modified -  <br>  |
**404** | Object not found. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |

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

# **udm_users_passwd_object_modify**
> InlineResponse201 udm_users_passwd_object_modify(dn, users_passwd, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)

Modify or move an Password object

### Example

* Basic Authentication (basic):
```python
from __future__ import print_function
import time
import openapi_client_udm
from openapi_client_udm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client_udm.Configuration(
    host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic
configuration = openapi_client_udm.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with openapi_client_udm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client_udm.UsersPasswdApi(api_client)
    dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
users_passwd = openapi_client_udm.UsersPasswd() # UsersPasswd | 
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
user_agent = '' # str | The user agent. (optional)
accept_language = '' # str | The accepted response languages. (optional)
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)

    try:
        # Modify or move an Password object
        api_response = api_instance.udm_users_passwd_object_modify(dn, users_passwd, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersPasswdApi->udm_users_passwd_object_modify: %s\n" % e)
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). | 
 **users_passwd** | [**UsersPasswd**](UsersPasswd.md)|  | 
 **if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional] 
 **if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional] 
 **user_agent** | **str**| The user agent. | [optional] 
 **accept_language** | **str**| The accepted response languages. | [optional] 
 **if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional] 
 **if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional] 
 **x_request_id** | **str**| A request-ID used for logging and tracing. | [optional] 

### Return type

[**InlineResponse201**](InlineResponse201.md)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/hal+json, text/html

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Bad request syntax. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**401** | Unauthorized. No Authorization provided or wrong credentials. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**403** | Forbidden (e.g. unsupported operation) |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**422** | Validation of input parameters failed. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**500** | Internal server errror. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**503** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**502** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**504** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**201** | Created: The object did not exist and has been created. Deprecated: a move operation started, expect 202 in the future! |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Etag -  <br>  * Last-Modified -  <br>  |
**202** | Accepted: asynchronous move or rename operation started. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Location -  <br>  |
**204** | Success. No response data. A link to the modified resource in the &#x60;Location&#x60; header. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Location -  <br>  * Etag -  <br>  * Last-Modified -  <br>  |
**404** | Object not found. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |

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

# **udm_users_passwd_object_update**
> udm_users_passwd_object_update(dn, users_passwd, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)

Modify an Password object (moving is currently not possible)

### Example

* Basic Authentication (basic):
```python
from __future__ import print_function
import time
import openapi_client_udm
from openapi_client_udm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://ucs.sawtooth.claremontmakerspace.org/univention/udm
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client_udm.Configuration(
    host = "https://ucs.sawtooth.claremontmakerspace.org/univention/udm"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic
configuration = openapi_client_udm.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with openapi_client_udm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client_udm.UsersPasswdApi(api_client)
    dn = 'dn_example' # str | The (urlencoded) LDAP Distinguished Name (DN).
users_passwd = openapi_client_udm.UsersPasswd() # UsersPasswd | 
if_match = '' # str | Provide entity tag to make a conditional request to not overwrite any values in a race condition. (optional)
if_unmodified_since = 'if_unmodified_since_example' # str | Provide last modified time to make a conditional request to not overwrite any values in a race condition. (optional)
user_agent = '' # str | The user agent. (optional)
accept_language = '' # str | The accepted response languages. (optional)
if_none_match = '' # str | Use request from cache by using the Etag entity tag if it matches. (optional)
if_modified_since = '' # str | Use request from cache by using the Last-Modified date if it matches. (optional)
x_request_id = '' # str | A request-ID used for logging and tracing. (optional)

    try:
        # Modify an Password object (moving is currently not possible)
        api_instance.udm_users_passwd_object_update(dn, users_passwd, if_match=if_match, if_unmodified_since=if_unmodified_since, user_agent=user_agent, accept_language=accept_language, if_none_match=if_none_match, if_modified_since=if_modified_since, x_request_id=x_request_id)
    except ApiException as e:
        print("Exception when calling UsersPasswdApi->udm_users_passwd_object_update: %s\n" % e)
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dn** | **str**| The (urlencoded) LDAP Distinguished Name (DN). | 
 **users_passwd** | [**UsersPasswd**](UsersPasswd.md)|  | 
 **if_match** | **str**| Provide entity tag to make a conditional request to not overwrite any values in a race condition. | [optional] 
 **if_unmodified_since** | **str**| Provide last modified time to make a conditional request to not overwrite any values in a race condition. | [optional] 
 **user_agent** | **str**| The user agent. | [optional] 
 **accept_language** | **str**| The accepted response languages. | [optional] 
 **if_none_match** | **str**| Use request from cache by using the Etag entity tag if it matches. | [optional] 
 **if_modified_since** | **str**| Use request from cache by using the Last-Modified date if it matches. | [optional] 
 **x_request_id** | **str**| A request-ID used for logging and tracing. | [optional] 

### Return type

void (empty response body)

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/hal+json, text/html

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**400** | Bad request syntax. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**401** | Unauthorized. No Authorization provided or wrong credentials. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**403** | Forbidden (e.g. unsupported operation) |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**422** | Validation of input parameters failed. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**500** | Internal server errror. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |
**503** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**502** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**504** | (LDAP) Server not available. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Retry-After -  <br>  |
**204** | Success. No response data. A link to the modified resource in the &#x60;Location&#x60; header. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  * Location -  <br>  * Etag -  <br>  * Last-Modified -  <br>  |
**404** | Object not found. |  * Cache-Control -  <br>  * Expires -  <br>  * Vary -  <br>  * Content-Language -  <br>  * Link -  <br>  * X-Request-Id -  <br>  |

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