org.mozilla.taskcluster.client.login

Class Login

java.lang.Object

org.mozilla.taskcluster.client.TaskClusterRequestHandler

org.mozilla.taskcluster.client.login.Login

public class Login
extends TaskClusterRequestHandler

The Login service serves as the interface between external authentication systems and TaskCluster credentials. It acts as the server side of https://tools.taskcluster.net. If you are working on federating logins with TaskCluster, this is probably not the service you are looking for. Instead, use the federated login support in the tools site.

The API methods described here issue temporary credentials based on an assertion. The assertion identifies the user, usually with an email-like string. This string is then passed through a series of authorizers, each of which may supply scopes to be included in the credentials. Finally, the service generates temporary credentials based on those scopes.

The generated credentials include scopes to create new, permanent clients with names based on the user’s identifier. These credentials are periodically scanned for scopes that the user does not posess, and disabled if such scopes are discovered. Thus users can create long-lived credentials that are only usable until the user’s access level is reduced.

See Also:

Login API Documentation

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	defaultBaseURL

Constructor Summary

Constructors

Constructor and Description
Login()
Login(Credentials credentials)
Login(Credentials credentials, String baseURL)
Login(String baseURL)
Login(String clientId, String accessToken)
Login(String clientId, String accessToken, String certificate)

Method Summary

Modifier and Type	Method and Description
CallSummary<PersonaAssertionRequest,CredentialsResponse>	credentialsFromPersonaAssertion(PersonaAssertionRequest payload) Given an assertion, return an appropriate set of temporary credentials.
CallSummary<EmptyPayload,EmptyPayload>	ping() Documented later…

Methods inherited from class org.mozilla.taskcluster.client.TaskClusterRequestHandler

apiCall, setBaseURL, uriEncode

Methods inherited from class java.lang.Object

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

Field Detail

defaultBaseURL

protected static final String defaultBaseURL

See Also:

Constant Field Values

Constructor Detail

Login

public Login(Credentials credentials)

Login

public Login(Credentials credentials,
             String baseURL)

Login

public Login(String clientId,
             String accessToken)

Login

public Login(String clientId,
             String accessToken,
             String certificate)

Login

public Login(String baseURL)

Login

public Login()

Method Detail

credentialsFromPersonaAssertion

public CallSummary<PersonaAssertionRequest,CredentialsResponse> credentialsFromPersonaAssertion(PersonaAssertionRequest payload)
                                                                                         throws APICallFailure

Given an assertion, return an appropriate set of temporary credentials.

The supplied audience must be on a whitelist of TaskCluster-related sites configured in the login service. This is not a general-purpose assertion-verification service!

Throws:

APICallFailure

See Also:

Get TaskCluster credentials given a Persona assertion API Documentation

ping

public CallSummary<EmptyPayload,EmptyPayload> ping()
                                            throws APICallFailure

Documented later…

Warning this api end-point is not stable.

Throws:

APICallFailure

See Also:

Ping Server API Documentation