onelogin

OpenAPI Specification for OneLogin

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 3.1.1
• Package version: 3.1.5
• Build package: org.openapitools.codegen.languages.PythonNextgenClientCodegen For more information, please visit https://support.onelogin.com

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install onelogin

(you may need to run pip with root permission: sudo pip install onelogin)

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

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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"
)

configuration = onelogin.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with onelogin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    token_instance = onelogin.OAuth2Api(api_client)
    generate_token_request = {"grant_type":"client_credentials"} # GenerateTokenRequest | Request Body to Generate OAuth Token
    content_type="application/json"
    try:
        # Generate and Save Access Token
        api_response = token_instance.generate_token(generate_token_request, content_type=content_type)
        configuration.access_token = api_response.access_token
        print(configuration.access_token)
    except Exception as e:
        print("Exception when generating access token: %s\n" % e)

    user_instance = onelogin.UsersV2Api(api_client)
    try:
        # List Users
        api_response = user_instance.list_users2()
        print("The response of UsersV2Api->list_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UsersV2Api->list_users: %s\n" % e)

Documentation for API Endpoints

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

Documentation For Models

• ActionObj
• ActivateMfaFactorsRequest
• AddClientApp201Response
• AddClientAppRequest
• AddPrivilegeToRole201Response
• AddPrivilegeToRoleRequest
• AddRolesToUserRequest
• AltErr
• AppParameters
• AppRule
• AssignUsersToPrivilegeRequest
• AuthClaim
• AuthId
• AuthMethod
• AuthScope
• AuthServer
• AuthServerConfiguration
• Brand
• BrandApp
• BrandBackground
• BrandBackgroundUrls
• BrandLogo
• BrandLogoUrls
• BrandReq
• ClientAppFull
• ClockCounter
• Condition
• ConfigurationOidc
• ConfigurationSaml
• Connector
• CreateApp200Response
• CreateAppRequest
• CreateDeviceVerification201Response
• CreateDeviceVerificationRequest
• CreateFactorRegistration201Response
• CreateFactorRegistrationRequest
• CreateRole201ResponseInner
• Device
• EmailConfig
• EnforcementPoint
• EnforcementPointResourcesInner
• EnrollMfaFactor200Response
• Error
• Event
• GenerateMFAtoken200Response
• GenerateMFAtokenRequest
• GenerateOTP201Response
• GenerateOTPRequest
• GenerateSamlAssert200Response
• GenerateTokenRequest
• GenericApp
• GenericAppProvisioning
• GetAssignedUser200Response
• GetAuthFactors200Response
• GetAuthenticationDevices200ResponseInner
• GetCustomAttributes200Response
• GetEmailSettings200Response
• GetEmailSettings200ResponseOneOf
• GetEnrolledFactors200Response
• GetEnrolledFactors200ResponseData
• GetEnrolledFactors200ResponseDataOtpDevicesInner
• GetEventById200Response
• GetEventTypes200Response
• GetEventTypes200ResponseDataInner
• GetEvents200Response
• GetEvents200ResponsePagination
• GetGroups200Response
• GetInviteLink200Response
• GetInviteLinkRequest
• GetMFAFactors200Response
• GetMFAFactors200ResponseData
• GetMFAFactors200ResponseDataAuthFactorsInner
• GetRateLimit200Response
• GetRiskScore200Response
• GetRiskScoreRequest
• GetRiskScores200Response
• GetRiskScores200ResponseScores
• GetRoleApps200ResponseInner
• GetRoleById200Response
• GetRoleById200ResponseDataInner
• GetRoleByName200Response
• GetRoleByName200ResponseDataInner
• GetRoleByName200ResponsePagination
• GetUserApps200ResponseInner
• GetUserRoles200Response
• GetUserVerification200Response
• Group
• Hook
• HookEnvvar
• HookLog
• HookOptions
• HookStatus
• ListConditions200ResponseInner
• ListMappingActionValues200ResponseInner
• ListMappingConditions200Response
• ListMappingConditionsOperators200ResponseInner
• ListMappingContionValues200ResponseInner
• ListMappingsActions200ResponseInner
• ListMessageTemplates200ResponseInner
• ListPrivilegeRoles200Response
• Locale
• LockAccountUserRequest
• Mapping
• MessageTemplate
• MessageTemplateTemplate
• MessageTemplateTemplateOneOf
• MessageTemplateTemplateOneOf1
• OauthToken
• OidcApp
• OidcAppAllOf
• OtpDevice
• Privilege
• PrivilegePrivilege
• PrivilegePrivilegeStatementInner
• RateLimit
• RemoveRoleUsersRequest
• RemoveUserRoleRequest
• RemoveUserRoleRequestRoleIdArrayInner
• RequestBrand
• RevokeTokensRequest
• RiskDevice
• RiskRule
• RiskUser
• Role
• RuleAction
• RuleCondition
• SamlApp
• SamlAppAllOf
• SamlAppAllOfParameters
• SamlAppAllOfParametersSamlUsername
• SamlAssert
• SamlFactor
• Scope
• SendInviteLink200Response
• SendInviteLinkRequest
• Session
• SetUserStateRequest
• Source
• SsoOidc
• SsoSaml
• SsoSamlCertificate
• TokenClaim
• TrackRiskEventRequest
• UpdateClientAppRequest
• UpdateEnvironmentVariableRequest
• UpdatePasswordInsecureRequest
• UpdatePasswordSecureRequest
• UpdatePrivilege200Response
• UpdateRiskRuleRequest
• UpdateRole200Response
• User
• VerFactorSaml200Response
• Verb
• VerifyMfaFactorRequest
• VerifyUserRegistration200Response
• VerifyUserRegistrationRequest
• VerifyUserVerificationRequest

Documentation For Authorization

OAuth2

OAuth2

• Type: OAuth

• Flow: application

• Authorization URL:

• Scopes:

• Authentication Only: Gives the credential pair the ability to generate an access token that can perform POST calls only to authentication endpoints, providing least privileged access to authentication code. These endpoints include: - Verify Factor (SAML Assertion) - Generate SAML Assertion - Verify Factor (Login) - Create Session Login Token - Log User Out

• Read Users: Gives the credential pair the ability to generate an access token that can perform GET calls available for the User, Role, and Group API resources.

• Manage users: Gives the credential pair the ability to generate an access token that can perform GET, POST, PUT, and DELETE calls available for the User, Role, and Group API resources, with the exception of setting passwords and assigning and removing roles

• Manage All: Gives the credential pair the ability to generate an access token that can perform GET, POST, PUT, and DELETE calls for all available API resources, including the ability to set passwords and assign and remove roles.

• Read All: Gives the credential pair the ability to generate an access token that can perform GET calls available for all API resources.

• Type: HTTP basic authentication

basicAuth

• Type: HTTP basic authentication

Author

jmfwolf