com.citrix.sharefile.api.entities

Class SFSessionsEntity

java.lang.Object

com.citrix.sharefile.api.entities.SFEntitiesBase

com.citrix.sharefile.api.entities.SFSessionsEntity

public class SFSessionsEntity
extends SFEntitiesBase

Field Summary

Fields inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

client

Constructor Summary

Constructors

Constructor and Description
SFSessionsEntity(ISFApiClient client)

Method Summary

Methods

Modifier and Type	Method and Description
ISFQuery<SFSession>	acs() Get Assertion Consumer Service.
ISFQuery	delete() Logout Logout the current session - invalidate the current Session ID
ISFQuery<SFSession>	get() Get Session Retrieve the current authentication session object.
ISFQuery<SFSession>	login() Login API clients can provide ShareFile Authentication directly to any API operation using OAuth (Bearer).
ISFQuery<SFSession>	login(java.lang.String authmethod) Login API clients can provide ShareFile Authentication directly to any API operation using OAuth (Bearer).
ISFQuery<SFSession>	login(java.lang.String authmethod, java.lang.String authcomparison) Login API clients can provide ShareFile Authentication directly to any API operation using OAuth (Bearer).

Methods inherited from class com.citrix.sharefile.api.entities.SFEntitiesBase

getEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

SFSessionsEntity

public SFSessionsEntity(ISFApiClient client)

Method Detail

get

public ISFQuery<SFSession> get()

Get Session Retrieve the current authentication session object. If the client is not authenticated, this operation will challenge for ShareFile authentication using a 401 response. This method will not trigger the SAML authentication flow - use /Sessions/Login instead.

Returns:

The current authentication Context, based on the request SFAPI_AuthID Cookie

delete

public ISFQuery delete()

Logout Logout the current session - invalidate the current Session ID

login

public ISFQuery<SFSession> login(java.lang.String authmethod,
                        java.lang.String authcomparison)
                          throws InvalidOrMissingParameterException

Login API clients can provide ShareFile Authentication directly to any API operation using OAuth (Bearer). However, the client must know that the provided authentication type is supported on the API endpoint; and that SAML is not configured. This API provides a generic authentication routine for clients. It will challenge for ShareFile credentials passing all supported authentication methods; redirect to the SAML IDP if configured to do so; and handle certain HTTP headers, like device registration. If the client is already authenticated, the Session object is returned. If the client is not authenticated, and the account is not configured for SAML, then the API will challenge for a local authentication. If the account is configured for SAML, then the client will be redirected to the SAML IDP using the SAML passive flow - authentication will be performed at the IDP domain instead. The IDP callback will be on the API Acs, which will return a Session object if authentication is accepted. The following HTTP Headers are also processed in this request, and stored with the Session object: X-SFAPI-Tool: Tool string (user-agent equivalent for ShareFile)X-SFAPI-ToolVersion: Tool Version stringX-SFAPI-UserInitiated: true or false, indicates whether this is an interactive login, or re-authentication initiated by the ToolX-SFAPI-DeviceId: Device Identifier. If set to 'register', a new DeviceID will be generated. This will either create or associate an existing DeviceID to this session - indicates user is logging in using this DeviceX-SFAPI-DeviceName: Device Name. Only required/used when a registration process occurs.

Parameters:

authmethod - (default: null)

authcomparison - (default: null)

Returns:

A Session object, if authentication is successful

Throws:

InvalidOrMissingParameterException

login

public ISFQuery<SFSession> login(java.lang.String authmethod)
                          throws InvalidOrMissingParameterException

Login API clients can provide ShareFile Authentication directly to any API operation using OAuth (Bearer). However, the client must know that the provided authentication type is supported on the API endpoint; and that SAML is not configured. This API provides a generic authentication routine for clients. It will challenge for ShareFile credentials passing all supported authentication methods; redirect to the SAML IDP if configured to do so; and handle certain HTTP headers, like device registration. If the client is already authenticated, the Session object is returned. If the client is not authenticated, and the account is not configured for SAML, then the API will challenge for a local authentication. If the account is configured for SAML, then the client will be redirected to the SAML IDP using the SAML passive flow - authentication will be performed at the IDP domain instead. The IDP callback will be on the API Acs, which will return a Session object if authentication is accepted. The following HTTP Headers are also processed in this request, and stored with the Session object: X-SFAPI-Tool: Tool string (user-agent equivalent for ShareFile)X-SFAPI-ToolVersion: Tool Version stringX-SFAPI-UserInitiated: true or false, indicates whether this is an interactive login, or re-authentication initiated by the ToolX-SFAPI-DeviceId: Device Identifier. If set to 'register', a new DeviceID will be generated. This will either create or associate an existing DeviceID to this session - indicates user is logging in using this DeviceX-SFAPI-DeviceName: Device Name. Only required/used when a registration process occurs.

Parameters:

authmethod - (default: null)

Returns:

A Session object, if authentication is successful

Throws:

InvalidOrMissingParameterException

login

public ISFQuery<SFSession> login()

Login API clients can provide ShareFile Authentication directly to any API operation using OAuth (Bearer). However, the client must know that the provided authentication type is supported on the API endpoint; and that SAML is not configured. This API provides a generic authentication routine for clients. It will challenge for ShareFile credentials passing all supported authentication methods; redirect to the SAML IDP if configured to do so; and handle certain HTTP headers, like device registration. If the client is already authenticated, the Session object is returned. If the client is not authenticated, and the account is not configured for SAML, then the API will challenge for a local authentication. If the account is configured for SAML, then the client will be redirected to the SAML IDP using the SAML passive flow - authentication will be performed at the IDP domain instead. The IDP callback will be on the API Acs, which will return a Session object if authentication is accepted. The following HTTP Headers are also processed in this request, and stored with the Session object: X-SFAPI-Tool: Tool string (user-agent equivalent for ShareFile)X-SFAPI-ToolVersion: Tool Version stringX-SFAPI-UserInitiated: true or false, indicates whether this is an interactive login, or re-authentication initiated by the ToolX-SFAPI-DeviceId: Device Identifier. If set to 'register', a new DeviceID will be generated. This will either create or associate an existing DeviceID to this session - indicates user is logging in using this DeviceX-SFAPI-DeviceName: Device Name. Only required/used when a registration process occurs.

Returns:

A Session object, if authentication is successful

acs

public ISFQuery<SFSession> acs()

Get Assertion Consumer Service. This is the IDP callback endpoint in SAML authentication