> ## Documentation Index
> Fetch the complete documentation index at: https://docs.refy.to/llms.txt
> Use this file to discover all available pages before exploring further.

# Entrar com identidade federada



## OpenAPI

````yaml /openapi/refy-rest.yaml post /v1/auth/federated
openapi: 3.1.0
info:
  title: API REST do Refy
  version: 0.1.0
  description: >
    API HTTP orientada a areas de trabalho para autenticacao, analises,
    pontuacao, backlog, monitoramento, cobranca, conectores, eventos e
    notificacoes do Refy.
servers:
  - url: http://localhost:4000
    description: Desenvolvimento local
  - url: https://api.refy.local
    description: URL base ilustrativa de producao
security: []
tags:
  - name: system
    description: Endpoints de sistema, saude da API e utilitarios de ambiente.
  - name: auth
    description: Fluxos de autenticacao, sessao, perfil e onboarding inicial.
  - name: workspaces
    description: Gestao de areas de trabalho, membros, tenancy e chaves de API.
  - name: projects
    description: Gestao de projetos e associacao de membros por projeto.
  - name: analyses
    description: >-
      Analises, dados agregados da tela de analise, evidencias, pontuacao e
      sintese.
  - name: action-points
    description: Backlog de itens de acao, comentarios e checklist operacional.
  - name: monitoring
    description: Monitoramento continuo, runs agendados e alertas.
  - name: billing
    description: Creditos, assinatura, pagamentos, faturas e checkout.
  - name: connectors
    description: Catalogo de conectores e instalacoes por area de trabalho.
  - name: events
    description: Eventos operacionais da area de trabalho.
  - name: notifications
    description: Notificacoes do produto e acoes de leitura e arquivamento.
paths:
  /v1/auth/federated:
    post:
      tags:
        - auth
      summary: Entrar com identidade federada
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - provider
                - providerUserId
                - email
              properties:
                provider:
                  type: string
                providerUserId:
                  type: string
                email:
                  type: string
                  format: email
                displayName:
                  type: string
                username:
                  type: string
                avatarUrl:
                  type: string
                  format: uri
      responses:
        '200':
          description: Sessao concedida
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthGrant'
components:
  schemas:
    AuthGrant:
      type: object
      properties:
        token:
          type: string
        user:
          $ref: '#/components/schemas/User'
        session:
          $ref: '#/components/schemas/Session'
        identities:
          type: array
          items:
            $ref: '#/components/schemas/Identity'
      example:
        token: refy_token_example
        user:
          id: usr_123
          displayName: Vinicius Coimbra
          email: viniciuscoimbra@gmail.com
          username: viniciuscoimbra
          avatarUrl: https://example.com/avatar.png
        session:
          id: ses_123
          userId: usr_123
          token: refy_token_example
          createdAt: '2026-04-28T12:00:00.000Z'
        identities:
          - id: idn_123
            provider: google
            providerUserId: google_123
            email: viniciuscoimbra@gmail.com
            createdAt: '2026-04-28T12:00:00.000Z'
    User:
      type: object
      properties:
        id:
          type: string
        displayName:
          type: string
        email:
          type: string
          format: email
        username:
          type: string
        avatarUrl:
          type: string
          format: uri
    Session:
      type: object
      properties:
        id:
          type: string
        userId:
          type: string
        token:
          type: string
        createdAt:
          type: string
          format: date-time
        revokedAt:
          type: string
          format: date-time
    Identity:
      type: object
      properties:
        id:
          type: string
        provider:
          type: string
        providerUserId:
          type: string
        email:
          type: string
          format: email
        createdAt:
          type: string
          format: date-time

````