2
0
openapi-client-udm/docs/SettingsPortalAllApi.md
Adam Goldsmith 98daa460a6 Autogenerated using update_openapi_client from udm-rest-client
Actual generator command:

```bash
java -jar openapi-generator-cli-5.4.0.jar generate -g python-legacy \
  --library asyncio \
  --package-name openapi_client_udm \
  --additional-properties=packageVersion=1.0.2 \
  -i udm_openapi.json \
  -o ./python
```
2023-11-27 20:21:43 -05:00

13 KiB

openapi_client_udm.SettingsPortalAllApi

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

Method HTTP request Description
udm_settings_portal_all_object GET /settings/portal_all/{dn} Get a representation of the Deprecated Portal: Settings object with all its properties, policies, options, metadata and references. Includes also instructions how to modify, remove or move the object.
udm_settings_portal_all_object_search GET /settings/portal_all/ Search for Deprecated Portal: Settings objects

udm_settings_portal_all_object

SettingsPortalAll udm_settings_portal_all_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 Deprecated Portal: Settings 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):
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.SettingsPortalAllApi(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 Deprecated Portal: Settings 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_settings_portal_all_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 SettingsPortalAllApi->udm_settings_portal_all_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

SettingsPortalAll

Authorization

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 -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
401 Unauthorized. No Authorization provided or wrong credentials. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
403 Forbidden (e.g. unsupported operation) * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
422 Validation of input parameters failed. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
500 Internal server errror. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
503 (LDAP) Server not available. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Retry-After -
502 (LDAP) Server not available. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Retry-After -
504 (LDAP) Server not available. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Retry-After -
200 Success * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Etag -
* Last-Modified -
404 Object not found. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -

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

udm_settings_portal_all_object_search

SettingsPortalAllList udm_settings_portal_all_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, 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)

Search for Deprecated Portal: Settings objects

Information about the object type and links to search for objects. The found objects are either referenced as HAL links or embedded via HAL embedded resources.

Example

  • Basic Authentication (basic):
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.SettingsPortalAllApi(api_client)
    filter = '' # str | A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. (optional) (default to '')
position = 'null' # str | Position which is used as search base. (optional) (default to 'null')
scope = 'sub' # str | The LDAP search scope (sub, base, one). (optional) (default to 'sub')
query = None # dict(str, object) | The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. (optional)
hidden = True # bool | Include hidden/system objects in the response. (optional) (default to True)
properties = ["*"] # list[str] | The properties which should be returned, if not given all properties are returned. (optional) (default to ["*"])
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:
        # Search for Deprecated Portal: Settings objects
        api_response = api_instance.udm_settings_portal_all_object_search(filter=filter, position=position, scope=scope, query=query, hidden=hidden, properties=properties, 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 SettingsPortalAllApi->udm_settings_portal_all_object_search: %s\n" % e)

Parameters

Name Type Description Notes
filter str A LDAP filter which may contain `UDM` property names instead of `LDAP` attribute names. [optional] [default to '']
position str Position which is used as search base. [optional] [default to 'null']
scope str The LDAP search scope (sub, base, one). [optional] [default to 'sub']
query dict(str, object) The values to search for (propertyname and search filter value). Alternatively with `filter` a raw LDAP filter can be given. [optional]
hidden bool Include hidden/system objects in the response. [optional] [default to True]
properties **list[str]** The properties which should be returned, if not given all properties are returned. [optional] [default to ["*"]]
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

SettingsPortalAllList

Authorization

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 -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
401 Unauthorized. No Authorization provided or wrong credentials. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
403 Forbidden (e.g. unsupported operation) * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
422 Validation of input parameters failed. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
500 Internal server errror. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
503 (LDAP) Server not available. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Retry-After -
502 (LDAP) Server not available. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Retry-After -
504 (LDAP) Server not available. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -
* Retry-After -
200 Successfull search (if query parameters were given) or a object type overview. * Cache-Control -
* Expires -
* Vary -
* Content-Language -
* Link -
* X-Request-Id -

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