onelogin.UserMappingsApi

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

Method	HTTP request	Description
create_mapping	POST /api/2/mappings	Create Mapping
delete_mapping	DELETE /api/2/mappings/{mapping_id}	Delete Mapping
get_mapping	GET /api/2/mappings/{mapping_id}	Get Mapping
list_mapping_action_values	GET /api/2/mappings/actions/{mapping_action_value}/values	List Actions Values
list_mapping_conditions	GET /api/2/mappings/conditions	List Conditions
list_mapping_conditions_operators	GET /api/2/mappings/conditions/{mapping_condition_value}/operators	List Conditions Operators
list_mapping_contion_values	GET /api/2/mappings/conditions/{mapping_condition_value}/values	List Conditions Values
list_mappings	GET /api/2/mappings	List Mappings
list_mappings_actions	GET /api/2/mappings/actions	List Actions
sort_mappings	PUT /api/2/mappings/sort	Bulk Sort
update_mapping	PUT /api/2/mappings/{mapping_id}	Update Mapping

create_mapping

List[Mapping] create_mapping(content_type=content_type, mapping=mapping)

Create Mapping

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.UserMappingsApi(api_client)
    content_type = 'application/json' # str |  (optional) (default to 'application/json')
    mapping = onelogin.Mapping() # Mapping |  (optional)

    try:
        # Create Mapping
        api_response = api_instance.create_mapping(content_type=content_type, mapping=mapping)
        print("The response of UserMappingsApi->create_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->create_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_type	str		[optional] [default to 'application/json']
mapping	Mapping		[optional]

Return type

List[Mapping]

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Successful response	-
401	Unauthorized	-
422	Unprocessable	-

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

delete_mapping

delete_mapping(mapping_id)

Delete Mapping

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.UserMappingsApi(api_client)
    mapping_id = 56 # int | The id of the user mapping to locate.

    try:
        # Delete Mapping
        api_instance.delete_mapping(mapping_id)
    except Exception as e:
        print("Exception when calling UserMappingsApi->delete_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_id	int	The id of the user mapping to locate.

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	No Content	-
401	Unauthorized	-
404	Not Found	-

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

get_mapping

Mapping get_mapping(mapping_id)

Get Mapping

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.UserMappingsApi(api_client)
    mapping_id = 56 # int | The id of the user mapping to locate.

    try:
        # Get Mapping
        api_response = api_instance.get_mapping(mapping_id)
        print("The response of UserMappingsApi->get_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->get_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_id	int	The id of the user mapping to locate.

Return type

Mapping

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

list_mapping_action_values

List[ListMappingActionValues200ResponseInner] list_mapping_action_values(mapping_action_value)

List Actions Values

List Mappings' Actions' Values

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.UserMappingsApi(api_client)
    mapping_action_value = 'mapping_action_value_example' # str | 

    try:
        # List Actions Values
        api_response = api_instance.list_mapping_action_values(mapping_action_value)
        print("The response of UserMappingsApi->list_mapping_action_values:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->list_mapping_action_values: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_action_value	str

Return type

List[ListMappingActionValues200ResponseInner]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-

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

list_mapping_conditions

ListMappingConditions200Response list_mapping_conditions()

List Conditions

List Mappings' Conditions

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.UserMappingsApi(api_client)

    try:
        # List Conditions
        api_response = api_instance.list_mapping_conditions()
        print("The response of UserMappingsApi->list_mapping_conditions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->list_mapping_conditions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

ListMappingConditions200Response

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-

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

list_mapping_conditions_operators

List[ListMappingConditionsOperators200ResponseInner] list_mapping_conditions_operators(mapping_condition_value)

List Conditions Operators

List Mappings' Conditions' Operators

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.UserMappingsApi(api_client)
    mapping_condition_value = 'mapping_condition_value_example' # str | 

    try:
        # List Conditions Operators
        api_response = api_instance.list_mapping_conditions_operators(mapping_condition_value)
        print("The response of UserMappingsApi->list_mapping_conditions_operators:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->list_mapping_conditions_operators: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_condition_value	str

Return type

List[ListMappingConditionsOperators200ResponseInner]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-

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

list_mapping_contion_values

List[ListMappingContionValues200ResponseInner] list_mapping_contion_values(mapping_condition_value)

List Conditions Values

List Mappings' Conditions' Values

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.UserMappingsApi(api_client)
    mapping_condition_value = 'mapping_condition_value_example' # str | 

    try:
        # List Conditions Values
        api_response = api_instance.list_mapping_contion_values(mapping_condition_value)
        print("The response of UserMappingsApi->list_mapping_contion_values:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->list_mapping_contion_values: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_condition_value	str

Return type

List[ListMappingContionValues200ResponseInner]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-

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

list_mappings

List[Mapping] list_mappings(enabled=enabled, has_condition=has_condition, has_condition_type=has_condition_type, has_action=has_action, has_action_type=has_action_type)

List Mappings

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.UserMappingsApi(api_client)
    enabled = True # bool | Defaults to true. When set to `false` will return all disabled mappings. (optional) (default to True)
    has_condition = 'has_condition=has_role:123456' # str | Filters Rules based on their Conditions. Values formatted as :, where name is the Condition to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields. For example: Single filter. has_condition=has_role:123456 Multiple filters. has_condition=has_role:123456,status:1 Wildcard for conditions. has_condition=*:123456 Wildcard for condition values. has_condition=has_role:* (optional)
    has_condition_type = 'has_condition_type_example' # str | Filters Rules based on their Conditions. Values formatted as :, where name is the Condition to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields. For example: Single filter. has_condition=has_role:123456 Multiple filters. has_condition=has_role:123456,status:1 Wildcard for conditions. has_condition=*:123456 Wildcard for condition values. has_condition=has_role:* (optional)
    has_action = 'has_action=set_groups:123456,set_usertype:*' # str | Filters Rules based on their Actions. Values formatted as :, where name is the Action to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields. For example: Single filter. has_action=set_licenses:123456 Multiple filters. has_action=set_groups:123456,set_usertype:* Wildcard for actions. has_action=*:123456 Wildcard for action values. has_action=set_userprincipalname:* (optional)
    has_action_type = 'has_action_type_example' # str | Filters Rules based on their action types. Allowed values are: builtin - actions that involve standard attributes custom - actions that involve custom attributes none - no actions are defined For example: Find Rules with no actions has_action_type=none (optional)

    try:
        # List Mappings
        api_response = api_instance.list_mappings(enabled=enabled, has_condition=has_condition, has_condition_type=has_condition_type, has_action=has_action, has_action_type=has_action_type)
        print("The response of UserMappingsApi->list_mappings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->list_mappings: %s\n" % e)

Parameters

Name	Type	Description	Notes
enabled	bool	Defaults to true. When set to `false` will return all disabled mappings.	[optional] [default to True]
has_condition	str	Filters Rules based on their Conditions. Values formatted as :, where name is the Condition to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields. For example: Single filter. has_condition=has_role:123456 Multiple filters. has_condition=has_role:123456,status:1 Wildcard for conditions. has_condition=:123456 Wildcard for condition values. has_condition=has_role:	[optional]
has_condition_type	str	Filters Rules based on their Conditions. Values formatted as :, where name is the Condition to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields. For example: Single filter. has_condition=has_role:123456 Multiple filters. has_condition=has_role:123456,status:1 Wildcard for conditions. has_condition=:123456 Wildcard for condition values. has_condition=has_role:	[optional]
has_action	str	Filters Rules based on their Actions. Values formatted as :, where name is the Action to look for, and value is the value to find. Multiple filters can be declared by using a comma delimited list. Wildcards are supported in both the name and value fields. For example: Single filter. has_action=set_licenses:123456 Multiple filters. has_action=set_groups:123456,set_usertype:* Wildcard for actions. has_action=:123456 Wildcard for action values. has_action=set_userprincipalname:	[optional]
has_action_type	str	Filters Rules based on their action types. Allowed values are: builtin - actions that involve standard attributes custom - actions that involve custom attributes none - no actions are defined For example: Find Rules with no actions has_action_type=none	[optional]

Return type

List[Mapping]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-

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

list_mappings_actions

List[ListMappingsActions200ResponseInner] list_mappings_actions()

List Actions

List Mappings' Actions

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.UserMappingsApi(api_client)

    try:
        # List Actions
        api_response = api_instance.list_mappings_actions()
        print("The response of UserMappingsApi->list_mappings_actions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->list_mappings_actions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[ListMappingsActions200ResponseInner]

Authorization

OAuth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-

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

sort_mappings

List[int] sort_mappings(request_body=request_body)

Bulk Sort

Bulk Sort Mappings

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.UserMappingsApi(api_client)
    request_body = [56] # List[int] |  (optional)

    try:
        # Bulk Sort
        api_response = api_instance.sort_mappings(request_body=request_body)
        print("The response of UserMappingsApi->sort_mappings:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->sort_mappings: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	List[int]		[optional]

Return type

List[int]

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-
422	Unprocessable	-

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

update_mapping

int update_mapping(mapping_id, content_type=content_type, body=body)

Update Mapping

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.UserMappingsApi(api_client)
    mapping_id = 56 # int | The id of the user mapping to locate.
    content_type = 'application/json' # str |  (optional) (default to 'application/json')
    body = None # object |  (optional)

    try:
        # Update Mapping
        api_response = api_instance.update_mapping(mapping_id, content_type=content_type, body=body)
        print("The response of UserMappingsApi->update_mapping:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserMappingsApi->update_mapping: %s\n" % e)

Parameters

Name	Type	Description	Notes
mapping_id	int	The id of the user mapping to locate.
content_type	str		[optional] [default to 'application/json']
body	object		[optional]

Return type

int

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Successful response	-
401	Unauthorized	-
422	Unprocessable	-

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

Files

UserMappingsApi.md

Latest commit

History

UserMappingsApi.md

File metadata and controls

onelogin.UserMappingsApi

create_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_mapping

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_mapping_action_values

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_mapping_conditions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_mapping_conditions_operators

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_mapping_contion_values

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_mappings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_mappings_actions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

sort_mappings

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_mapping

Example

Parameters