onelogin.PrivilegesApi

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

Method	HTTP request	Description
add_privilege_to_role	POST /api/1/privileges/{privilege_id}/roles	Assign a Privilege to Roles
assign_users_to_privilege	POST /api/1/privileges/{privilege_id}/users	Assign Users to a Privilege
create_privilege	POST /api/1/privileges	Create a Privilege
delete_privilege	DELETE /api/1/privileges/{privilege_id}	Delete a Privilege
delete_role_from_privilege	DELETE /api/1/privileges/{privilege_id}/roles/{role_id}	Remove a Privilege from a Role
get_assigned_user	GET /api/1/privileges/{privilege_id}/users	Get Users assigned to a Privilege
get_privilege	GET /api/1/privileges/{privilege_id}	Get a Privilege
list_privilege_roles	GET /api/1/privileges/{privilege_id}/roles	Get Roles assigned to Privilege
list_privileges	GET /api/1/privileges	List Privileges
remove_user_from_privilege	DELETE /api/1/privileges/{privilege_id}/users/{user_id}	Remove a Privilege from Users
update_privilege	PUT /api/1/privileges/{privilege_id}	Update a Privilege

add_privilege_to_role

AddPrivilegeToRole201Response add_privilege_to_role(privilege_id, add_privilege_to_role_request=add_privilege_to_role_request)

Assign a Privilege to Roles

Add roles to privilege

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 
    add_privilege_to_role_request = onelogin.AddPrivilegeToRoleRequest() # AddPrivilegeToRoleRequest |  (optional)

    try:
        # Assign a Privilege to Roles
        api_response = api_instance.add_privilege_to_role(privilege_id, add_privilege_to_role_request=add_privilege_to_role_request)
        print("The response of PrivilegesApi->add_privilege_to_role:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->add_privilege_to_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str
add_privilege_to_role_request	AddPrivilegeToRoleRequest		[optional]

Return type

AddPrivilegeToRole201Response

Authorization

OAuth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-

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

assign_users_to_privilege

AddPrivilegeToRole201Response assign_users_to_privilege(privilege_id, assign_users_to_privilege_request=assign_users_to_privilege_request)

Assign Users to a Privilege

Assign Users to Privilege

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 
    assign_users_to_privilege_request = onelogin.AssignUsersToPrivilegeRequest() # AssignUsersToPrivilegeRequest |  (optional)

    try:
        # Assign Users to a Privilege
        api_response = api_instance.assign_users_to_privilege(privilege_id, assign_users_to_privilege_request=assign_users_to_privilege_request)
        print("The response of PrivilegesApi->assign_users_to_privilege:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->assign_users_to_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str
assign_users_to_privilege_request	AssignUsersToPrivilegeRequest		[optional]

Return type

AddPrivilegeToRole201Response

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	-

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

create_privilege

Privilege create_privilege(privilege=privilege)

Create a Privilege

Create privilege

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.PrivilegesApi(api_client)
    privilege = {"name":"User Helpdesk","description":"Can administer helpdesk users","privilege":{"Version":"2018-05-18","Statement":[{"Effect":"Allow","Action":["Users:List","Users:Get","Users:Unlock","Users:ResetPassword","Users:GenerateTempMfaToken"],"Scope":["*"]}]}} # Privilege |  (optional)

    try:
        # Create a Privilege
        api_response = api_instance.create_privilege(privilege=privilege)
        print("The response of PrivilegesApi->create_privilege:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->create_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege	Privilege		[optional]

Return type

Privilege

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	-

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

delete_privilege

delete_privilege(privilege_id)

Delete a Privilege

Delete

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 

    try:
        # Delete a Privilege
        api_instance.delete_privilege(privilege_id)
    except Exception as e:
        print("Exception when calling PrivilegesApi->delete_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str

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]

delete_role_from_privilege

delete_role_from_privilege(privilege_id, role_id)

Remove a Privilege from a Role

Add roles to privilege

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 
    role_id = 'role_id_example' # str | Set to the id of the role you want to return.

    try:
        # Remove a Privilege from a Role
        api_instance.delete_role_from_privilege(privilege_id, role_id)
    except Exception as e:
        print("Exception when calling PrivilegesApi->delete_role_from_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str
role_id	str	Set to the id of the role 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	No Content	-
401	Unauthorized	-
404	Not Found	-

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

get_assigned_user

GetAssignedUser200Response get_assigned_user(privilege_id)

Get Users assigned to a Privilege

Get Assigned 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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 

    try:
        # Get Users assigned to a Privilege
        api_response = api_instance.get_assigned_user(privilege_id)
        print("The response of PrivilegesApi->get_assigned_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->get_assigned_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str

Return type

GetAssignedUser200Response

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]

get_privilege

Privilege get_privilege(privilege_id)

Get a Privilege

Get a Privilige

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 

    try:
        # Get a Privilege
        api_response = api_instance.get_privilege(privilege_id)
        print("The response of PrivilegesApi->get_privilege:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->get_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str

Return type

Privilege

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_privilege_roles

ListPrivilegeRoles200Response list_privilege_roles(privilege_id)

Get Roles assigned to Privilege

List roles for privilege

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 

    try:
        # Get Roles assigned to Privilege
        api_response = api_instance.list_privilege_roles(privilege_id)
        print("The response of PrivilegesApi->list_privilege_roles:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->list_privilege_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str

Return type

ListPrivilegeRoles200Response

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_privileges

List[Privilege] list_privileges()

List Privileges

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

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

Parameters

This endpoint does not need any parameter.

Return type

List[Privilege]

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]

remove_user_from_privilege

remove_user_from_privilege(privilege_id, user_id)

Remove a Privilege from 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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 
    user_id = 56 # int | Set to the id of the user that you want to return.

    try:
        # Remove a Privilege from Users
        api_instance.remove_user_from_privilege(privilege_id, user_id)
    except Exception as e:
        print("Exception when calling PrivilegesApi->remove_user_from_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str
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	No Content	-
401	Unauthorized	-
404	Not Found	-

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

update_privilege

UpdatePrivilege200Response update_privilege(privilege_id, privilege=privilege)

Update a Privilege

Update privilege

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.PrivilegesApi(api_client)
    privilege_id = 'privilege_id_example' # str | 
    privilege = {"name":"User Administrator","description":"Can administer users","privilege":{"Version":"2018-05-18","Statement":[{"Effect":"Allow","Action":["Users:List","Users:Get","Users:Unlock","Users:ResetPassword","Users:GenerateTempMfaToken"],"Scope":["*"]}]}} # Privilege |  (optional)

    try:
        # Update a Privilege
        api_response = api_instance.update_privilege(privilege_id, privilege=privilege)
        print("The response of PrivilegesApi->update_privilege:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PrivilegesApi->update_privilege: %s\n" % e)

Parameters

Name	Type	Description	Notes
privilege_id	str
privilege	Privilege		[optional]

Return type

UpdatePrivilege200Response

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	-

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

Files

PrivilegesApi.md

Latest commit

History

PrivilegesApi.md

File metadata and controls

onelogin.PrivilegesApi

add_privilege_to_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assign_users_to_privilege

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_privilege

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_privilege

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_role_from_privilege

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_assigned_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_privilege

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_privilege_roles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_privileges

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_user_from_privilege

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_privilege

Example

Parameters