com.vendasta.sso.v1

Class IdentityProviderClient

java.lang.Object

com.vendasta.sso.v1.internal.IdentityProviderGeneratedClient

com.vendasta.sso.v1.IdentityProviderClient

All Implemented Interfaces:

IdentityProviderClientInterface

public class IdentityProviderClient
extends IdentityProviderGeneratedClient

Provides functions to implement the Identity Provider for Vendasta sso Authentication is done by reading the path set in the environment variable

VENDASTA_APPLICATION_CREDENTIALS

unless the service account has been specified as an input stream to the constructor This env var should be a path pointing to your Service Account Private Key that you have previously downloaded (as described here)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdentityProviderClient.AccountContext A context indicating SSO is being requested for a particular account
static class	IdentityProviderClient.BrandContext A context indicating SSO is being requested for a particular brand
class	IdentityProviderClient.InvalidContextException
class	IdentityProviderClient.JsonParseException
static class	IdentityProviderClient.PartnerContext A context indicating SSO is being requested for a particular partner (not tied to a single account, but still scoped to a single partner)
class	IdentityProviderClient.ServiceContext Encapsulates the different types of contexts that can be decoded from the base64 encoded 'serviceContext' query param
class	IdentityProviderClient.SessionNotFoundException
class	IdentityProviderClient.UnknownContextException

Nested classes/interfaces inherited from class com.vendasta.sso.v1.internal.IdentityProviderGeneratedClient

IdentityProviderGeneratedClient.Options

Constructor Summary

Constructors

Constructor and Description
IdentityProviderClient(com.vendasta.vax.Environment environment) Constructs an identity provider client that will hit the environment provided.
IdentityProviderClient(com.vendasta.vax.Environment environment, float defaultTimeout) Constructs an identity provider client that will hit the environment provided.
IdentityProviderClient(com.vendasta.vax.Environment environment, InputStream serviceAccount, float defaultTimeout) Constructs an identity provider client that will hit the environment provided.
IdentityProviderClient(com.vendasta.vax.Environment environment, InputStream serviceAccount, IdentityProviderGeneratedClient.Options options) Constructs an identity provider client that will hit the environment provided.

Method Summary

Modifier and Type	Method and Description
String	getEntryURL(String serviceProviderID, IdentityProviderClient.AccountContext context) RPC for getting the entry URL of a service provider
String	getEntryURL(String serviceProviderID, IdentityProviderClient.BrandContext context) RPC for getting the entry URL of a service provider
String	getEntryURL(String serviceProviderID, IdentityProviderClient.PartnerContext context) RPC for getting the entry URL of a service provider
String	getEntryURL(String serviceProviderID, String encodedContext) RPC for getting the entry URL of a service provider
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, IdentityProviderClient.AccountContext context, String nextURL) RPC for getting the entry URL of the service provider, with the authentication code attached
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, IdentityProviderClient.AccountContext context, String nextURL, String backUrl, String backUrlText) RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, IdentityProviderClient.BrandContext context, String nextURL) RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be passed
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, IdentityProviderClient.BrandContext context, String nextURL, String backUrl, String backUrlText) RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be passed
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, IdentityProviderClient.PartnerContext context, String nextURL) RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, IdentityProviderClient.PartnerContext context, String nextURL, String backUrl, String backUrlText) RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, String encodedContext, String nextURL) RPC for getting the entry URL of the service provider, with the authentication code attached
String	getEntryURLWithCode(String serviceProviderID, String sessionID, String userID, String email, String encodedContext, String nextURL, String backUrl, String backUrlText) RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass
void	logout(String sessionID) RPC for logging the user out of all active sessions, regardless of service provider

Methods inherited from class com.vendasta.sso.v1.internal.IdentityProviderGeneratedClient

GetEntryURL, GetEntryURLWithCode, GetMultiEntryURL, Logout

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityProviderClient

public IdentityProviderClient(com.vendasta.vax.Environment environment)

Constructs an identity provider client that will hit the environment provided. * Will use the VENDASTA_APPLICATION_CREDENTIALS environment param

Parameters:

environment - The environment for the api calls coming out of this class to go to.

IdentityProviderClient

public IdentityProviderClient(com.vendasta.vax.Environment environment,
                              float defaultTimeout)

Constructs an identity provider client that will hit the environment provided. Will use the VENDASTA_APPLICATION_CREDENTIALS environment param

Parameters:

environment - The environment for the api calls coming out of this class to go to.

defaultTimeout - The duration in milliseconds that the sdk will cancel the api call after.

IdentityProviderClient

public IdentityProviderClient(com.vendasta.vax.Environment environment,
                              InputStream serviceAccount,
                              float defaultTimeout)

Constructs an identity provider client that will hit the environment provided.

Parameters:

environment - The environment for the api calls coming out of this class to go to.

serviceAccount - The input stream of the service account to authenticate the requests with

defaultTimeout - The duration in milliseconds that the sdk will cancel the api call after.

IdentityProviderClient

public IdentityProviderClient(com.vendasta.vax.Environment environment,
                              InputStream serviceAccount,
                              IdentityProviderGeneratedClient.Options options)

Constructs an identity provider client that will hit the environment provided.

Parameters:

environment - The environment for the api calls coming out of this class to go to.

serviceAccount - The input stream of the service account to authenticate the requests with

options - The Options for the client, ie whether or not to use gRPC, or setting a default timeout

Method Detail

getEntryURL

public String getEntryURL(String serviceProviderID,
                          String encodedContext)
                   throws com.vendasta.vax.SDKException

RPC for getting the entry URL of a service provider

Parameters:

serviceProviderID - The ID of the service provider (such as a marketplace application)

encodedContext - A base64 encoded JSON string representing a particular ServiceContext, provided in the serviceContext query param of a session transfer handler request. The context helps form the entry URL by providing parametrized fields, such as an account ID.

Returns:

The entry URL

Throws:

com.vendasta.vax.SDKException - Any SDK exception

IdentityProviderClient.UnknownContextException - when the context type cannot be determined, or the context is corrupt

IdentityProviderClient.JsonParseException - when the context's content is not parsable json

getEntryURL

public String getEntryURL(String serviceProviderID,
                          IdentityProviderClient.AccountContext context)
                   throws com.vendasta.vax.SDKException

RPC for getting the entry URL of a service provider

Parameters:

serviceProviderID - The ID of the service provider (such as a marketplace application)

context - The context helps form the entry URL by providing parametrized fields, such as an account ID

Returns:

The entry URL

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURL

public String getEntryURL(String serviceProviderID,
                          IdentityProviderClient.BrandContext context)
                   throws com.vendasta.vax.SDKException

RPC for getting the entry URL of a service provider

Parameters:

serviceProviderID - The ID of the service provider (such as a marketplace application)

context - The context helps form the entry URL by providing parametrized fields, such as an account ID

Returns:

The entry URL

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURL

public String getEntryURL(String serviceProviderID,
                          IdentityProviderClient.PartnerContext context)
                   throws com.vendasta.vax.SDKException

RPC for getting the entry URL of a service provider

Parameters:

serviceProviderID - The ID of the service provider (such as a marketplace application)

context - The context helps form the entry URL by providing parametrized fields, such as a partner ID

Returns:

The entry URL

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  String encodedContext,
                                  String nextURL)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

encodedContext - A base64 encoded JSON string representing a particular ServiceContext, provided in the serviceContext query param of a session transfer handler request. The context helps form the entry URL by providing parametrized fields, such as an account ID.

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

IdentityProviderClient.UnknownContextException - when the context type cannot be determined, or the context is corrupt

IdentityProviderClient.JsonParseException - when the context's content is not parsable json

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  String encodedContext,
                                  String nextURL,
                                  String backUrl,
                                  String backUrlText)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

encodedContext - A base64 encoded JSON string representing a particular ServiceContext, provided in the serviceContext query param of a session transfer handler request. The context helps form the entry URL by providing parametrized fields, such as an account ID.

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

backUrl - The Back URL to be used in the navigation bar

backUrlText - The next URL Text to be used in the navigation bar

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

IdentityProviderClient.UnknownContextException - when the context type cannot be determined, or the context is corrupt

IdentityProviderClient.JsonParseException - when the context's content is not parsable json

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  IdentityProviderClient.AccountContext context,
                                  String nextURL)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

context - The context helps form the entry URL by providing parametrized fields, such as an account ID

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  IdentityProviderClient.AccountContext context,
                                  String nextURL,
                                  String backUrl,
                                  String backUrlText)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

context - The context helps form the entry URL by providing parametrized fields, such as an account ID

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

backUrl - The Back URL to be used in the navigation bar

backUrlText - The next URL Text to be used in the navigation bar

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  IdentityProviderClient.PartnerContext context,
                                  String nextURL)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

context - The context helps form the entry URL by providing parametrized fields, such as a partner ID

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  IdentityProviderClient.PartnerContext context,
                                  String nextURL,
                                  String backUrl,
                                  String backUrlText)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be pass

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

context - The context helps form the entry URL by providing parametrized fields, such as a partner ID

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

backUrl - The Back URL to be used in the navigation bar

backUrlText - The next URL Text to be used in the navigation bar

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  IdentityProviderClient.BrandContext context,
                                  String nextURL)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be passed

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

context - The context helps form the entry URL by providing parametrized fields, such as a partner ID

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

getEntryURLWithCode

public String getEntryURLWithCode(String serviceProviderID,
                                  String sessionID,
                                  String userID,
                                  String email,
                                  IdentityProviderClient.BrandContext context,
                                  String nextURL,
                                  String backUrl,
                                  String backUrlText)
                           throws com.vendasta.vax.SDKException

RPC for getting the entry URL of the service provider, with the authentication code attached This method is overloaded for allowing back url and back url text parameters to be passed

Parameters:

serviceProviderID - The ID of a service provider (such as a marketplace application)

sessionID - The user's session ID. This can be the session ID directly from your application, or it can be a hashed version, or something else unique. Whatever it is, the same session ID must be passed to the logout RPC.

userID - The user's ID

email - The user's email

context - The context helps form the entry URL by providing parametrized fields, such as a partner ID

nextURL - The next URL to send the user to, once the code exchange is complete on the entry URL

Returns:

The entry URL, with the authentication code attached

Throws:

com.vendasta.vax.SDKException - Any SDK exception

logout

public void logout(String sessionID)
            throws com.vendasta.vax.SDKException

RPC for logging the user out of all active sessions, regardless of service provider

Parameters:

sessionID - The session ID that was provided to the getEntryURLWithCode RPC

Throws:

com.vendasta.vax.SDKException - Any SDK exception