com.atlassian.plugins.authentication.sso.rest

Class LoginOptionsResource

java.lang.Object

com.atlassian.plugins.authentication.sso.rest.LoginOptionsResource

public class LoginOptionsResource
extends Object

Constructor Summary

Constructors

Constructor and Description
LoginOptionsResource(LoginOptionsService loginOptionsService, JsmUrlChecker jsmUrlChecker, com.atlassian.sal.api.ApplicationProperties applicationProperties)

Method Summary

Modifier and Type	Method and Description
RestPage<LoginOptionEntity>	getLoginOptions(String referer) This endpoint returns the available login options.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoginOptionsResource

@Inject
public LoginOptionsResource(LoginOptionsService loginOptionsService,
                                    JsmUrlChecker jsmUrlChecker,
                                    com.atlassian.sal.api.ApplicationProperties applicationProperties)

Method Detail

getLoginOptions

public RestPage<LoginOptionEntity> getLoginOptions(@HeaderParam(value="Referer")
                                                   String referer)

This endpoint returns the available login options. Login options can either be the native login form or the configured IdPs. Only enabled login options will be returned. Note that this endpoint returns a paging-like response despite ignoring page parameters. This is a conscious decision made for the initial release of multiple IdPs. It unifies the API with IdP returning endpoints and allows us to implement paging without breaking the API if need be. It is unlikely that this endpoint will be paged though, the most likely course of action is that the server will limit the choices for a given user basing on yet to be disclosed criteria.

Parameters:

referer - the address of the page making the request, used to determine if the request is made in context of JSM or not

Returns:

the available login options