Parâmetros de Autenticação

Os parâmetros de autenticação são informações fornecidas pela Layers que identificam a sessão do usuário, a comunidade através da qual ele está acessando e o próprio usuário. Esses parâmetros são necessários para validar a sessão e garantir que o usuário está autenticado.

Parâmetros Disponíveis

session

Identificador único da sessão do usuário na Layers. Cada sessão possui um identificador exclusivo que é válido durante o período em que o usuário está autenticado.

communityId

Identificador da comunidade através da qual o usuário está acessando o portal. Representa a instituição ou organização na Layers à qual o usuário pertence no contexto atual.

userId

Identificador único do usuário na Layers. Este é o ID que identifica o usuário de forma única em todo o ecossistema Layers.

Header community-id

Ao chamar o endpoint de validação de sessão, o communityId precisa ser enviado duas vezes: no parâmetro de query community e no header community-id. Sem o header, a API responde 400 Bad Request com a mensagem Você deve especificar o header 'community-id'.

Como Acessar os Parâmetros

Os parâmetros de autenticação podem ser acessados de duas formas diferentes, dependendo do método de autenticação utilizado.

Via URL

Para aplicações que utilizam Server-Side Rendering (SSR) ou portais externos, os parâmetros são passados na query string da URL com os seguintes nomes:

• layers_session: corresponde ao parâmetro session
• layers_community_id: corresponde ao parâmetro communityId
• layers_user_id: corresponde ao parâmetro userId

Para mais detalhes sobre autenticação via URL, consulte o guia Autenticação via URL.

Via SDK JavaScript (LayersPortal.js)

Para aplicações Single Page Applications (SPA) em portais embutidos na Layers, os parâmetros são acessados através do SDK LayersPortal.js com os seguintes nomes de propriedades:

• LayersPortal.session: corresponde ao parâmetro session
• LayersPortal.communityId: corresponde ao parâmetro communityId
• LayersPortal.userId: corresponde ao parâmetro userId

Para mais detalhes sobre autenticação via SDK, consulte o guia Autenticação via SDK JavaScript e a referência completa do LayersPortal.js.