Pular para o conteúdo
Credencial

Quem sou eu (credencial e escopos)

v1.0.0
GEThttps://api.staging.growthaisystem.com/api/v1/me
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)

Quem é a credencial desta chamada — a chave gos_ (id, nome, validade) ou a pessoa do login OAuth —, de qual workspace, e quais escopos ela carrega. Use antes de integrar, para saber o que a chave alcança sem descobrir rota a rota pelo 403. Nunca devolve o token, nem parte dele.

Autorização: qualquer credencial válida (chave gos_ ou login de pessoa); nenhum escopo exigido — a rota só descreve a própria credencial.

Respostas

5 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

A credencial desta chamada: o tipo, o workspace, os escopos e a chave (ou a pessoa do login OAuth).

V1Me

  • authMethodstring

    api_key = chave gos_ do workspace (criada em Acessos → API); oauth = login de uma pessoa por um app OAuth.

    • um de"api_key""oauth"

  • O workspace a que a credencial dá acesso — todas as rotas respondem dele.

    • idstring
    • namestring
  • scopesstring[]

    Os escopos desta credencial, em ordem alfabética: os marcados na chave ou os consentidos no login. É o que decide o 403 forbidden_scope de cada rota (a descrição de cada rota diz qual escopo ela exige). Num login de pessoa, algumas rotas também conferem a área do papel dela no app (403 forbidden_area).

  • A chave gos_ (null num login de pessoa). Nunca traz o token, nem parte dele.

    • idstring
    • namestring

      O nome dado à chave em Acessos → API.

    • createdAtstring | null
    • expiresAtstring | null

      Quando a chave expira; null = não expira.

    • usingPreviousTokenboolean

      true = esta chamada autenticou pelo token ANTIGO de uma chave em rotação — troque pelo token novo antes de o antigo expirar.

  • A pessoa do login OAuth (null para chave).

    • idstring
    • namestring
    • emailstring
    • profilestring

      O papel no workspace, como em GET /users: o preset ou o id do papel personalizado.

    • rolestring

      O preset, ou o NOME do papel personalizado (como em GET /users).