Token Object

An object that allows read or write access to a given experiment.

Fields

KeyTypeValue
all_experimentsbooleanA boolean indicating whether or not the token grants access to all the client's experiments.
clientstringThe id of the Client who created this token.
experimentstringThe id of the Experiment accessible by this token.
permissionsstringThe type of permission this token can grant. Tokens may grant either read or write access.
tokenstringThe token string that can be used to connect to the SigOpt API and gain access to the specified experiment.
userstringThe id of the user that is granted the token. For guest tokens, the guest is not required to have a SigOpt user id.

Supported Endpoints

MethodURIDescription
POST/experiments/EXPERIMENT_ID/tokensToken Create

Example

{
  "all_experiments": false,
  "client": "1",
  "development": false,
  "experiment": "1",
  "expires": 2592000,
  "object": "token",
  "organization": "1",
  "permissions": "read",
  "token": "GTYUZQBSKNRAEUORJORWYPWCUTFJMDTLVJJYUNDLGQKGHDML",
  "token_type": "guest",
  "user": null
}