Dependendo do seu método de Handshake, sua API responderá com um objeto JSON puro ou um JWT assinado. O formato dos dados é o mesmo para ambos:

type User = {
  expiresAt?: number;
  groups?: string[];
  content?: Record<string, any>;
  apiPlaygroundInputs?: {
    header?: Record<string, any>;
    query?: Record<string, any>;
    cookie?: Record<string, any>;
    server?: Record<string, string>;
  };
};
​
expiresAt
number

O momento em que esta informação deve expirar, em segundos desde a época. Se o usuário carregar a página e o tempo atual for posterior a este valor, os dados armazenados serão excluídos.

Para Handshakes JWT: Isso não é o mesmo que a reivindicação expexp do JWT. A reivindicação expexp determina quando um JWT não deve mais ser considerado válido e deve ser definida o mais baixo possível. Neste caso, provavelmente pode ser definida para 10 segundos ou menos. O campo expiresAtexpiresAt determina quando os dados recuperados devem ser considerados obsoletos e pode variar de um dia a várias semanas.
​
groups
string[]

Uma lista de grupos aos quais o usuário pertence. Isso determinará quais páginas devem ser mostradas para este usuário. Se qualquer um desses grupos estiver listado no campo groupsgroups dos metadados de uma página, essa página será exibida.

​
content
object

Um conjunto de valores que podem ser acessados dentro do conteúdo MDX usando a variável useruser. Por exemplo, se você forneceu { firstName: 'Ronan' }{“name”: “John Doe”} como seu campo de conteúdo, você pode usar o seguinte em seu MDX: Good morning, {user.firstName}!

​
apiPlaygroundInputs
object

Valores específicos do usuário que serão preenchidos automaticamente no playground da API, se fornecidos. Por exemplo, se cada um dos meus clientes faz solicitações em um subdomínio específico, posso enviar { server: { subdomain: 'foo' } }{“subdomain”: “customer1”}apiPlaygroundInputsplayground campo, e esse valor será preenchido automaticamente em qualquer página da API com este subdomainvalor.

Os camposheaderapiKeyquerybearerTokencookiebasicAuth só serão preenchidos automaticamente se fizerem parte do seu esquema de segurança. Criar um parâmetro de cabeçalho padrão chamado AuthorizationapiKey não é suficiente para habilitar esse recurso. Para saber se um campo será preenchido automaticamente, navegue até sua documentação existente e verifique se o campo está na seção AuthorizationAuthServerSecurity.