Tokens

Gofer API Token

Method	Endpoint
GET	`/api/tokens`
POST	`/api/tokens`
POST	`/api/tokens/bootstrap`
POST	`/api/tokens/web-login`
POST	`/api/tokens/web-login/exchange`
GET	`/api/tokens/whoami`
GET	`/api/tokens/{id}`
PATCH	`/api/tokens/{id}`
DELETE	`/api/tokens/{id}`

List all Gofer API tokens

GET/api/tokens

This endpoint is restricted to admin tokens only.

Responses

Status	Body	Description
`200`	ListTokensResponse	successful operation
`4XX`	Error	Error
`5XX`	Error	Error

Create a new token

POST/api/tokens

This endpoint is restricted to admin tokens only.

Request body (required): CreateTokenRequest

Responses

Status	Body	Description
`201`	CreateTokenResponse	successful creation
`4XX`	Error	Error
`5XX`	Error	Error

Create root admin token

POST/api/tokens/bootstrap

This endpoint can only be hit once and will create the root admin token, from which all other tokens can be created.

Responses

Status	Body	Description
`201`	CreateTokenResponse	successful creation
`4XX`	Error	Error
`5XX`	Error	Error

POST/api/tokens/web-login

Returns a short lived, single use code that a browser can trade for the calling token, so the CLI can open the web UI already signed in without ever putting the token itself in a URL.

Responses

Status	Body	Description
`201`	CreateWebLoginResponse	successful creation
`4XX`	Error	Error
`5XX`	Error	Error

POST/api/tokens/web-login/exchange

Trades a code from create_web_login for the token that created it. Each code works once. The code is sent in the body rather than the path so it stays out of request logs.

Request body (required): ExchangeWebLoginRequest

Responses

Status	Body	Description
`200`	ExchangeWebLoginResponse	successful operation
`4XX`	Error	Error
`5XX`	Error	Error

Get api token who made the request

GET/api/tokens/whoami

Responses

Status	Body	Description
`200`	WhoAmIResponse	successful operation
`4XX`	Error	Error
`5XX`	Error	Error

Get api token by id

GET/api/tokens/{id}

Path parameters

Name	Type	Required	Description
`id`	string	yes	The unique identifier for the target namespace.

Responses

Status	Body	Description
`200`	GetTokenByIDResponse	successful operation
`4XX`	Error	Error
`5XX`	Error	Error

Update a token's state

PATCH/api/tokens/{id}

Path parameters

Name	Type	Required	Description
`id`	string	yes	The unique identifier for the target namespace.

Request body (required): UpdateTokenRequest

Responses

Status	Body	Description
`204`	none	resource updated
`4XX`	Error	Error
`5XX`	Error	Error

Delete api token by id

DELETE/api/tokens/{id}

This endpoint is restricted to admin tokens only.

Path parameters

Name	Type	Required	Description
`id`	string	yes	The unique identifier for the target namespace.

Responses

Status	Body	Description
`204`	none	successful deletion
`4XX`	Error	Error
`5XX`	Error	Error