onelogin.UsersV1Api

All URIs are relative to https://your-api-subdomain.onelogin.com

Method	HTTP request	Description
add_roles_to_user	PUT /api/1/users/{user_id}/add_roles	Add Roles for a User
create_user	POST /api/1/users	Create a User
delete_user	DELETE /api/1/users/{user_id}	Delete a User
get_custom_attributes	GET /api/1/users/custom_attributes	Get Custom Attributes
get_user_apps	GET /api/1/users/{user_id}/apps	Get Apps for a User
get_user_by_id	GET /api/1/users/{user_id}	Get User by ID
get_user_roles	GET /api/1/users/{user_id}/roles	Get Roles for a User
list_users	GET /api/1/users	List Users
lock_account_user	PUT /api/1/users/{user_id}/lock_user	Lock User Account
log_out_user	PUT /api/1/users/{user_id}/logout	Log User Out
remove_user_role	PUT /api/1/users/{user_id}/remove_roles	Remove Roles for a User
set_user_state	PUT /api/1/users/{user_id}/set_state	Set User State
update_password_insecure	PUT /api/1/users/set_password_clear_text/{user_id}	Set Password Using ID in Cleartext
update_password_secure	PUT /api/1/users/set_password_using_salt/{user_id}	Set Password Using ID and SHA-256 and Salt
update_user	PUT /api/1/users/{user_id}	Update a User

add_roles_to_user

Error add_roles_to_user(user_id, add_roles_to_user_request=add_roles_to_user_request)

Add Roles for a User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    add_roles_to_user_request = onelogin.AddRolesToUserRequest() # AddRolesToUserRequest |  (optional)

    try:
        # Add Roles for a User
        api_response = api_instance.add_roles_to_user(user_id, add_roles_to_user_request=add_roles_to_user_request)
        print("The response of UsersV1Api->add_roles_to_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->add_roles_to_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
add_roles_to_user_request	AddRolesToUserRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

create_user

User create_user(mappings=mappings, validate_policy=validate_policy, user=user)

Create a User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    mappings = 'mappings_example' # str | Controls how mappings will be applied to the user on creation. Defaults to async. (optional)
    validate_policy = True # bool | Will passwords validate against the User Policy? Defaults to true. (optional)
    user = onelogin.User() # User |  (optional)

    try:
        # Create a User
        api_response = api_instance.create_user(mappings=mappings, validate_policy=validate_policy, user=user)
        print("The response of UsersV1Api->create_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
mappings	str	Controls how mappings will be applied to the user on creation. Defaults to async.	[optional]
validate_policy	bool	Will passwords validate against the User Policy? Defaults to true.	[optional]
user	User		[optional]

Return type

User

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	The full user resource is returned	-
400	Bad Request	-
401	Unauthorized	-
422	Unprocessable	-

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

delete_user

delete_user(user_id)

Delete a User

Delete A User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.

    try:
        # Delete a User
        api_instance.delete_user(user_id)
    except Exception as e:
        print("Exception when calling UsersV1Api->delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	On success, no content is returned in the response body.	-
401	Unauthorized	-
404	Not Found	-

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

get_custom_attributes

GetCustomAttributes200Response get_custom_attributes()

Get Custom Attributes

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)

    try:
        # Get Custom Attributes
        api_response = api_instance.get_custom_attributes()
        print("The response of UsersV1Api->get_custom_attributes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->get_custom_attributes: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

GetCustomAttributes200Response

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-

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

get_user_apps

List[GetUserApps200ResponseInner] get_user_apps(user_id, ignore_visibility=ignore_visibility)

Get Apps for a User

Get Apps for User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    ignore_visibility = False # bool | Defaults to `false`. When `true` will show all apps that are assigned to a user regardless of their portal visibility setting. (optional) (default to False)

    try:
        # Get Apps for a User
        api_response = api_instance.get_user_apps(user_id, ignore_visibility=ignore_visibility)
        print("The response of UsersV1Api->get_user_apps:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->get_user_apps: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
ignore_visibility	bool	Defaults to `false`. When `true` will show all apps that are assigned to a user regardless of their portal visibility setting.	[optional] [default to False]

Return type

List[GetUserApps200ResponseInner]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	Not Found	-

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

get_user_by_id

User get_user_by_id(user_id)

Get User by ID

Get User By ID

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.

    try:
        # Get User by ID
        api_response = api_instance.get_user_by_id(user_id)
        print("The response of UsersV1Api->get_user_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->get_user_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.

Return type

User

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
404	Not Found	-

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

get_user_roles

GetUserRoles200Response get_user_roles(user_id)

Get Roles for a User

Get User Roles

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.

    try:
        # Get Roles for a User
        api_response = api_instance.get_user_roles(user_id)
        print("The response of UsersV1Api->get_user_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->get_user_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.

Return type

GetUserRoles200Response

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

list_users

List[User] list_users(limit=limit, page=page, cursor=cursor, created_since=created_since, created_until=created_until, updated_since=updated_since, updated_until=updated_until, last_login_since=last_login_since, last_login_until=last_login_until, firstname=firstname, lastname=lastname, email=email, username=username, samaccountname=samaccountname, directory_id=directory_id, external_id=external_id, user_ids=user_ids, custom_attributes_attribute_name=custom_attributes_attribute_name, fields=fields)

List Users

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    limit = 56 # int | How many items to return at one time (max 100) (optional)
    page = 56 # int | The page number of results to return. (optional)
    cursor = 'cursor_example' # str | Set to the value extracted from Before-Cursor or After-Cursor headers to return the previous or next page. (optional)
    created_since = 'created_since_example' # str | An ISO8601 timestamp value that returns all users created after a given date & time. (optional)
    created_until = 'created_until_example' # str | An ISO8601 timestamp value that returns all users created before a given date & time. (optional)
    updated_since = 'updated_since_example' # str | An ISO8601 timestamp value that returns all users updated after a given date & time. (optional)
    updated_until = 'updated_until_example' # str | An ISO8601 timestamp value that returns all users updated before a given date & time. (optional)
    last_login_since = 'last_login_since_example' # str | An ISO8601 timestamp value that returns all users that logged in after a given date & time. (optional)
    last_login_until = 'last_login_until_example' # str | An ISO8601 timestamp value that returns all users that logged in before a given date & time. (optional)
    firstname = 'firstname_example' # str | The first name of the user (optional)
    lastname = 'lastname_example' # str | The last name of the user (optional)
    email = 'email_example' # str | The email address of the user (optional)
    username = 'username_example' # str | The username for the user (optional)
    samaccountname = 'samaccountname_example' # str | The AD login name for the user (optional)
    directory_id = 56 # int |  (optional)
    external_id = 'external_id_example' # str | An external identifier that has been set on the user (optional)
    user_ids = 'user_ids_example' # str | A comma separated list of OneLogin User IDs (optional)
    custom_attributes_attribute_name = 'custom_attributes_attribute_name_example' # str | The short name of a custom attribute. Note that the attribute name is prefixed with custom_attributes. (optional)
    fields = 'fields_example' # str | Optional. Comma delimited list of fields to return. (optional)

    try:
        # List Users
        api_response = api_instance.list_users(limit=limit, page=page, cursor=cursor, created_since=created_since, created_until=created_until, updated_since=updated_since, updated_until=updated_until, last_login_since=last_login_since, last_login_until=last_login_until, firstname=firstname, lastname=lastname, email=email, username=username, samaccountname=samaccountname, directory_id=directory_id, external_id=external_id, user_ids=user_ids, custom_attributes_attribute_name=custom_attributes_attribute_name, fields=fields)
        print("The response of UsersV1Api->list_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->list_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	How many items to return at one time (max 100)	[optional]
page	int	The page number of results to return.	[optional]
cursor	str	Set to the value extracted from Before-Cursor or After-Cursor headers to return the previous or next page.	[optional]
created_since	str	An ISO8601 timestamp value that returns all users created after a given date & time.	[optional]
created_until	str	An ISO8601 timestamp value that returns all users created before a given date & time.	[optional]
updated_since	str	An ISO8601 timestamp value that returns all users updated after a given date & time.	[optional]
updated_until	str	An ISO8601 timestamp value that returns all users updated before a given date & time.	[optional]
last_login_since	str	An ISO8601 timestamp value that returns all users that logged in after a given date & time.	[optional]
last_login_until	str	An ISO8601 timestamp value that returns all users that logged in before a given date & time.	[optional]
firstname	str	The first name of the user	[optional]
lastname	str	The last name of the user	[optional]
email	str	The email address of the user	[optional]
username	str	The username for the user	[optional]
samaccountname	str	The AD login name for the user	[optional]
directory_id	int		[optional]
external_id	str	An external identifier that has been set on the user	[optional]
user_ids	str	A comma separated list of OneLogin User IDs	[optional]
custom_attributes_attribute_name	str	The short name of a custom attribute. Note that the attribute name is prefixed with custom_attributes.	[optional]
fields	str	Optional. Comma delimited list of fields to return.	[optional]

Return type

List[User]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* Current-Page - * Page-Items - * Total-Count - * Total-Pages - * Link - * Before-Cursor - * After-Cursor -
400	Bad Request	-
401	Unauthorized	-
422	Unprocessable	-

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

lock_account_user

Error lock_account_user(user_id, lock_account_user_request=lock_account_user_request)

Lock User Account

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    lock_account_user_request = onelogin.LockAccountUserRequest() # LockAccountUserRequest |  (optional)

    try:
        # Lock User Account
        api_response = api_instance.lock_account_user(user_id, lock_account_user_request=lock_account_user_request)
        print("The response of UsersV1Api->lock_account_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->lock_account_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
lock_account_user_request	LockAccountUserRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

log_out_user

Error log_out_user(user_id, body=body)

Log User Out

Log Out User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    body = None # object |  (optional)

    try:
        # Log User Out
        api_response = api_instance.log_out_user(user_id, body=body)
        print("The response of UsersV1Api->log_out_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->log_out_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
body	object		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

remove_user_role

Error remove_user_role(user_id, remove_user_role_request=remove_user_role_request)

Remove Roles for a User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    remove_user_role_request = onelogin.RemoveUserRoleRequest() # RemoveUserRoleRequest |  (optional)

    try:
        # Remove Roles for a User
        api_response = api_instance.remove_user_role(user_id, remove_user_role_request=remove_user_role_request)
        print("The response of UsersV1Api->remove_user_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->remove_user_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
remove_user_role_request	RemoveUserRoleRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

set_user_state

Error set_user_state(user_id, set_user_state_request=set_user_state_request)

Set User State

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    set_user_state_request = onelogin.SetUserStateRequest() # SetUserStateRequest |  (optional)

    try:
        # Set User State
        api_response = api_instance.set_user_state(user_id, set_user_state_request=set_user_state_request)
        print("The response of UsersV1Api->set_user_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->set_user_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
set_user_state_request	SetUserStateRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

update_password_insecure

Error update_password_insecure(user_id, update_password_insecure_request=update_password_insecure_request)

Set Password Using ID in Cleartext

Update User password using their ID. This is done in cleartext and is insecure.

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    update_password_insecure_request = onelogin.UpdatePasswordInsecureRequest() # UpdatePasswordInsecureRequest |  (optional)

    try:
        # Set Password Using ID in Cleartext
        api_response = api_instance.update_password_insecure(user_id, update_password_insecure_request=update_password_insecure_request)
        print("The response of UsersV1Api->update_password_insecure:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->update_password_insecure: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
update_password_insecure_request	UpdatePasswordInsecureRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

update_password_secure

Error update_password_secure(user_id, update_password_secure_request=update_password_secure_request)

Set Password Using ID and SHA-256 and Salt

Update User Password Using ID and SHA-256 with salt.

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    update_password_secure_request = onelogin.UpdatePasswordSecureRequest() # UpdatePasswordSecureRequest |  (optional)

    try:
        # Set Password Using ID and SHA-256 and Salt
        api_response = api_instance.update_password_secure(user_id, update_password_secure_request=update_password_secure_request)
        print("The response of UsersV1Api->update_password_secure:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->update_password_secure: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
update_password_secure_request	UpdatePasswordSecureRequest		[optional]

Return type

Error

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-

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

update_user

User update_user(user_id, mappings=mappings, validate_policy=validate_policy, user=user)

Update a User

Example

OAuth Authentication (OAuth2):

import time
import os
import onelogin
from onelogin.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://your-api-subdomain.onelogin.com
# See configuration.py for a list of all supported configuration parameters.
configuration = onelogin.Configuration(
    host = "https://your-api-subdomain.onelogin.com"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelogin.UsersV1Api(api_client)
    user_id = 56 # int | Set to the id of the user that you want to return.
    mappings = 'mappings_example' # str | Controls how mappings will be applied to the user on creation. Defaults to async. (optional)
    validate_policy = True # bool | Will passwords validate against the User Policy? Defaults to true. (optional)
    user = onelogin.User() # User |  (optional)

    try:
        # Update a User
        api_response = api_instance.update_user(user_id, mappings=mappings, validate_policy=validate_policy, user=user)
        print("The response of UsersV1Api->update_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV1Api->update_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	int	Set to the id of the user that you want to return.
mappings	str	Controls how mappings will be applied to the user on creation. Defaults to async.	[optional]
validate_policy	bool	Will passwords validate against the User Policy? Defaults to true.	[optional]
user	User		[optional]

Return type

User

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The full user resource is returned	-
400	Bad Request	-
401	Unauthorized	-
404	Not Found	-
422	Unprocessable	-

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

FilesExpand file tree

UsersV1Api.md

Latest commit

History

UsersV1Api.md

File metadata and controls

onelogin.UsersV1Api

add_roles_to_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_custom_attributes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user_apps

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user_roles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lock_account_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

log_out_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_user_role

Example

Parameters