| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Query Arguments for Tokens
The following HTTP request URI query arguments control the creation of a token:
No query args | Causes the default behavior as if |
|---|---|
setcookie=true | Causes the HTTP response to contain a Cookie header that causes a web browser to replace the current authentication token with the newly generated one. |
setcookie=false | Causes the HTTP response to contain the header Gateway-Token instead of the standard Cookie header. Use this to have the browser continue using its current authentication token. |
NoteThe Gateway-Token header is the same for both SCSP and S3 tokens. |
Request Headers for Tokens
The following HTTP request headers control the creation of a token:
X-Owner-Meta | {username} | Required | Used by the By default, the owner of a token is the user that creates it. |
|---|---|---|---|
X-User-Token-Expires-Meta | {time-specification} | Optional | Sets the expiration time for the authentication token. See below for ways to express time. If this header is not given, the default expiration time is set based on Gateway's |
X-User-Secret-Key-Meta | {string} | Optional | Sets an S3 secret key that is used for signing S3 requests. The token is used to sign S3 storage requests when this header is present. The token cannot be used to authenticate SCSP storage or Management API operations. Values of this string must follow Swarm metadata value rules for encoding, and 7-bit ASCII values are recommended. |
X-Custom-Meta-{string} | {string} | Optional | Additional custom metadata that is saved with the token. This is for application-specific purposes and it is not interpreted by the Gateway during token creation or use. |
X-Custom-Meta-Source | {string} | Optional | This metadata header is displayed as the Description of the token in the Content UI. |
You have numerous options for how to specify the time for the token's expiration:
POSIX time | {n} | "1444419929" | Integer value that is the number of seconds elapsed since 00:00:00. Coordinated Universal Time (UTC), 1 January 1970, not counting leap seconds. |
Days offset | +{n} | "+365" | Integer number of days (86,400 sec/day) from now. |
Year only | {YYYY} | "2015" | Four-digit year; the expiration is on January 1st at 00:00Z of that year. |
Specific day | {YYYY}{MM}{DD} | "2015-10-09" | Year, month, and day; the expiration is at 00:00Z on that day. |
ISO timespec | {YYYY}{MM}{DD} | "2015-10-09T11:18:00.000Z" | ISO time specification; all digits and fixed characters must be supplied; only UTC ("Z") time zone is allowed. |
Token Examples
Creating a domain token
| Code Block | ||
|---|---|---|
| ||
POST http://{domain}/.TOKEN/
Auth: john:password
HTTP/1.1 201 Created
Gateway-Request-Id: 41B8FD0D739DF86C
Set-Cookie: token=d9f8378f71e79b77831f65d9e6891af6; path=/
Content-Length: 0 |
...