director-sdk

cloudera.director.UsersApi

All URIs are relative to https://localhost

Method	HTTP request	Description
create	POST /api/d6.2/users	Create a new user
current_redacted	GET /api/d6.2/users/current	Get the current user
delete	DELETE /api/d6.2/users/{username}	Delete a user by username
get_redacted	GET /api/d6.2/users/{username}	Get a user by username
get_user_management_status	GET /api/d6.2/users/managementStatus	Gets user management status
list	GET /api/d6.2/users	List all users
update	PUT /api/d6.2/users/{username}	Update an existing user
update_password	PUT /api/d6.2/users/{username}/password	Update the password of an existing user

create

create(user)

Create a new user

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))
user = cloudera.director.User() # User | 

try:
    # Create a new user
    api_instance.create(user)
except ApiException as e:
    print("Exception when calling UsersApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	User

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

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

current_redacted

User current_redacted()

Get the current user

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))

try:
    # Get the current user
    api_response = api_instance.current_redacted()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->current_redacted: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

User

Authorization

basic

HTTP request headers

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

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

delete

delete(username)

Delete a user by username

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))
username = 'username_example' # str | 

try:
    # Delete a user by username
    api_instance.delete(username)
except ApiException as e:
    print("Exception when calling UsersApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

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

get_redacted

User get_redacted(username)

Get a user by username

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))
username = 'username_example' # str | 

try:
    # Get a user by username
    api_response = api_instance.get_redacted(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->get_redacted: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str

Return type

User

Authorization

basic

HTTP request headers

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

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

get_user_management_status

UserManagementStatus get_user_management_status()

Gets user management status

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))

try:
    # Gets user management status
    api_response = api_instance.get_user_management_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->get_user_management_status: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserManagementStatus

Authorization

basic

HTTP request headers

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

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

list

list[str] list()

List all users

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))

try:
    # List all users
    api_response = api_instance.list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[str]

Authorization

basic

HTTP request headers

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

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

update

update(username, user)

Update an existing user

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))
username = 'username_example' # str | 
user = cloudera.director.User() # User | 

try:
    # Update an existing user
    api_instance.update(username, user)
except ApiException as e:
    print("Exception when calling UsersApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str
user	User

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

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

update_password

update_password(username, passwords)

Update the password of an existing user

Example

from __future__ import print_function
import time
import cloudera.director
from cloudera.director.rest import ApiException
from pprint import pprint

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

# create an instance of the API class
api_instance = cloudera.director.UsersApi(cloudera.director.ApiClient(configuration))
username = 'username_example' # str | 
passwords = cloudera.director.PasswordChange() # PasswordChange | 

try:
    # Update the password of an existing user
    api_instance.update_password(username, passwords)
except ApiException as e:
    print("Exception when calling UsersApi->update_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str
passwords	PasswordChange

Return type

void (empty response body)

Authorization

basic

HTTP request headers

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

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

This site is open source. Improve this page.