collibra_core.UsersApi

All URIs are relative to http://localhost/rest/2.0

Method	HTTP request	Description
add_user	POST /users	Adds a new user
add_user_groups_for_user	POST /users/{userId}/userGroups	Add a user to multiple user groups
add_users	POST /users/bulk	Adds multiple new users
change_user	PATCH /users/{userId}	Changes the user with the information that is present in the request
change_user_avatar	PATCH /users/{userId}/avatar	Changes the avatar for the user identified by the given ID
delete_user	DELETE /users/{userId}	Deletes the user with the given ID
delete_user_avatar	DELETE /users/{userId}/avatar	Deletes the avatar for the user identified by the given ID
find_users	GET /users	Returns users matching the given search criteria
get_avatar_file	GET /users/{userId}/avatar	Get the avatar image for the user with the given ID
get_current_user	GET /users/current	Returns the current user, if logged in
get_user	GET /users/{userId}	Gets the user with the given ID
get_user_by_email_address	GET /users/email/{emailAddress}	Gets the user identified by given e-mail address
get_user_required_license_type	GET /users/{userId}/licenseType	Gets the required LicenseType for the given user
remove_user_from_user_groups	DELETE /users/{userId}/userGroups	Removes user from multiple user groups
set_user_groups_for_user	PUT /users/{userId}/userGroups	Sets user groups for the indicated user

add_user

User add_user(add_user_request=add_user_request)

Adds a new user

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    add_user_request = collibra_core.AddUserRequest() # AddUserRequest | The properties of the user to be added (optional)

    try:
        # Adds a new user
        api_response = api_instance.add_user(add_user_request=add_user_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->add_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_user_request	AddUserRequest	The properties of the user to be added	[optional]

Return type

User

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	User successfully added.	-

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

add_user_groups_for_user

list[UserGroupImpl] add_user_groups_for_user(user_id, add_user_to_user_groups_request=add_user_to_user_groups_request)

Add a user to multiple user groups

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user
add_user_to_user_groups_request = collibra_core.AddUserToUserGroupsRequest() # AddUserToUserGroupsRequest | the properties needed to add the user to the user groups (optional)

    try:
        # Add a user to multiple user groups
        api_response = api_instance.add_user_groups_for_user(user_id, add_user_to_user_groups_request=add_user_to_user_groups_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->add_user_groups_for_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user
add_user_to_user_groups_request	AddUserToUserGroupsRequest	the properties needed to add the user to the user groups	[optional]

Return type

list[UserGroupImpl]

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User successfully added to the indicated groups.	-
404	User with given ID not found	-

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

add_users

list[User] add_users(add_user_request=add_user_request)

Adds multiple new users

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    add_user_request = [collibra_core.AddUserRequest()] # list[AddUserRequest] | The properties of the users to be added (optional)

    try:
        # Adds multiple new users
        api_response = api_instance.add_users(add_user_request=add_user_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->add_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
add_user_request	list[AddUserRequest]	The properties of the users to be added	[optional]

Return type

list[User]

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Users successfully added.	-

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

change_user

User change_user(user_id, change_user_request=change_user_request)

Changes the user with the information that is present in the request

Only properties that are specified in this request and have non-null values are updated. All other properties are ignored.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user to be changed
change_user_request = collibra_core.ChangeUserRequest() # ChangeUserRequest | the properties of the user to be changed (optional)

    try:
        # Changes the user with the information that is present in the request
        api_response = api_instance.change_user(user_id, change_user_request=change_user_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->change_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user to be changed
change_user_request	ChangeUserRequest	the properties of the user to be changed	[optional]

Return type

User

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User successfully changed	-
404	User with given ID not found	-

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

change_user_avatar

User change_user_avatar(user_id, change_user_avatar_request=change_user_avatar_request)

Changes the avatar for the user identified by the given ID

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user to change the avatar for
change_user_avatar_request = collibra_core.ChangeUserAvatarRequest() # ChangeUserAvatarRequest | the properties needed to change to avatar for the user (optional)

    try:
        # Changes the avatar for the user identified by the given ID
        api_response = api_instance.change_user_avatar(user_id, change_user_avatar_request=change_user_avatar_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->change_user_avatar: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user to change the avatar for
change_user_avatar_request	ChangeUserAvatarRequest	the properties needed to change to avatar for the user	[optional]

Return type

User

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User avatar successfully changed	-
404	User with given ID not found	-

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

delete_user

delete_user(user_id)

Deletes the user with the given ID

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user to be deleted

    try:
        # Deletes the user with the given ID
        api_instance.delete_user(user_id)
    except ApiException as e:
        print("Exception when calling UsersApi->delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user to be deleted

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	User successfully deleted	-
404	User with given ID not found	-

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

delete_user_avatar

delete_user_avatar(user_id)

Deletes the avatar for the user identified by the given ID

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user to delete the avatar for

    try:
        # Deletes the avatar for the user identified by the given ID
        api_instance.delete_user_avatar(user_id)
    except ApiException as e:
        print("Exception when calling UsersApi->delete_user_avatar: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user to delete the avatar for

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	User avatar successfully deleted	-
404	User with given ID not found	-

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

find_users

UserPagedResponse find_users(offset=offset, limit=limit, user_id=user_id, name=name, group_id=group_id, only_logged_in=only_logged_in, include_disabled=include_disabled)

Returns users matching the given search criteria

Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

The returned users satisfy all constraints that are specified in this search criteria.

By default a result containing 1000 users is returned.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    offset = 0 # int | The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>. (optional) (default to 0)
limit = 0 # int | The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. (optional) (default to 0)
user_id = ['user_id_example'] # list[str] | Comma-separated list of user IDs to look for. Alternatively, you can pass this query parameter multiple times. (optional)
name = 'name_example' # str | The name of the user. The search will occur in the username, first name, last name, and a combination of those. (optional)
group_id = 'group_id_example' # str | The ID of the group the searched users should belong to. (optional)
only_logged_in = True # bool | Whether only currently logged in users should be returned. (optional)
include_disabled = True # bool | Whether disabled users should be included in the search results. (optional)

    try:
        # Returns users matching the given search criteria
        api_response = api_instance.find_users(offset=offset, limit=limit, user_id=user_id, name=name, group_id=group_id, only_logged_in=only_logged_in, include_disabled=include_disabled)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->find_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
offset	int	The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.	[optional] [default to 0]
limit	int	The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used.	[optional] [default to 0]
user_id	list[str]	Comma-separated list of user IDs to look for. Alternatively, you can pass this query parameter multiple times.	[optional]
name	str	The name of the user. The search will occur in the username, first name, last name, and a combination of those.	[optional]
group_id	str	The ID of the group the searched users should belong to.	[optional]
only_logged_in	bool	Whether only currently logged in users should be returned.	[optional]
include_disabled	bool	Whether disabled users should be included in the search results.	[optional]

Return type

UserPagedResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Users successfully retrieved	-

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

get_avatar_file

file get_avatar_file(user_id, width=width, height=height)

Get the avatar image for the user with the given ID

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | The ID of the user to get the avatar for
width = 56 # int | The width of the returned avatar (optional)
height = 56 # int | The height of the returned avatar (optional)

    try:
        # Get the avatar image for the user with the given ID
        api_response = api_instance.get_avatar_file(user_id, width=width, height=height)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->get_avatar_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The ID of the user to get the avatar for
width	int	The width of the returned avatar	[optional]
height	int	The height of the returned avatar	[optional]

Return type

file

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Avatar image successfully retrieved	-
404	User with given ID not found	-

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

get_current_user

User get_current_user()

Returns the current user, if logged in

If the user is not logged in, null is returned

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    
    try:
        # Returns the current user, if logged in
        api_response = api_instance.get_current_user()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->get_current_user: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	User succesfully retrieved	-

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

get_user

User get_user(user_id)

Gets the user with the given ID

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | The ID of the user

    try:
        # Gets the user with the given ID
        api_response = api_instance.get_user(user_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->get_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The ID of the user

Return type

User

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	User successfully retrieved	-
404	User with given ID not found	-

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

get_user_by_email_address

User get_user_by_email_address(email_address)

Gets the user identified by given e-mail address

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    email_address = 'email_address_example' # str | The e-mail address of the user

    try:
        # Gets the user identified by given e-mail address
        api_response = api_instance.get_user_by_email_address(email_address)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->get_user_by_email_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
email_address	str	The e-mail address of the user

Return type

User

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	User successfully retrieved	-
404	User with given e-mail not found	-

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

get_user_required_license_type

str get_user_required_license_type(user_id)

Gets the required LicenseType for the given user

This endpoint will be removed in the next major release.

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user

    try:
        # Gets the required LicenseType for the given user
        api_response = api_instance.get_user_required_license_type(user_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->get_user_required_license_type: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user

Return type

str

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	LicenseType successfully retrieved	-
404	User with given ID not found	-

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

remove_user_from_user_groups

remove_user_from_user_groups(user_id, remove_user_from_user_groups_request=remove_user_from_user_groups_request)

Removes user from multiple user groups

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | The ID of the user
remove_user_from_user_groups_request = collibra_core.RemoveUserFromUserGroupsRequest() # RemoveUserFromUserGroupsRequest | The properties needed to remove the user from user groups (optional)

    try:
        # Removes user from multiple user groups
        api_instance.remove_user_from_user_groups(user_id, remove_user_from_user_groups_request=remove_user_from_user_groups_request)
    except ApiException as e:
        print("Exception when calling UsersApi->remove_user_from_user_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	The ID of the user
remove_user_from_user_groups_request	RemoveUserFromUserGroupsRequest	The properties needed to remove the user from user groups	[optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	User successfully removed from user groups	-
404	User with given ID not found	-

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

set_user_groups_for_user

User set_user_groups_for_user(user_id, set_user_groups_for_user_request=set_user_groups_for_user_request)

Sets user groups for the indicated user

Example

Basic Authentication (basicAuth):

from __future__ import print_function
import time
import collibra_core
from collibra_core.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/rest/2.0
# See configuration.py for a list of all supported configuration parameters.
configuration = collibra_core.Configuration(
    host = "http://localhost/rest/2.0"
)

# 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: basicAuth
configuration = collibra_core.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with collibra_core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = collibra_core.UsersApi(api_client)
    user_id = 'user_id_example' # str | the ID of the user
set_user_groups_for_user_request = collibra_core.SetUserGroupsForUserRequest() # SetUserGroupsForUserRequest | the properties needed to add the user to user groups (optional)

    try:
        # Sets user groups for the indicated user
        api_response = api_instance.set_user_groups_for_user(user_id, set_user_groups_for_user_request=set_user_groups_for_user_request)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling UsersApi->set_user_groups_for_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	str	the ID of the user
set_user_groups_for_user_request	SetUserGroupsForUserRequest	the properties needed to add the user to user groups	[optional]

Return type

User

Authorization

basicAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	User groups set successfully	-
404	User with given ID not found	-

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

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

collibra_core.UsersApi

add_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_user_groups_for_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

change_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

change_user_avatar

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_user_avatar

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

find_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_avatar_file

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_current_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user

Example

Parameters