org.mozilla.taskcluster.client.auth

Class AuthenticationSuccessfulResponse

java.lang.Object

org.mozilla.taskcluster.client.auth.AuthenticationSuccessfulResponse

public class AuthenticationSuccessfulResponse
extends Object

See http://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/anyOf[0]

Field Summary

Fields

Modifier and Type	Field and Description
String	clientId The clientId that made this request.
Object	hash Payload as extracted from Authentication header.
String	scheme Authentication scheme the client used.
String[]	scopes List of scopes the client is authorized to access.
String	status The kind of response, auth-failed or auth-success.

Constructor Summary

Constructors

Constructor and Description
AuthenticationSuccessfulResponse()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

clientId

public String clientId

The clientId that made this request. This may be the id supplied in the Authorization header, or in the case of a named temporary credential may be embedded in the payload. In any case, this clientId can be used for logging, auditing, and identifying the credential but must not be used for access control. That’s what scopes are for.

See http://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/anyOf[0]/properties/clientId

hash

public Object hash

Payload as extracted from Authentication header. This property is only present if a hash is available. You are not required to validate this hash, but if you do, please check scheme to ensure that it’s on a scheme you support.

See http://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/anyOf[0]/properties/hash

scheme

public String scheme

Authentication scheme the client used. Generally, you don’t need to read this property unless hash is provided and you want to validate the payload hash. Additional values may be added in the future.

Possible values: * “hawk”

See http://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/anyOf[0]/properties/scheme

scopes

public String[] scopes

List of scopes the client is authorized to access. Scopes must be composed of printable ASCII characters and spaces.

See http://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/anyOf[0]/properties/scopes

status

public String status

The kind of response, auth-failed or auth-success.

Possible values: * “auth-success”

See http://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/anyOf[0]/properties/status

Constructor Detail

AuthenticationSuccessfulResponse

public AuthenticationSuccessfulResponse()