com.onelogin.sdk.conn

Class Client

java.lang.Object

com.onelogin.sdk.conn.Client

public class Client
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accessToken OAuth 2.0 Access Token
static java.lang.String	CUSTOM_USER_AGENT
protected java.lang.String	error Last error found
protected java.lang.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 java.lang.String	refreshToken OAuth 2.0 Refresh Token
protected Settings	settings Settings object
java.lang.String	userAgent The User-Agent to be used on requests
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
Client()
Client(int maxResults) Constructs the client to execute Onelogin's API calls.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	assignRoleToUser(long id, java.util.List<java.lang.Long> roleIds) Assigns Role to User
void	cleanError() Clean error message
void	createEvent(java.util.Map<java.lang.String,java.lang.Object> eventParams) Create an event in the OneLogin event log.
java.lang.Object	createSessionLoginToken(java.util.Map<java.lang.String,java.lang.Object> queryParams) Generate a session login token in scenarios in which MFA may or may not be required.
java.lang.Object	createSessionLoginToken(java.util.Map<java.lang.String,java.lang.Object> queryParams, java.lang.String allowedOrigin) Generates a session login token in scenarios in which MFA may or may not be required.
java.lang.String	createSessionViaToken(java.lang.String sessionToken) Post a session token to this API endpoint to start a session and set a cookie to log a user into an app.
User	createUser(java.util.Map<java.lang.String,java.lang.Object> userParams) Creates an user
java.lang.Boolean	deleteUser(long id) Deletes an user
java.lang.String	generateInviteLink(java.lang.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 java.lang.String	getAuthorization()
protected java.lang.String	getAuthorization(java.lang.Boolean bearer)
protected java.util.Map<java.lang.String,java.lang.String>	getAuthorizedHeader()
protected java.util.Map<java.lang.String,java.lang.String>	getAuthorizedHeader(java.lang.Boolean bearer)
java.util.List<java.lang.String>	getCustomAttributes() Gets a list of all custom attribute fields (also known as custom user fields) that have been defined for OL account.
java.util.List<EmbedApp>	getEmbedApps(java.lang.String token, java.lang.String email) Lists apps accessible by a OneLogin user.
java.lang.String	getError()
java.lang.String	getErrorDescription()
Event	getEvent(long id) Gets Event by ID.
java.util.List<Event>	getEvents() Gets a list of Event resources. (50 elements)
java.util.List<Event>	getEvents(java.util.HashMap<java.lang.String,java.lang.String> queryParameters) Gets a list of Event resources.
java.util.List<Event>	getEvents(java.util.HashMap<java.lang.String,java.lang.String> queryParameters, int maxResults) Gets a list of Event resources.
java.util.List<Event>	getEvents(int maxResults) Gets a list of Event resources.
java.util.List<EventType>	getEventTypes() List of all OneLogin event types available to the Events API.
Group	getGroup(long id) Gets Group by ID.
java.util.List<Group>	getGroups() Gets a list of Group resources.
java.util.List<Group>	getGroups(int maxResults) Gets a list of Group resources (element of groups limited with the limit parameter).
RateLimit	getRateLimit() Gets current rate limit details about an access token.
Role	getRole(long id) Gets Role by ID.
java.util.List<Role>	getRoles() Gets a list of Role resources
java.util.List<Role>	getRoles(java.util.HashMap<java.lang.String,java.lang.String> queryParameters) Gets a list of Role resources.
java.util.List<Role>	getRoles(java.util.HashMap<java.lang.String,java.lang.String> queryParameters, int maxResults) Gets a list of Role resources.
java.util.List<Role>	getRoles(int maxResults) Gets a list of Role resources.
SAMLEndpointResponse	getSAMLAssertion(java.lang.String usernameOrEmail, java.lang.String password, java.lang.String appId, java.lang.String subdomain) Generates a SAML Assertion.
SAMLEndpointResponse	getSAMLAssertion(java.lang.String usernameOrEmail, java.lang.String password, java.lang.String appId, java.lang.String subdomain, java.lang.String ipAddress) Generates a SAML Assertion.
SAMLEndpointResponse	getSAMLAssertionVerifying(java.lang.String appId, java.lang.String devideId, java.lang.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(java.lang.String appId, java.lang.String devideId, java.lang.String stateToken, java.lang.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(java.lang.String appId, java.lang.String devideId, java.lang.String stateToken, java.lang.String otpToken, java.lang.String urlEndpoint) Verifies a one-time password (OTP) value provided for a second factor when multi-factor authentication (MFA) is required for SAML authentication.
SessionTokenInfo	getSessionTokenVerified(java.lang.String devideId, java.lang.String stateToken) Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
SessionTokenInfo	getSessionTokenVerified(java.lang.String devideId, java.lang.String stateToken, java.lang.String otpToken) Verify a one-time password (OTP) value provided for multi-factor authentication (MFA).
User	getUser(long id) Gets User by ID.
java.util.List<App>	getUserApps(long id) Gets a list of apps accessible by a user, not including personal apps.
java.util.List<java.lang.Integer>	getUserRoles(long id) Gets a list of role IDs that have been assigned to a user.
java.util.List<User>	getUsers() Gets a list of User resources
java.util.List<User>	getUsers(java.util.HashMap<java.lang.String,java.lang.String> queryParameters) Gets a list of User resources.
java.util.List<User>	getUsers(java.util.HashMap<java.lang.String,java.lang.String> queryParameters, int maxResults) Gets a list of User resources.
java.util.List<User>	getUsers(int maxResults) Gets a list of User resources.
boolean	isExpired()
java.lang.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.
java.lang.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.
java.lang.Boolean	removeRoleFromUser(long id, java.util.List<java.lang.Long> roleIds) Remove Role from User
void	revokeToken() Revokes an access token and refresh token pair.
java.lang.Boolean	sendInviteLink(java.lang.String email) Send an invite link to a user that you have already created in your OneLogin account.
java.lang.Boolean	sendInviteLink(java.lang.String email, java.lang.String personalEmail) Sends an invite link to a user that you have already created in your OneLogin account.
java.lang.Boolean	setCustomAttributeToUser(long id, java.util.Map<java.lang.String,java.lang.Object> customAttributes) Set Custom Attribute Value
java.lang.Boolean	setPasswordUsingClearText(long id, java.lang.String password, java.lang.String passwordConfirmation) Sets Password by ID Using Cleartext
java.lang.Boolean	setPasswordUsingHashSalt(long id, java.lang.String password, java.lang.String passwordConfirmation, java.lang.String passwordAlgorithm) Set Password by ID Using Salt and SHA-256
java.lang.Boolean	setPasswordUsingHashSalt(long id, java.lang.String password, java.lang.String passwordConfirmation, java.lang.String passwordAlgorithm, java.lang.String passwordSalt) Set Password by ID Using Salt and SHA-256
User	updateUser(long id, java.util.Map<java.lang.String,java.lang.Object> userParams) Updates an user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

CUSTOM_USER_AGENT

public static final java.lang.String CUSTOM_USER_AGENT

See Also:

Constant Field Values

accessToken

protected java.lang.String accessToken

OAuth 2.0 Access Token

refreshToken

protected java.lang.String refreshToken

OAuth 2.0 Refresh Token

expiration

protected org.joda.time.DateTime expiration

OAuth 2.0 Token expiration

error

protected java.lang.String error

Last error found

errorDescription

protected java.lang.String errorDescription

Description of last error found

settings

protected Settings settings

Settings object

userAgent

public java.lang.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)
       throws java.io.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)

Throws:

java.io.IOException

Error

Client

public Client()
       throws java.io.IOException,
              Error

Throws:

java.io.IOException

Error

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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

See Also:

RateLimit, Get Rate Limit documentation

getUsers

public java.util.List<User> getUsers(java.util.HashMap<java.lang.String,java.lang.String> queryParameters,
                                     int maxResults)
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.URISyntaxException

Gets a list of User resources.

Parameters:

queryParameters - 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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

User, Get Users documentation

getUsers

public java.util.List<User> getUsers(java.util.HashMap<java.lang.String,java.lang.String> queryParameters)
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.URISyntaxException

Gets a list of User resources.

Parameters:

queryParameters - Parameters to filter the result of the list

Returns:

List of User

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

User, Get Users documentation

getUsers

public java.util.List<User> getUsers(int maxResults)
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

User, Get Users documentation

getUsers

public java.util.List<User> getUsers()
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.URISyntaxException

Gets a list of User resources

Returns:

List of User

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

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,
                    java.net.URISyntaxException

Gets User by ID.

Parameters:

id - Id of the user

Returns:

User

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

User, Get User by ID documentation

getUserApps

public java.util.List<App> getUserApps(long id)
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

App, Get Apps for a User documentation

getUserRoles

public java.util.List<java.lang.Integer> getUserRoles(long id)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Role, Get Roles for a User documentation

getCustomAttributes

public java.util.List<java.lang.String> getCustomAttributes()
                                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                            java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Get Custom Attributes documentation

createUser

public User createUser(java.util.Map<java.lang.String,java.lang.Object> userParams)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Create User documentation

createSessionLoginToken

public java.lang.Object createSessionLoginToken(java.util.Map<java.lang.String,java.lang.Object> queryParams,
                                                java.lang.String allowedOrigin)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Create Session Login Token documentation

createSessionLoginToken

public java.lang.Object createSessionLoginToken(java.util.Map<java.lang.String,java.lang.Object> queryParams)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Create Session Login Token documentation

getSessionTokenVerified

public SessionTokenInfo getSessionTokenVerified(java.lang.String devideId,
                                                java.lang.String stateToken,
                                                java.lang.String otpToken)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Verify Factor documentation

getSessionTokenVerified

public SessionTokenInfo getSessionTokenVerified(java.lang.String devideId,
                                                java.lang.String stateToken)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Verify Factor documentation

createSessionViaToken

public java.lang.String createSessionViaToken(java.lang.String sessionToken)
                                       throws java.net.URISyntaxException,
                                              org.apache.http.client.ClientProtocolException,
                                              java.io.IOException

Post a session token to this API endpoint to start a session and set a cookie to log a user into an app.

Parameters:

sessionToken - The session token

Returns:

Header 'Set-Cookie' value

Throws:

java.net.URISyntaxException

java.io.IOException

org.apache.http.client.ClientProtocolException

See Also:

Create Session Via API Token documentation

updateUser

public User updateUser(long id,
                       java.util.Map<java.lang.String,java.lang.Object> userParams)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Update User by ID documentation

assignRoleToUser

public java.lang.Boolean assignRoleToUser(long id,
                                          java.util.List<java.lang.Long> roleIds)
                                   throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                          org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                          java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Assign Role to User documentation

removeRoleFromUser

public java.lang.Boolean removeRoleFromUser(long id,
                                            java.util.List<java.lang.Long> roleIds)
                                     throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                            org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                            java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Remove Role from User documentation

setPasswordUsingClearText

public java.lang.Boolean setPasswordUsingClearText(long id,
                                                   java.lang.String password,
                                                   java.lang.String passwordConfirmation)
                                            throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                   org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                   java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Set Password by ID Using Cleartext documentation

setPasswordUsingHashSalt

public java.lang.Boolean setPasswordUsingHashSalt(long id,
                                                  java.lang.String password,
                                                  java.lang.String passwordConfirmation,
                                                  java.lang.String passwordAlgorithm,
                                                  java.lang.String passwordSalt)
                                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                  org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                  java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Set Password by ID Using Salt and SHA-256 documentation

setPasswordUsingHashSalt

public java.lang.Boolean setPasswordUsingHashSalt(long id,
                                                  java.lang.String password,
                                                  java.lang.String passwordConfirmation,
                                                  java.lang.String passwordAlgorithm)
                                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                  org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                  java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Set Password by ID Using Salt and SHA-256 documentation

setCustomAttributeToUser

public java.lang.Boolean setCustomAttributeToUser(long id,
                                                  java.util.Map<java.lang.String,java.lang.Object> customAttributes)
                                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                  org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                  java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Set Custom Attribute Value documentation

logUserOut

public java.lang.Boolean logUserOut(long id)
                             throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                    org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                    java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Log User Out documentation

lockUser

public java.lang.Boolean lockUser(long id,
                                  int minutes)
                           throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                  org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                  java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Lock User Account documentation

deleteUser

public java.lang.Boolean deleteUser(long id)
                             throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                    org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                    java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Delete User by ID documentation

getRoles

public java.util.List<Role> getRoles(java.util.HashMap<java.lang.String,java.lang.String> queryParameters,
                                     int maxResults)
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.URISyntaxException

Gets a list of Role resources.

Parameters:

queryParameters - 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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Role, Get Roles documentation

getRoles

public java.util.List<Role> getRoles(java.util.HashMap<java.lang.String,java.lang.String> queryParameters)
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.URISyntaxException

Gets a list of Role resources.

Parameters:

queryParameters - Parameters to filter the result of the list

Returns:

List of Role

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Role, Get Roles documentation

getRoles

public java.util.List<Role> getRoles(int maxResults)
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Role, Get Roles documentation

getRoles

public java.util.List<Role> getRoles()
                              throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                     org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                     java.net.URISyntaxException

Gets a list of Role resources

Returns:

List of Role

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

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,
                    java.net.URISyntaxException

Gets Role by ID.

Parameters:

id - Id of the role

Returns:

Role

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Role, Get Role by ID documentation

getEventTypes

public java.util.List<EventType> getEventTypes()
                                        throws java.net.URISyntaxException,
                                               org.apache.http.client.ClientProtocolException,
                                               java.io.IOException

List of all OneLogin event types available to the Events API.

Returns:

List of EventType

Throws:

java.net.URISyntaxException

java.io.IOException

org.apache.http.client.ClientProtocolException

See Also:

EventType, Get Event Types documentation

getEvents

public java.util.List<Event> getEvents(java.util.HashMap<java.lang.String,java.lang.String> queryParameters,
                                       int maxResults)
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.URISyntaxException

Gets a list of Event resources.

Parameters:

queryParameters - 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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Event, Get Events documentation

getEvents

public java.util.List<Event> getEvents(java.util.HashMap<java.lang.String,java.lang.String> queryParameters)
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.URISyntaxException

Gets a list of Event resources.

Parameters:

queryParameters - Parameters to filter the result of the list

Returns:

List of Event

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Event, Get Events documentation

getEvents

public java.util.List<Event> getEvents(int maxResults)
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Event, Get Events documentation

getEvents

public java.util.List<Event> getEvents()
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.URISyntaxException

Gets a list of Event resources. (50 elements)

Returns:

List of Event

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

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,
                      java.net.URISyntaxException

Gets Event by ID.

Parameters:

id - Id of the event

Returns:

Event

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Event, Get Event by ID documentation

createEvent

public void createEvent(java.util.Map<java.lang.String,java.lang.Object> eventParams)
                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                        java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Event, Create Event documentation

getGroups

public java.util.List<Group> getGroups(int maxResults)
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Group, Get Groups documentation

getGroups

public java.util.List<Group> getGroups()
                                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                       java.net.URISyntaxException

Gets a list of Group resources.

Returns:

List of Group

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

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,
                      java.net.URISyntaxException

Gets Group by ID.

Parameters:

id - Id of the group

Returns:

Group

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Group, Get Group by ID documentation

getSAMLAssertion

public SAMLEndpointResponse getSAMLAssertion(java.lang.String usernameOrEmail,
                                             java.lang.String password,
                                             java.lang.String appId,
                                             java.lang.String subdomain,
                                             java.lang.String ipAddress)
                                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                             java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

SAMLEndpointResponse, Generate SAML Assertion documentation

getSAMLAssertion

public SAMLEndpointResponse getSAMLAssertion(java.lang.String usernameOrEmail,
                                             java.lang.String password,
                                             java.lang.String appId,
                                             java.lang.String subdomain)
                                      throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                             org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                             java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

SAMLEndpointResponse, Generate SAML Assertion documentation

getSAMLAssertionVerifying

public SAMLEndpointResponse getSAMLAssertionVerifying(java.lang.String appId,
                                                      java.lang.String devideId,
                                                      java.lang.String stateToken,
                                                      java.lang.String otpToken,
                                                      java.lang.String urlEndpoint)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

SAMLEndpointResponse, Verify Factor documentation

getSAMLAssertionVerifying

public SAMLEndpointResponse getSAMLAssertionVerifying(java.lang.String appId,
                                                      java.lang.String devideId,
                                                      java.lang.String stateToken,
                                                      java.lang.String otpToken)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

SAMLEndpointResponse, Verify Factor documentation

getSAMLAssertionVerifying

public SAMLEndpointResponse getSAMLAssertionVerifying(java.lang.String appId,
                                                      java.lang.String devideId,
                                                      java.lang.String stateToken)
                                               throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                      org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                      java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

SAMLEndpointResponse, Verify Factor documentation

generateInviteLink

public java.lang.String generateInviteLink(java.lang.String email)
                                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                           java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Generate Invite Link documentation

sendInviteLink

public java.lang.Boolean sendInviteLink(java.lang.String email,
                                        java.lang.String personalEmail)
                                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                        java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Send Invite Link documentation

sendInviteLink

public java.lang.Boolean sendInviteLink(java.lang.String email)
                                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                        java.net.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

org.apache.oltu.oauth2.common.exception.OAuthProblemException

java.net.URISyntaxException

See Also:

Send Invite Link documentation

getEmbedApps

public java.util.List<EmbedApp> getEmbedApps(java.lang.String token,
                                             java.lang.String email)
                                      throws java.net.URISyntaxException,
                                             org.apache.http.client.ClientProtocolException,
                                             java.io.IOException,
                                             javax.xml.parsers.ParserConfigurationException,
                                             org.xml.sax.SAXException,
                                             javax.xml.xpath.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:

java.net.URISyntaxException

java.io.IOException

org.apache.http.client.ClientProtocolException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

javax.xml.xpath.XPathExpressionException

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.OAuthProblemException

org.apache.oltu.oauth2.common.exception.OAuthSystemException

isExpired

public boolean isExpired()

Returns:

when the token has expired.

getError

public java.lang.String getError()

Returns:

the last error

getErrorDescription

public java.lang.String getErrorDescription()

Returns:

the last error description

cleanError

public void cleanError()

Clean error message

getAuthorizedHeader

protected java.util.Map<java.lang.String,java.lang.String> getAuthorizedHeader(java.lang.Boolean bearer)

getAuthorizedHeader

protected java.util.Map<java.lang.String,java.lang.String> getAuthorizedHeader()

getAuthorization

protected java.lang.String getAuthorization(java.lang.Boolean bearer)

getAuthorization

protected java.lang.String getAuthorization()