Token Object

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

Fields

Key	Type	Value
`all_experiments`	`boolean`	A boolean indicating whether or not the token grants access to all the client's experiments.
`client`	`string`	The `id` of the Client who created this token.
`experiment`	`string`	The `id` of the Experiment accessible by this token.
`permissions`	`string`	The type of permission this token can grant. Tokens may grant either read or write access.
`token`	`string`	The token string that can be used to connect to the SigOpt API and gain access to the specified experiment.
`user`	`string`	The `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

Method	URI	Description
`POST`	/experiments/EXPERIMENT_ID/tokens	Token Create

Example

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