Client (com.onelogin:onelogin-java-sdk 1.4.1 API)

java.lang.Object
- com.onelogin.sdk.conn.Client

```
public class Client
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`accessToken` OAuth 2.0 Access Token
`static String`	`CUSTOM_USER_AGENT`
`protected String`	`error` Last error found
`protected String`	`errorAttribute` The attribute that caused the last error found if declared
`protected String`	`errorDescription` Description of last error found
`protected org.joda.time.DateTime`	`expiration` OAuth 2.0 Token expiration
`int`	`maxResults` Limit the number of elements returned in a search
`protected String`	`refreshToken` OAuth 2.0 Refresh Token
`protected Settings`	`settings` Settings object
`String`	`userAgent` The User-Agent to be used on requests
`static String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description
`Client()`
`Client(boolean throwOAuthProblemException)`
`Client(int maxResults)`
`Client(int maxResults, boolean throwOAuthProblemException)` Constructs the client to execute Onelogin's API calls.
`Client(String clientID, String clientSecret, String region)`
`Client(String clientID, String clientSecret, String region, boolean throwOAuthProblemException)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FactorEnrollmentResponse`	`activateFactor(long userId, long deviceId)` Triggers an SMS or Push notification containing a One-Time Password (OTP) that can be used to authenticate a user with the Verify Factor call.
`Boolean`	`assignRoleToUser(long id, List<Long> roleIds)` Assigns Role to User
`void`	`cleanError()` Clean error message
`void`	`createEvent(Map<String,Object> eventParams)` Create an event in the OneLogin event log.
`Object`	`createSessionLoginToken(Map<String,Object> queryParams)` Generate a session login token in scenarios in which MFA may or may not be required.
`Object`	`createSessionLoginToken(Map<String,Object> queryParams, String allowedOrigin)` Generates a session login token in scenarios in which MFA may or may not be required.
`User`	`createUser(Map<String,Object> userParams)` Creates an user
`Boolean`	`deleteUser(long id)` Deletes an user
`OTPDevice`	`enrollFactor(long userId, long factorId, String displayName, String number)` Enroll a user with a given authentication factor.
`String`	`generateInviteLink(String email)` Generates an invite link for a user that you have already created in your OneLogin account.
`void`	`getAccessToken()` Generates an access token and refresh token that you may use to call Onelogin's API methods.
`protected String`	`getAuthorization()`
`protected String`	`getAuthorization(Boolean bearer)`
`protected Map<String,String>`	`getAuthorizedHeader()`
`protected Map<String,String>`	`getAuthorizedHeader(Boolean bearer)`
`List<String>`	`getCustomAttributes()` Gets a list of all custom attribute fields (also known as custom user fields) that have been defined for OL account.
`List<EmbedApp>`	`getEmbedApps(String token, String email)` Lists apps accessible by a OneLogin user.
`List<OTPDevice>`	`getEnrolledFactors(long userId)` Return a list of authentication factors registered to a particular user for multifactor authentication (MFA)
`String`	`getError()`
`String`	`getErrorAttribute()`
`String`	`getErrorDescription()`
`Event`	`getEvent(long id)` Gets Event by ID.
`List<Event>`	`getEvents()` Gets a list of Event resources. (50 elements)
`List<Event>`	`getEvents(HashMap<String,String> queryParameters)` Gets a list of Event resources.
`List<Event>`	`getEvents(HashMap<String,String> queryParameters, int maxResults)` Gets a list of Event resources.
`List<Event>`	`getEvents(int maxResults)` Gets a list of Event resources.
`OneLoginResponse<Event>`	`getEventsBatch(HashMap<String,String> queryParameters, int batchSize, String afterCursor)` Get a batch of Events.
`OneLoginResponse<Event>`	`getEventsBatch(int batchSize)` Get a batch of Events.
`OneLoginResponse<Event>`	`getEventsBatch(int batchSize, String afterCursor)` Get a batch of Events.
`List<EventType>`	`getEventTypes()` List of all OneLogin event types available to the Events API.
`List<AuthFactor>`	`getFactors(long userId)` Returns a list of authentication factors that are available for user enrollment via API.
`Group`	`getGroup(long id)` Gets Group by ID.
`List<Group>`	`getGroups()` Gets a list of Group resources.
`List<Group>`	`getGroups(int maxResults)` Gets a list of Group resources (element of groups limited with the limit parameter).
`OneLoginResponse<Group>`	`getGroupsBatch(HashMap<String,String> queryParameters, int batchSize, String afterCursor)` Get a batch of Groups
`OneLoginResponse<Group>`	`getGroupsBatch(int batchSize)` Get a batch of Groups.
`OneLoginResponse<Group>`	`getGroupsBatch(int batchSize, String afterCursor)` Get a batch of Groups.
`String`	`getIP()`
`RateLimit`	`getRateLimit()` Gets current rate limit details about an access token.
`Role`	`getRole(long id)` Gets Role by ID.
`List<Role>`	`getRoles()` Gets a list of Role resources
`List<Role>`	`getRoles(HashMap<String,String> queryParameters)` Gets a list of Role resources.
`List<Role>`	`getRoles(HashMap<String,String> queryParameters, int maxResults)` Gets a list of Role resources.
`List<Role>`	`getRoles(int maxResults)` Gets a list of Role resources.
`OneLoginResponse<Role>`	`getRolesBatch(HashMap<String,String> queryParameters, int batchSize, String afterCursor)` Get a batch of Roles.
`OneLoginResponse<Role>`	`getRolesBatch(int batchSize)` Get a batch of Roles.
`OneLoginResponse<Role>`	`getRolesBatch(int batchSize, String afterCursor)` Get a batch of Roles.
`SAMLEndpointResponse`	`getSAMLAssertion(String usernameOrEmail, String password, String appId, String subdomain)` Generates a SAML Assertion.
`SAMLEndpointResponse`	`getSAMLAssertion(String usernameOrEmail, String password, String appId, String subdomain, String ipAddress)` Generates a SAML Assertion.
`SAMLEndpointResponse`	`getSAMLAssertionVerifying(String appId, String devideId, String stateToken)` Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
`SAMLEndpointResponse`	`getSAMLAssertionVerifying(String appId, String devideId, String stateToken, String otpToken)` Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
`SAMLEndpointResponse`	`getSAMLAssertionVerifying(String appId, String devideId, String stateToken, String otpToken, String urlEndpoint)` Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
`SAMLEndpointResponse`	`getSAMLAssertionVerifying(String appId, String devideId, String stateToken, String otpToken, String urlEndpoint, Boolean doNotNotify)` Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
`SessionTokenInfo`	`getSessionTokenVerified(String devideId, String stateToken)` Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
`SessionTokenInfo`	`getSessionTokenVerified(String devideId, String stateToken, String otpToken)` Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
`SessionTokenInfo`	`getSessionTokenVerified(String devideId, String stateToken, String otpToken, String allowedOrigin)` Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
`SessionTokenInfo`	`getSessionTokenVerified(String devideId, String stateToken, String otpToken, String allowedOrigin, Boolean doNotNotify)` Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
`User`	`getUser(long id)` Gets User by ID.
`List<App>`	`getUserApps(long id)` Gets a list of apps accessible by a user, not including personal apps.
`List<Integer>`	`getUserRoles(long id)` Gets a list of role IDs that have been assigned to a user.
`List<User>`	`getUsers()` Gets a list of User resources
`List<User>`	`getUsers(HashMap<String,String> queryParameters)` Gets a list of User resources.
`List<User>`	`getUsers(HashMap<String,String> queryParameters, int maxResults)` Gets a list of User resources.
`List<User>`	`getUsers(int maxResults)` Gets a list of User resources.
`OneLoginResponse<User>`	`getUsersBatch(HashMap<String,String> queryParameters, int batchSize, String afterCursor)` Get a batch of Users.
`OneLoginResponse<User>`	`getUsersBatch(int batchSize)` Get a batch Users.
`OneLoginResponse<User>`	`getUsersBatch(int batchSize, String afterCursor)` Get a batch of Users.
`boolean`	`isExpired()`
`Boolean`	`lockUser(long id, int minutes)` Use this call to lock a user’s account based on the policy assigned to the user, for a specific time you define in the request, or until you unlock it.
`Boolean`	`logUserOut(long id)` Log a user out of any and all sessions.
`void`	`prepareToken()` Prepare the client before execute a call to the API (get token ready)
`void`	`refreshToken()` Refreshing tokens provides a new set of access and refresh tokens.
`Boolean`	`removeFactor(long userId, long deviceId)` Remove an enrolled factor from a user.
`Boolean`	`removeRoleFromUser(long id, List<Long> roleIds)` Remove Role from User
`void`	`revokeToken()` Revokes an access token and refresh token pair.
`Boolean`	`sendInviteLink(String email)` Send an invite link to a user that you have already created in your OneLogin account.
`Boolean`	`sendInviteLink(String email, String personalEmail)` Sends an invite link to a user that you have already created in your OneLogin account.
`Boolean`	`setCustomAttributeToUser(long id, Map<String,Object> customAttributes)` Set Custom Attribute Value
`Boolean`	`setPasswordUsingClearText(long id, String password, String passwordConfirmation)` Sets Password by ID Using Cleartext
`Boolean`	`setPasswordUsingHashSalt(long id, String password, String passwordConfirmation, String passwordAlgorithm)` Set Password by ID Using Salt and SHA-256
`Boolean`	`setPasswordUsingHashSalt(long id, String password, String passwordConfirmation, String passwordAlgorithm, String passwordSalt)` Set Password by ID Using Salt and SHA-256
`Boolean`	`setStateToUser(long id, int state)` Set User State
`User`	`updateUser(long id, Map<String,Object> userParams)` Updates an user
`Boolean`	`verifyFactor(long userId, long deviceId)` Authenticates a one-time password (OTP) code provided by a multifactor authentication (MFA) device.
`Boolean`	`verifyFactor(long userId, long deviceId, String otpToken)` Authenticates a one-time password (OTP) code provided by a multifactor authentication (MFA) device.
`Boolean`	`verifyFactor(long userId, long deviceId, String otpToken, String stateToken)` Authenticates a one-time password (OTP) code provided by a multifactor authentication (MFA) device.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final String VERSION
```
    See Also:
    
    Constant Field Values
  - CUSTOM_USER_AGENT
```
public static final String CUSTOM_USER_AGENT
```
    See Also:
    
    Constant Field Values
  - accessToken
```
protected String accessToken
```
    OAuth 2.0 Access Token
  - refreshToken
```
protected String refreshToken
```
    OAuth 2.0 Refresh Token
  - expiration
```
protected org.joda.time.DateTime expiration
```
    OAuth 2.0 Token expiration
  - error
```
protected String error
```
    Last error found
  - errorDescription
```
protected String errorDescription
```
    Description of last error found
  - errorAttribute
```
protected String errorAttribute
```
    The attribute that caused the last error found if declared
  - settings
```
protected Settings settings
```
    Settings object
  - userAgent
```
public String userAgent
```
    The User-Agent to be used on requests
  - maxResults
```
public int maxResults
```
    Limit the number of elements returned in a search
- Constructor Detail
  - Client
```
public Client(int maxResults,
              boolean throwOAuthProblemException)
       throws IOException,
              Error
```
    Constructs the client to execute Onelogin's API calls. It initializes the Settings (read Onelogin's credentials and the region from the config file)
    
    Parameters:
    
    maxResults - Set max number of items returned by a collection
    
    Throws:
    
    IOException - - If Settings initialization raises that exception when calling loadPropFile to load the file
    
    Error - - If Settings initialization raises that exception when calling loadPropFile to load the file
  - Client
```
public Client(int maxResults)
       throws IOException,
              Error
```
    Throws:
    
    IOException
    
    Error
  - Client
```
public Client()
       throws IOException,
              Error
```
    Throws:
    
    IOException
    
    Error
  - Client
```
public Client(boolean throwOAuthProblemException)
       throws IOException,
              Error
```
    Throws:
    
    IOException
    
    Error
  - Client
```
public Client(String clientID,
              String clientSecret,
              String region)
```
  - Client
```
public Client(String clientID,
              String clientSecret,
              String region,
              boolean throwOAuthProblemException)
```
- Method Detail
  - getAccessToken
```
public void getAccessToken()
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException
```
    Generates an access token and refresh token that you may use to call Onelogin's API methods.
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONAccessTokenResponse and throwOAuthProblemException is enabled
    
    See Also:
    
    Generate Tokens documentation
  - refreshToken
```
public void refreshToken()
                  throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                         org.apache.oltu.oauth2.common.exception.OAuthProblemException
```
    Refreshing tokens provides a new set of access and refresh tokens.
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONAccessTokenResponse and throwOAuthProblemException is enabled
    
    See Also:
    
    Refresh Tokens documentation
  - revokeToken
```
public void revokeToken()
                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                        org.apache.oltu.oauth2.common.exception.OAuthProblemException
```
    Revokes an access token and refresh token pair.
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONAccessTokenResponse and throwOAuthProblemException is enabled
    
    See Also:
    
    Revoke Tokens documentation
  - getRateLimit
```
public RateLimit getRateLimit()
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException
```
    Gets current rate limit details about an access token.
    
    Returns:
    
    RateLimit object
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    See Also:
    
    RateLimit, Get Rate Limit documentation
  - getUsers
```
public List<User> getUsers(HashMap<String,String> queryParameters,
                           int maxResults)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of User resources.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource Parameters to filter the result of the list
    
    maxResults - Limit the number of users returned (optional)
    
    Returns:
    
    List of User
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUsersBatch
```
public OneLoginResponse<User> getUsersBatch(int batchSize)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            URISyntaxException
```
    Get a batch Users. This is usually the first version of the user batching methods to call as it requires no after-cursor information.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    Returns:
    
    OneLoginResponse of User (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUsersBatch
```
public OneLoginResponse<User> getUsersBatch(int batchSize,
                                            String afterCursor)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            URISyntaxException
```
    Get a batch of Users.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of User (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUsersBatch
```
public OneLoginResponse<User> getUsersBatch(HashMap<String,String> queryParameters,
                                            int batchSize,
                                            String afterCursor)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            URISyntaxException
```
    Get a batch of Users.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of User (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUsers
```
public List<User> getUsers(HashMap<String,String> queryParameters)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of User resources.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource Parameters to filter the result of the list
    
    Returns:
    
    List of User
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUsers
```
public List<User> getUsers(int maxResults)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of User resources.
    
    Parameters:
    
    maxResults - Limit the number of users returned (optional)
    
    Returns:
    
    List of User
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUsers
```
public List<User> getUsers()
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of User resources
    
    Returns:
    
    List of User
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    User, Get Users documentation
  - getUser
```
public User getUser(long id)
             throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                    org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                    URISyntaxException
```
    Gets User by ID.
    
    Parameters:
    
    id - Id of the user
    
    Returns:
    
    User
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    User, Get User by ID documentation
  - getUserApps
```
public List<App> getUserApps(long id)
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of apps accessible by a user, not including personal apps.
    
    Parameters:
    
    id - Id of the user
    
    Returns:
    
    List of Apps
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    App, Get Apps for a User documentation
  - getUserRoles
```
public List<Integer> getUserRoles(long id)
                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                  org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                  URISyntaxException
```
    Gets a list of role IDs that have been assigned to a user.
    
    Parameters:
    
    id - Id of the user
    
    Returns:
    
    List of Role Ids
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles for a User documentation
  - getCustomAttributes
```
public List<String> getCustomAttributes()
                                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                        URISyntaxException
```
    Gets a list of all custom attribute fields (also known as custom user fields) that have been defined for OL account.
    
    Returns:
    
    List of custom attribute fields
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Get Custom Attributes documentation
  - createUser
```
public User createUser(Map<String,Object> userParams)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       URISyntaxException
```
    Creates an user
    
    Parameters:
    
    userParams - User data (firstname, lastname, email, username, company, department, directory_id, distinguished_name, external_id, group_id, invalid_login_attempts, locale_code, manager_ad_id, member_of, notes, openid_name, phone, samaccountname, title, userprincipalname)
    
    Returns:
    
    Created user
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Create User documentation
  - createSessionLoginToken
```
public Object createSessionLoginToken(Map<String,Object> queryParams,
                                      String allowedOrigin)
                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                      URISyntaxException
```
    Generates a session login token in scenarios in which MFA may or may not be required. A session login token expires two minutes after creation.
    
    Parameters:
    
    queryParams - Query Parameters (username_or_email, password, subdomain, return_to_url, ip_address, browser_id)
    
    allowedOrigin - Custom-Allowed-Origin-Header. Required for CORS requests only. Set to the Origin URI from which you are allowed to send a request using CORS.
    
    Returns:
    
    SessionTokenInfo or SessionTokenMFAInfo object if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Create Session Login Token documentation
  - createSessionLoginToken
```
public Object createSessionLoginToken(Map<String,Object> queryParams)
                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                      URISyntaxException
```
    Generate a session login token in scenarios in which MFA may or may not be required. A session login token expires two minutes after creation.
    
    Parameters:
    
    queryParams - Query Parameters (username_or_email, password, subdomain, return_to_url, ip_address, browser_id)
    
    Returns:
    
    SessionTokenInfo or SessionTokenMFAInfo object if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Create Session Login Token documentation
  - getSessionTokenVerified
```
public SessionTokenInfo getSessionTokenVerified(String devideId,
                                                String stateToken,
                                                String otpToken,
                                                String allowedOrigin,
                                                Boolean doNotNotify)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                URISyntaxException
```
    Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
    
    Parameters:
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    otpToken - Provide the OTP value for the MFA factor you are submitting for verification.
    
    allowedOrigin - Custom-Allowed-Origin-Header. Required for CORS requests only. Set to the Origin URI from which you are allowed to send a request using CORS.
    
    doNotNotify - When verifying MFA via Protect Push, set this to true to
    
    Returns:
    
    Session Token
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify Factor documentation
  - getSessionTokenVerified
```
public SessionTokenInfo getSessionTokenVerified(String devideId,
                                                String stateToken,
                                                String otpToken,
                                                String allowedOrigin)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                URISyntaxException
```
    Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
    
    Parameters:
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    otpToken - Provide the OTP value for the MFA factor you are submitting for verification.
    
    allowedOrigin - Custom-Allowed-Origin-Header. Required for CORS requests only. Set to the Origin URI from which you are allowed to send a request using CORS.
    
    Returns:
    
    Session Token
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify Factor documentation
  - getSessionTokenVerified
```
public SessionTokenInfo getSessionTokenVerified(String devideId,
                                                String stateToken,
                                                String otpToken)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                URISyntaxException
```
    Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
    
    Parameters:
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    otpToken - Provide the OTP value for the MFA factor you are submitting for verification.
    
    Returns:
    
    Session Token
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify Factor documentation
  - getSessionTokenVerified
```
public SessionTokenInfo getSessionTokenVerified(String devideId,
                                                String stateToken)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                URISyntaxException
```
    Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
    
    Parameters:
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    Returns:
    
    Session Token
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify Factor documentation
  - updateUser
```
public User updateUser(long id,
                       Map<String,Object> userParams)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       URISyntaxException
```
    Updates an user
    
    Parameters:
    
    id - Id of the user to be modified
    
    userParams - User data (firstname, lastname, email, username, company, department, directory_id, distinguished_name, external_id, group_id, invalid_login_attempts, locale_code, manager_ad_id, member_of, notes, openid_name, phone, samaccountname, title, userprincipalname)
    
    Returns:
    
    Updated user
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Update User by ID documentation
  - assignRoleToUser
```
public Boolean assignRoleToUser(long id,
                                List<Long> roleIds)
                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                URISyntaxException
```
    Assigns Role to User
    
    Parameters:
    
    id - Id of the user to be modified
    
    roleIds - Set to an array of one or more role IDs.
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Assign Role to User documentation
  - removeRoleFromUser
```
public Boolean removeRoleFromUser(long id,
                                  List<Long> roleIds)
                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                  org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                  URISyntaxException
```
    Remove Role from User
    
    Parameters:
    
    id - Id of the user to be modified
    
    roleIds - Set to an array of one or more role IDs.
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Remove Role from User documentation
  - setPasswordUsingClearText
```
public Boolean setPasswordUsingClearText(long id,
                                         String password,
                                         String passwordConfirmation)
                                  throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                         org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                         URISyntaxException
```
    Sets Password by ID Using Cleartext
    
    Parameters:
    
    id - Id of the user to be modified
    
    password - Set to the password value using cleartext.
    
    passwordConfirmation - Ensure that this value matches the password value exactly.
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Set Password by ID Using Cleartext documentation
  - setPasswordUsingHashSalt
```
public Boolean setPasswordUsingHashSalt(long id,
                                        String password,
                                        String passwordConfirmation,
                                        String passwordAlgorithm,
                                        String passwordSalt)
                                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                        URISyntaxException
```
    Set Password by ID Using Salt and SHA-256
    
    Parameters:
    
    id - Id of the user to be modified
    
    password - Set to the password value using a SHA-256-encoded value.
    
    passwordConfirmation - This value must match the password value.
    
    passwordAlgorithm - Set to salt+sha256.
    
    passwordSalt - To provide your own salt value.
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Set Password by ID Using Salt and SHA-256 documentation
  - setPasswordUsingHashSalt
```
public Boolean setPasswordUsingHashSalt(long id,
                                        String password,
                                        String passwordConfirmation,
                                        String passwordAlgorithm)
                                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                        URISyntaxException
```
    Set Password by ID Using Salt and SHA-256
    
    Parameters:
    
    id - Id of the user to be modified
    
    password - Set to the password value using a SHA-256-encoded value.
    
    passwordConfirmation - This value must match the password value.
    
    passwordAlgorithm - Set to salt+sha256.
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Set Password by ID Using Salt and SHA-256 documentation
  - setStateToUser
```
public Boolean setStateToUser(long id,
                              int state)
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              URISyntaxException
```
    Set User State
    
    Parameters:
    
    id - Id of the user to be modified
    
    state - Set to the state value. [Unapproved: 0, Approved (licensed): 1, Rejected: 2, Unlicensed: 3]
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Set User State documentation
  - setCustomAttributeToUser
```
public Boolean setCustomAttributeToUser(long id,
                                        Map<String,Object> customAttributes)
                                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                        URISyntaxException
```
    Set Custom Attribute Value
    
    Parameters:
    
    id - Id of the user to be modified
    
    customAttributes - Provide one or more key value pairs composed of the custom attribute field shortname and the value that you want to set the field to.
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Set Custom Attribute Value documentation
  - logUserOut
```
public Boolean logUserOut(long id)
                   throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                          org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                          URISyntaxException
```
    Log a user out of any and all sessions.
    
    Parameters:
    
    id - Id of the user to be modified
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Log User Out documentation
  - lockUser
```
public Boolean lockUser(long id,
                        int minutes)
                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                        URISyntaxException
```
    Use this call to lock a user’s account based on the policy assigned to the user, for a specific time you define in the request, or until you unlock it.
    
    Parameters:
    
    id - Id of the user to be modified
    
    minutes - Set to the number of minutes for which you want to lock the user account. (0 to delegate on policy)
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Lock User Account documentation
  - deleteUser
```
public Boolean deleteUser(long id)
                   throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                          org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                          URISyntaxException
```
    Deletes an user
    
    Parameters:
    
    id - Id of the user to be deleted
    
    Returns:
    
    true if success
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Delete User by ID documentation
  - getRoles
```
public List<Role> getRoles(HashMap<String,String> queryParameters,
                           int maxResults)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of Role resources.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource Parameters to filter the result of the list
    
    maxResults - Limit the number of roles returned (optional)
    
    Returns:
    
    List of Role
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at getResource call
    
    See Also:
    
    Role, Get Roles documentation
  - getRolesBatch
```
public OneLoginResponse<Role> getRolesBatch(int batchSize)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            URISyntaxException
```
    Get a batch of Roles.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    Returns:
    
    OneLoginResponse of Role (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles documentation
  - getRolesBatch
```
public OneLoginResponse<Role> getRolesBatch(int batchSize,
                                            String afterCursor)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            URISyntaxException
```
    Get a batch of Roles.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of Role (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles documentation
  - getRolesBatch
```
public OneLoginResponse<Role> getRolesBatch(HashMap<String,String> queryParameters,
                                            int batchSize,
                                            String afterCursor)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            URISyntaxException
```
    Get a batch of Roles.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of Role (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles documentation
  - getRoles
```
public List<Role> getRoles(HashMap<String,String> queryParameters)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of Role resources.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource Parameters to filter the result of the list
    
    Returns:
    
    List of Role
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles documentation
  - getRoles
```
public List<Role> getRoles(int maxResults)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of Role resources.
    
    Parameters:
    
    maxResults - Limit the number of roles returned (optional)
    
    Returns:
    
    List of Role
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles documentation
  - getRoles
```
public List<Role> getRoles()
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           URISyntaxException
```
    Gets a list of Role resources
    
    Returns:
    
    List of Role
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Roles documentation
  - getRole
```
public Role getRole(long id)
             throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                    org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                    URISyntaxException
```
    Gets Role by ID.
    
    Parameters:
    
    id - Id of the role
    
    Returns:
    
    Role
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Role, Get Role by ID documentation
  - getEventTypes
```
public List<EventType> getEventTypes()
                              throws URISyntaxException,
                                     org.apache.http.client.ClientProtocolException,
                                     IOException
```
    List of all OneLogin event types available to the Events API.
    
    Returns:
    
    List of EventType
    
    Throws:
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    IOException - - if CloseableHttpClient raises the exception
    
    org.apache.http.client.ClientProtocolException - - if CloseableHttpClient raises the exception
    
    See Also:
    
    EventType, Get Event Types documentation
  - getEvents
```
public List<Event> getEvents(HashMap<String,String> queryParameters,
                             int maxResults)
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of Event resources.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource Parameters to filter the result of the list
    
    maxResults - Limit the number of events returned (optional)
    
    Returns:
    
    List of Event
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEventsBatch
```
public OneLoginResponse<Event> getEventsBatch(int batchSize)
                                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                              URISyntaxException
```
    Get a batch of Events.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    Returns:
    
    OneLoginResponse of Event (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEventsBatch
```
public OneLoginResponse<Event> getEventsBatch(int batchSize,
                                              String afterCursor)
                                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                              URISyntaxException
```
    Get a batch of Events.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of Event (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEventsBatch
```
public OneLoginResponse<Event> getEventsBatch(HashMap<String,String> queryParameters,
                                              int batchSize,
                                              String afterCursor)
                                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                              URISyntaxException
```
    Get a batch of Events.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of Event (Batch)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEvents
```
public List<Event> getEvents(HashMap<String,String> queryParameters)
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of Event resources.
    
    Parameters:
    
    queryParameters - Query parameters of the Resource Parameters to filter the result of the list
    
    Returns:
    
    List of Event
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEvents
```
public List<Event> getEvents(int maxResults)
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of Event resources.
    
    Parameters:
    
    maxResults - Limit the number of events returned (optional)
    
    Returns:
    
    List of Event
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEvents
```
public List<Event> getEvents()
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of Event resources. (50 elements)
    
    Returns:
    
    List of Event
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Events documentation
  - getEvent
```
public Event getEvent(long id)
               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                      URISyntaxException
```
    Gets Event by ID.
    
    Parameters:
    
    id - Id of the event
    
    Returns:
    
    Event
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Get Event by ID documentation
  - createEvent
```
public void createEvent(Map<String,Object> eventParams)
                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                        URISyntaxException
```
    Create an event in the OneLogin event log.
    
    Parameters:
    
    eventParams - Event Data (event_type_id, account_id, actor_system, actor_user_id, actor_user_name, app_id, assuming_acting_user_id, custom_message, directory_sync_run_id, group_id, group_name, ipaddr, otp_device_id, otp_device_name, policy_id, policy_name, role_id, role_name, user_id, user_name)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Event, Create Event documentation
  - getGroups
```
public List<Group> getGroups(int maxResults)
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of Group resources (element of groups limited with the limit parameter).
    
    Parameters:
    
    maxResults - Limit the number of groups returned (optional)
    
    Returns:
    
    List of Group
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the getResource call
    
    See Also:
    
    Group, Get Groups documentation
  - getGroups
```
public List<Group> getGroups()
                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                             URISyntaxException
```
    Gets a list of Group resources.
    
    Returns:
    
    List of Group
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Group, Get Groups documentation
  - getGroupsBatch
```
public OneLoginResponse<Group> getGroupsBatch(int batchSize)
                                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                              URISyntaxException
```
    Get a batch of Groups.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    Returns:
    
    OneLoginResponse of Group
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Group, Get Groups documentation
  - getGroupsBatch
```
public OneLoginResponse<Group> getGroupsBatch(int batchSize,
                                              String afterCursor)
                                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                              URISyntaxException
```
    Get a batch of Groups.
    
    Parameters:
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of Group
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Group, Get Groups documentation
  - getGroupsBatch
```
public OneLoginResponse<Group> getGroupsBatch(HashMap<String,String> queryParameters,
                                              int batchSize,
                                              String afterCursor)
                                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                              URISyntaxException
```
    Get a batch of Groups
    
    Parameters:
    
    queryParameters - Query parameters of the Resource
    
    batchSize - Size of the Batch
    
    afterCursor - Reference to continue collecting items of next page
    
    Returns:
    
    OneLoginResponse of Group
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Group, Get Groups documentation
  - getGroup
```
public Group getGroup(long id)
               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                      URISyntaxException
```
    Gets Group by ID.
    
    Parameters:
    
    id - Id of the group
    
    Returns:
    
    Group
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Group, Get Group by ID documentation
  - getSAMLAssertion
```
public SAMLEndpointResponse getSAMLAssertion(String usernameOrEmail,
                                             String password,
                                             String appId,
                                             String subdomain,
                                             String ipAddress)
                                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                             URISyntaxException
```
    Generates a SAML Assertion.
    
    Parameters:
    
    usernameOrEmail - username or email of the OneLogin user accessing the app
    
    password - Password of the OneLogin user accessing the app
    
    appId - App ID of the app for which you want to generate a SAML token
    
    subdomain - subdomain of the OneLogin account related to the user/app
    
    ipAddress - whitelisted IP address that needs to be bypassed (some MFA scenarios).
    
    Returns:
    
    SAMLEndpointResponse
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    SAMLEndpointResponse, Generate SAML Assertion documentation
  - getSAMLAssertion
```
public SAMLEndpointResponse getSAMLAssertion(String usernameOrEmail,
                                             String password,
                                             String appId,
                                             String subdomain)
                                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                             URISyntaxException
```
    Generates a SAML Assertion.
    
    Parameters:
    
    usernameOrEmail - username or email of the OneLogin user accessing the app
    
    password - Password of the OneLogin user accessing the app
    
    appId - App ID of the app for which you want to generate a SAML token
    
    subdomain - subdomain of the OneLogin user accessing the app
    
    Returns:
    
    SAMLEndpointResponse
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    SAMLEndpointResponse, Generate SAML Assertion documentation
  - getSAMLAssertionVerifying
```
public SAMLEndpointResponse getSAMLAssertionVerifying(String appId,
                                                      String devideId,
                                                      String stateToken,
                                                      String otpToken,
                                                      String urlEndpoint,
                                                      Boolean doNotNotify)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      URISyntaxException
```
    Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
    
    Parameters:
    
    appId - App ID of the app for which you want to generate a SAML token
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    otpToken - Provide the OTP value for the MFA factor you are submitting for verification.
    
    urlEndpoint - Specify an url where return the response.
    
    doNotNotify - When verifying MFA via Protect Push, set this to true to stop additional push notifications being sent to the OneLogin Protect device
    
    Returns:
    
    SAMLEndpointResponse
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    SAMLEndpointResponse, Verify Factor documentation
  - getSAMLAssertionVerifying
```
public SAMLEndpointResponse getSAMLAssertionVerifying(String appId,
                                                      String devideId,
                                                      String stateToken,
                                                      String otpToken,
                                                      String urlEndpoint)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      URISyntaxException
```
    Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
    
    Parameters:
    
    appId - App ID of the app for which you want to generate a SAML token
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    otpToken - Provide the OTP value for the MFA factor you are submitting for verification.
    
    urlEndpoint - Specify an url where return the response.
    
    Returns:
    
    SAMLEndpointResponse
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    SAMLEndpointResponse, Verify Factor documentation
  - getSAMLAssertionVerifying
```
public SAMLEndpointResponse getSAMLAssertionVerifying(String appId,
                                                      String devideId,
                                                      String stateToken,
                                                      String otpToken)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      URISyntaxException
```
    Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
    
    Parameters:
    
    appId - App ID of the app for which you want to generate a SAML token
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    otpToken - Provide the OTP value for the MFA factor you are submitting for verification.
    
    Returns:
    
    SAMLEndpointResponse
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    SAMLEndpointResponse, Verify Factor documentation
  - getSAMLAssertionVerifying
```
public SAMLEndpointResponse getSAMLAssertionVerifying(String appId,
                                                      String devideId,
                                                      String stateToken)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      URISyntaxException
```
    Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
    
    Parameters:
    
    appId - App ID of the app for which you want to generate a SAML token
    
    devideId - Provide the MFA device_id you are submitting for verification.
    
    stateToken - Provide the state_token associated with the MFA device_id you are submitting for verification.
    
    Returns:
    
    SAMLEndpointResponse
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    SAMLEndpointResponse, Verify Factor documentation
  - getFactors
```
public List<AuthFactor> getFactors(long userId)
                            throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                   org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                   URISyntaxException
```
    Returns a list of authentication factors that are available for user enrollment via API.
    
    Parameters:
    
    userId - The id of the user.
    
    Returns:
    
    Array AuthFactor list
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Get Available Authentication Factors documentation
  - enrollFactor
```
public OTPDevice enrollFactor(long userId,
                              long factorId,
                              String displayName,
                              String number)
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              URISyntaxException
```
    Enroll a user with a given authentication factor.
    
    Parameters:
    
    userId - The id of the user.
    
    factorId - The identifier of the factor to enroll the user with.
    
    displayName - A name for the users device.
    
    number - The phone number of the user in E.164 format.
    
    Returns:
    
    OTPDevice The MFA device
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Enroll an Authentication Factor documentation
  - getEnrolledFactors
```
public List<OTPDevice> getEnrolledFactors(long userId)
                                   throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                          org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                          URISyntaxException
```
    Return a list of authentication factors registered to a particular user for multifactor authentication (MFA)
    
    Parameters:
    
    userId - The id of the user.
    
    Returns:
    
    Array OTPDevice list
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Get Enrolled Authentication Factors documentation
  - activateFactor
```
public FactorEnrollmentResponse activateFactor(long userId,
                                               long deviceId)
                                        throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                               org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                               URISyntaxException
```
    Triggers an SMS or Push notification containing a One-Time Password (OTP) that can be used to authenticate a user with the Verify Factor call.
    
    Parameters:
    
    userId - The id of the user.
    
    deviceId - the id of the MFA device.
    
    Returns:
    
    FactorEnrollmentResponse Info with User Id, Device Id, and OTP Device
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Activate an Authentication Factor documentation
  - verifyFactor
```
public Boolean verifyFactor(long userId,
                            long deviceId,
                            String otpToken,
                            String stateToken)
                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                            URISyntaxException
```
    Authenticates a one-time password (OTP) code provided by a multifactor authentication (MFA) device.
    
    Parameters:
    
    userId - The id of the user.
    
    deviceId - The id of the MFA device.
    
    otpToken - OTP code provided by the device or SMS message sent to user. When a device like OneLogin Protect that supports Push has been used you do not need to provide the otp_token.
    
    stateToken - The state_token is returned after a successful request to Enroll a Factor or Activate a Factor. MUST be provided if the needs_trigger attribute from the proceeding calls is set to true.
    
    Returns:
    
    Boolean True if Factor is verified
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify an Authentication Factor documentation
  - verifyFactor
```
public Boolean verifyFactor(long userId,
                            long deviceId,
                            String otpToken)
                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                            URISyntaxException
```
    Authenticates a one-time password (OTP) code provided by a multifactor authentication (MFA) device.
    
    Parameters:
    
    userId - The id of the user.
    
    deviceId - The id of the MFA device.
    
    otpToken - OTP code provided by the device or SMS message sent to user. When a device like OneLogin Protect that supports Push has been used you do not need to provide the otp_token.
    
    Returns:
    
    Boolean True if Factor is verified
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify an Authentication Factor documentation
  - verifyFactor
```
public Boolean verifyFactor(long userId,
                            long deviceId)
                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                            URISyntaxException
```
    Authenticates a one-time password (OTP) code provided by a multifactor authentication (MFA) device.
    
    Parameters:
    
    userId - The id of the user.
    
    deviceId - The id of the MFA device.
    
    Returns:
    
    Boolean True if Factor is verified
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Verify an Authentication Factor documentation
  - removeFactor
```
public Boolean removeFactor(long userId,
                            long deviceId)
                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                            URISyntaxException
```
    Remove an enrolled factor from a user.
    
    Parameters:
    
    userId - The id of the user.
    
    deviceId - The device_id of the MFA device.
    
    Returns:
    
    Boolean True if action succeed
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Remove a Factor documentation
  - generateInviteLink
```
public String generateInviteLink(String email)
                          throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                 org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                 URISyntaxException
```
    Generates an invite link for a user that you have already created in your OneLogin account.
    
    Parameters:
    
    email - Set to the email address of the user that you want to generate an invite link for.
    
    Returns:
    
    String with the link
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Generate Invite Link documentation
  - sendInviteLink
```
public Boolean sendInviteLink(String email,
                              String personalEmail)
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              URISyntaxException
```
    Sends an invite link to a user that you have already created in your OneLogin account.
    
    Parameters:
    
    email - Set to the email address of the user that you want to send an invite link for.
    
    personalEmail - If you want to send the invite email to an email other than the one provided in email, provide it here. The invite link will be sent to this address instead.
    
    Returns:
    
    True if the mail with the link was sent
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Send Invite Link documentation
  - sendInviteLink
```
public Boolean sendInviteLink(String email)
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              URISyntaxException
```
    Send an invite link to a user that you have already created in your OneLogin account.
    
    Parameters:
    
    email - Set to the email address of the user that you want to send an invite link for.
    
    Returns:
    
    True if the mail with the link was sent
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONResourceResponse and throwOAuthProblemException is enabled
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    See Also:
    
    Send Invite Link documentation
  - getEmbedApps
```
public List<EmbedApp> getEmbedApps(String token,
                                   String email)
                            throws URISyntaxException,
                                   org.apache.http.client.ClientProtocolException,
                                   IOException,
                                   ParserConfigurationException,
                                   SAXException,
                                   XPathExpressionException
```
    Lists apps accessible by a OneLogin user.
    
    Parameters:
    
    token - Provide your embedding token.
    
    email - Provide the email of the user for which you want to return a list of apps to be embed.
    
    Returns:
    
    String that contains an XML with the App info
    
    Throws:
    
    URISyntaxException - - if there is an error when generating the target URL at the URIBuilder constructor
    
    IOException - - if DocumentBuilder, CloseableHttpClient or EntityUtils raises the exception
    
    org.apache.http.client.ClientProtocolException - - if CloseableHttpClient raises the exception
    
    ParserConfigurationException - - if a DocumentBuilder cannot be created which satisfies the configuration requested.
    
    SAXException - - If any parse errors occur when calling parse method of DocumentBuilder
    
    XPathExpressionException - - If XPathExpression cannot be evaluated.
    
    See Also:
    
    App, Get Apps to Embed for a User documentation
  - prepareToken
```
public void prepareToken()
                  throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                         org.apache.oltu.oauth2.common.exception.OAuthProblemException
```
    Prepare the client before execute a call to the API (get token ready)
    
    Throws:
    
    org.apache.oltu.oauth2.common.exception.OAuthSystemException - - if there is a IOException reading parameters of the httpURLConnection
    
    org.apache.oltu.oauth2.common.exception.OAuthProblemException - - if there are errors validating the OneloginOAuthJSONAccessTokenResponse and throwOAuthProblemException is enabled
  - isExpired
```
public boolean isExpired()
```
    Returns:
    
    when the token has expired.
  - getError
```
public String getError()
```
    Returns:
    
    the last error
  - getErrorDescription
```
public String getErrorDescription()
```
    Returns:
    
    the last error description
  - getErrorAttribute
```
public String getErrorAttribute()
```
    Returns:
    
    the last error attribute
  - cleanError
```
public void cleanError()
```
    Clean error message
  - getAuthorizedHeader
```
protected Map<String,String> getAuthorizedHeader(Boolean bearer)
```
  - getAuthorizedHeader
```
protected Map<String,String> getAuthorizedHeader()
```
  - getAuthorization
```
protected String getAuthorization(Boolean bearer)
```
  - getAuthorization
```
protected String getAuthorization()
```
  - getIP
```
public String getIP()
```

Class Client

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

CUSTOM_USER_AGENT

accessToken

refreshToken

expiration

error

errorDescription

errorAttribute

settings

userAgent

maxResults

Constructor Detail

Client

Client

Client

Client

Client

Client

Method Detail

getAccessToken

refreshToken

revokeToken

getRateLimit

getUsers

getUsersBatch

getUsersBatch

getUsersBatch

getUsers

getUsers

getUsers

getUser

getUserApps

getUserRoles

getCustomAttributes

createUser

createSessionLoginToken

createSessionLoginToken

getSessionTokenVerified

getSessionTokenVerified

getSessionTokenVerified

getSessionTokenVerified

updateUser

assignRoleToUser

removeRoleFromUser

setPasswordUsingClearText

setPasswordUsingHashSalt

setPasswordUsingHashSalt

setStateToUser

setCustomAttributeToUser

logUserOut

lockUser

deleteUser

getRoles

getRolesBatch

getRolesBatch

getRolesBatch

getRoles

getRoles

getRoles

getRole

getEventTypes

getEvents

getEventsBatch

getEventsBatch

getEventsBatch

getEvents

getEvents

getEvents

getEvent

createEvent

getGroups

getGroups

getGroupsBatch

getGroupsBatch