onelogin

This is an administrative API for OneLogin customers

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com//.git

(you may need to run pip with root permission: sudo pip install git+https://github.com//.git)

Then import the package:

import onelogin 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import onelogin

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import onelogin
from onelogin.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: application
configuration = onelogin.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = onelogin.AppsApi(onelogin.ApiClient(configuration))
create_app_request = onelogin.App() # App | The app to create (optional)

try:
    # Create an App
    api_response = api_instance.create_app(create_app_request=create_app_request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppsApi->create_app: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/OneLogin-Auth/onelogin-api/1.0.0

Class	Method	HTTP request	Description
AppsApi	create_app	POST /2/apps	Create an App
AppsApi	delete_app	DELETE /2/apps/{id}	Delete an app
AppsApi	delete_app_parameter	DELETE /2/apps/{id}/parameters/{parameter_id}	Delete an app parameter
AppsApi	get_app	GET /2/apps/{id}	Get an App
AppsApi	get_apps	GET /2/apps	Get Apps
AppsApi	update_app	PUT /2/apps/{id}	Update an App
ConnectorsApi	get_connectors	GET /2/connectors	Get Connectors
EventsApi	get_event	GET /1/events/{id}	Get Event by ID
EventsApi	get_event_types	GET /1/events/types	Get Event Types
EventsApi	get_events	GET /1/events	Get Events
GroupsApi	get_group	GET /1/groups/{id}	Get Group by ID
GroupsApi	get_groups	GET /1/groups	Get Groups
InvitesApi	create_invite_link	POST /1/invites/get_invite_link	Generate Invite Link
InvitesApi	send_invite_link	POST /1/invites/send_invite_link	Send Invite Link
LoginApi	authenticate_user	POST /1/login/auth	Authenticate a user
LoginApi	verify_login_mfa_token	POST /1/login/verify_factor	Verify an MFA token
MfaApi	activate_user_mfa_device	POST /1/users/{id}/otp_devices/{device_id}/trigger	Activate an authentication factor
MfaApi	delete_user_mfa_device	DELETE /1/users/{id}/otp_devices/{device_id}	Remove an authentication device
MfaApi	enroll_user_mfa_device	POST /1/users/{id}/otp_devices	Enroll a user with a given authentication factor.
MfaApi	get_user_available_mfa_factors	GET /1/users/{id}/auth_factors	Get a list of MFA factors available to user
MfaApi	get_user_enrolled_mfa_devices	GET /1/users/{id}/otp_devices	Get enrolled authentication devices
MfaApi	verify_user_mfa_device	POST /1/users/{id}/otp_devices/{device_id}/verify	Verify an authentication device
PrivilegesApi	add_privilege_roles	POST /1/privileges/{id}/roles	Assign roles
PrivilegesApi	add_privilege_users	POST /1/privileges/{id}/users	Assign users
PrivilegesApi	create_privilege	POST /1/privileges	Creates privilege
PrivilegesApi	delete_privilege	DELETE /1/privileges/{id}	Delete privilege
PrivilegesApi	get_privilege	GET /1/privileges/{id}	Get privilege
PrivilegesApi	get_privilege_roles	GET /1/privileges/{id}/roles	Get roles
PrivilegesApi	get_privilege_users	GET /1/privileges/{id}/users	Get privilege users
PrivilegesApi	get_privileges	GET /1/privileges	Get Privileges
PrivilegesApi	remove_privilege_role	DELETE /1/privileges/{id}/roles/{role_id}	Remove a role
PrivilegesApi	remove_privlege_user	DELETE /1/privileges/{id}/users/{user_id}	Remove a user
PrivilegesApi	update_privilege	PUT /1/privileges/{id}	Update privilege
RolesApi	get_role	GET /1/roles/{id}	Get Role by ID
RolesApi	get_roles	GET /1/roles	Get Roles
SamlApi	create_saml_assertion	POST /1/saml_assertion	Generate SAML assertion
SamlApi	verify_saml_assertion_mfa_token	POST /1/saml_assertion/verify_factor	Verify an MFA token
UsersApi	add_user_roles	PUT /1/users/{id}/add_roles	Assign Role to User
UsersApi	create_user	POST /1/users	Create a User
UsersApi	create_user_temp_mfa_token	POST /1/users/{id}/mfa_token	Generate Temp MFA Token
UsersApi	delete_user	DELETE /1/users/{id}	Delete a user account
UsersApi	get_custom_attributes	GET /1/users/custom_attributes	Get Custom Attributes
UsersApi	get_user	GET /1/users/{id}	Get a User
UsersApi	get_user_apps	GET /1/users/{id}/apps	Get User Apps
UsersApi	get_user_roles	GET /1/users/{id}/roles	Get User Roles
UsersApi	get_users	GET /1/users	Get Users
UsersApi	lock_user	PUT /1/users/{id}/lock_user	Lock a user account
UsersApi	logout_user	PUT /1/users/{id}/logout	Log a user out of any and all sessions
UsersApi	remove_user_roles	PUT /1/users/{id}/remove_roles	Remove Roles from User
UsersApi	update_user	PUT /1/users/{id}	Update a User
UsersApi	update_user_custom_attributes	PUT /1/users/{id}/set_custom_attributes	Set a custom attribute
UsersApi	update_user_password	PUT /1/users/set_password_clear_text/{id}	Set a the password for a user
UsersApi	update_user_password_salted	PUT /1/users/set_password_using_salt/{id}	Set a pre salted password for a user
UsersApi	update_user_state	PUT /1/users/{id}/set_state	Set the State for a user.

Documentation For Models

• Action
• App
• AppConfiguration
• AppInfo
• AppParameters
• AppProvisioning
• AppSso
• AppSsoCertificate
• AssignPrivilegeRolesRequest
• AssignPrivilegeRolesResponse
• AssignPrivilegeUsersRequest
• Connector
• CreatePrivilegeResponse
• CreateUserResponse
• CustomAttributesResponse
• EnrollMfaDeviceRequest
• EnrollMfaDeviceResponse
• EnrolledMfaDevicesResponse
• EnrolledMfaDevicesResponseData
• Event
• EventResponse
• EventType
• EventTypesResponse
• EventsResponse
• GenerateInviteLinkRequest
• GenerateMfaTokenRequest
• GenerateMfaTokenResponse
• Group
• GroupResponse
• GroupsResponse
• InlineResponse400
• LockUserRequest
• LoginVerifyMfaRequest
• LoginVerifyMfaResponse
• LoginVerifyMfaResponseData
• MfaDevice
• NewCleartextPasswordRequest
• NewSaltedPasswordRequest
• Pagination
• Privilege
• PrivilegePrivilege
• PrivilegeRolesResponse
• PrivilegeUsersResponse
• Response
• ResponseDevices
• ResponseUser
• Role
• RoleReponse
• RolesResponse
• SamlAssertionRequest
• SamlAssertionResponse
• SamlVerifyMfaRequest
• Scope
• SendInviteLinkRequest
• SetUserCustomAttributesRequest
• SetUserStateRequest
• Statement
• Status
• User
• UserApp
• UserAppsResponse
• UserLoginRequest
• UserLoginResponse
• UserMfaFactorsResponse
• UserMfaFactorsResponseData
• UserMfaFactorsResponseDataAuthFactors
• UserRolesResponse
• UsersResponse
• VerifyMfaDeviceRequest

Documentation For Authorization

application

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Author