public class AuthenticationSuccessfulResponse extends Object
Response from a request to authenticate a hawk request.
See https://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/oneOf[0]
Modifier and Type | Field and Description |
---|---|
String |
clientId
The
clientId that made this request. |
Date |
expires
The expiration time for the credentials used to make 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 and Description |
---|
AuthenticationSuccessfulResponse() |
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.
Syntax: ^[A-Za-z0-9!@/:.+|_-]+$
public Date expires
The expiration time for the credentials used to make this request. This should be treated as the latest time at which the authorization is valid. For most cases, where the access being authorized occurs immediately, this field can be ignored, as the value will always be in the future if the status is auth-success
.
See https://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/oneOf[0]/properties/expires
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 https://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/oneOf[0]/properties/hash
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 https://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/oneOf[0]/properties/scheme
public String[] scopes
List of scopes the client is authorized to access. Scopes must be composed of printable ASCII characters and spaces.
See https://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/oneOf[0]/properties/scopes
public String status
The kind of response, auth-failed
or auth-success
.
Possible values: * “auth-success”
See https://schemas.taskcluster.net/auth/v1/authenticate-hawk-response.json#/oneOf[0]/properties/status
Copyright © 2014–2018 Mozilla. All rights reserved.