Conta

Três chamadas sobre a própria credencial, e não sobre um quadro — então nenhuma delas recebe o header X-Tylon-Workspace, e nenhuma recusa por falta dele. É daqui que vêm os ids que aquele header aceita, então uma versão que exigisse um seria uma porta cuja chave está atrás da porta.

A credencial

endpoint

A primeira chamada que qualquer um faz, e a que responde “isto está ligado direito?” sem tocar em dado nenhum.

curl https://api.tylon.app/v1/me \
  -H "Authorization: Bearer $TYLON_SECRET"

{
  "clientId": "tyl_id_1yIrdcxW_gkz8XBY",
  "name": "the deploy script",
  "scopes": ["read"],
  "boards": [
    {
      "workspaceId": "84415731592203229",
      "organizationId": "84415731491539931",
      "role": "viewer"
    }
  ],
  "answering": null
}

string

A metade pública da credencial. Segura num log — não é ela que autentica.

string

Como ela foi chamada quando foi emitida, e com o que ela assina as escritas dela. Um card que ela cria diz createdBy: the deploy script.

string[]

read, ou read e write. Escrever só com read é 403.

object[]

Todo quadro que ela alcança, com o papel que ela tem em cada um. Esta é a listagem: workspaceId é exatamente o que o header X-Tylon-Workspace aceita, e nada mais.

string | null

Qual quadro atendeu a chamada. Sempre null aqui, porque esta rota responde com a lista em vez de responder de dentro dela.

Os quadros que ela alcança

endpoint

A mesma lista de boards acima, com as palavras nela. /v1/me responde em ids porque ids são o que o header aceita; este é o endpoint para escrever “Checkout” numa tela em vez de 83729280714017040.

[
  {
    "id": "83729280714017040",
    "name": "Local Sandbox",
    "slug": "local-sandbox",
    "organizationId": "81904798345068545",
    "organizationSlug": "jakson-lucas",
    "organizationName": "Jakson Lucas",
    "role": "viewer"
  }
]

role é a participação da própria credencial naquele quadro — não o papel de quem a emitiu, e não algo que acompanhe essa pessoa depois.

Só os quadros que foram dados a esta credencial. Nomear no header o id de qualquer outro workspace é 400, e ele também não vai aparecer aqui.

As organizações em que eles ficam

endpoint

[
  {
    "id": "84415731491539931",
    "name": "Acme",
    "slug": "acme",
    "workspaceIds": ["84415731592203229"]
  }
]

string[]

Os quadros desta organização que a credencial alcança — não todos os quadros que a organização tem.

Não existe role aqui, e isso é deliberado em vez de esquecido. Uma pessoa é membro de uma organização; uma credencial é membro de quadros, e alcança uma organização apenas no sentido de que alguns quadros dela moram ali. Um papel nesta resposta seria um número inventado para preencher um campo.

O que fazer com isso

Escolher um quadro

Como os ids acima entram no header, o que acontece quando você o omite, e por que um nome é recusado onde vai um id.

Escrever

O que o escopo write e o papel em boards deixam esta credencial fazer.

Visão geral

Endpoints

A credencial

Os quadros que ela alcança

As organizações em que eles ficam

O que fazer com isso

Escolher um quadro

Escrever

​A credencial

​Os quadros que ela alcança

​As organizações em que eles ficam

​O que fazer com isso

Escolher um quadro

Escrever

A credencial

Os quadros que ela alcança

As organizações em que eles ficam

O que fazer com isso