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

# Obter os artefatos de configuração do delegated-grant AWS

> Gera os artefatos de onboarding do delegated-grant AWS para uma assinatura de sink AWS (`sqs`, `eventbridge`): a trust policy IAM entre contas (cross-account) e um link de console CloudFormation quick-create que o cliente aplica na sua própria conta AWS para criar a role de entrega que o Streaming Hub assume. Na primeira busca, um valor de correlação `sts:ExternalId` não secreto é gerado e embutido em ambos os artefatos; uma nova busca o reutiliza (artefatos estáveis). Nenhuma credencial AWS é jamais armazenada ou retornada — a role é assumida por entrega, protegida pela condição `ExternalId`. Um sink não-AWS retorna `422 validation_error`.



## OpenAPI

````yaml pt/openapi/v3-current/streaming-hub.yaml get /v1/subscriptions/{id}/setup-artifacts
openapi: 3.1.0
info:
  title: Lerian Streaming Hub API
  version: v1.0.0
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  license:
    name: Lerian Studio General License
  description: >-
    A API do plano de controle do Streaming Hub. O Streaming Hub é a borda
    gerenciada de entrega de eventos da Lerian: ele consome CloudEvents do
    backbone de streaming interno da plataforma e faz o fan-out para os destinos
    externos do próprio tenant — webhooks, Amazon SQS, RabbitMQ, Amazon
    EventBridge ou uma caixa de entrada pull. Esta API permite que um tenant
    navegue pelo catálogo de eventos alimentado por manifesto, crie e gerencie
    assinaturas de entrega, verifique e rotacione suas credenciais, consulte a
    saúde da entrega e puxe (pull) os eventos aos quais tem direito.


    Os erros usam um envelope plano `{"error":"<token>"}` (um token de baixa
    cardinalidade, legível por máquina — nunca problem+json do RFC 9457). As
    operações de mutação exigem um cabeçalho `X-Idempotency` para semântica de
    no-máximo-uma-vez (at-most-once); uma requisição repetida (replay) retorna a
    resposta original byte a byte com `X-Idempotency-Replayed: true`. O catálogo
    e a superfície de eventos por pull têm escopo de tenant através do JWT
    bearer; os endpoints operacionais de sondagem (`/healthz`, `/readyz`,
    `/version`, `/runtime`, `/metrics`) não exigem autenticação. O Streaming Hub
    é closed source sob a Lerian Studio General License.
servers:
  - url: https://streaming-hub.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - name: Catalog
    description: >-
      Navegue pelo catálogo de tipos de evento disponíveis para assinatura,
      alimentado por manifesto.
  - name: Subscriptions
    description: >-
      Crie, leia, atualize e exclua assinaturas de entrega e conduza o ciclo de
      vida de verificação do destino (ping, verify, credential, delegated grant,
      rotação de segredo, saúde).
  - name: Event Delivery
    description: >-
      Puxe (pull) os eventos aos quais uma assinatura de sink pull tem direito
      (leitura com cursor-como-confirmação).
  - name: Admin
    description: >-
      Análise forense de operador entre tenants (cross-tenant). Exige um escopo
      de autorização de operador.
  - name: Operational
    description: >-
      Sondagens não autenticadas de liveness, readiness, build, runtime e
      métricas.
paths:
  /v1/subscriptions/{id}/setup-artifacts:
    get:
      tags:
        - Subscriptions
      summary: Obter os artefatos de configuração do delegated-grant AWS
      description: >-
        Gera os artefatos de onboarding do delegated-grant AWS para uma
        assinatura de sink AWS (`sqs`, `eventbridge`): a trust policy IAM entre
        contas (cross-account) e um link de console CloudFormation quick-create
        que o cliente aplica na sua própria conta AWS para criar a role de
        entrega que o Streaming Hub assume. Na primeira busca, um valor de
        correlação `sts:ExternalId` não secreto é gerado e embutido em ambos os
        artefatos; uma nova busca o reutiliza (artefatos estáveis). Nenhuma
        credencial AWS é jamais armazenada ou retornada — a role é assumida por
        entrega, protegida pela condição `ExternalId`. Um sink não-AWS retorna
        `422 validation_error`.
      operationId: getSubscriptionSetupArtifacts
      parameters:
        - $ref: '#/components/parameters/SubscriptionId'
      responses:
        '200':
          description: Os artefatos do delegated-grant.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetupArtifactsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '500':
          description: >-
            Uma falha de infraestrutura, ou o deployment não configurou o ARN do
            principal do hub / a URL do template de configuração necessários
            para renderizar os artefatos. `error` é `internal_error`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  parameters:
    SubscriptionId:
      name: id
      in: path
      required: true
      description: The unique identifier of the subscription (UUIDv7).
      schema:
        type: string
        format: uuid
  schemas:
    SetupArtifactsResponse:
      type: object
      additionalProperties: false
      properties:
        externalId:
          type: string
          description: >-
            The non-secret `sts:ExternalId` correlation value pinned into the
            trust policy (minted once, stable across re-fetches).
          examples:
            - 0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b
        region:
          type: string
          description: The AWS region the artifacts target.
          examples:
            - us-east-1
        trustPolicy:
          type: string
          description: >-
            The cross-account IAM trust policy JSON (as a string) the customer
            applies in their AWS account.
          examples:
            - '{ "Version": "2012-10-17", "Statement": [] }'
        quickCreateUrl:
          type: string
          format: uri
          description: >-
            A CloudFormation quick-create console link that provisions the
            delivery role.
          examples:
            - https://us-east-1.console.aws.amazon.com/cloudformation/home?...
      required:
        - externalId
        - region
        - trustPolicy
        - quickCreateUrl
    Error:
      type: object
      additionalProperties: false
      description: >-
        The flat error envelope used across the `/v1` and `/admin` surfaces. It
        carries a single low-cardinality, machine-readable token and never leaks
        secret material or internal detail. (A `403` from the authorization
        decision point is the one exception — its body is plain text.)
      properties:
        error:
          type: string
          description: The machine-readable error token.
          examples:
            - not_found
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        A autenticação falhou, ou não há contexto de tenant confiável. `error` é
        `unauthorized` (corpo uniforme — nenhuma razão é revelada).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        O ponto de decisão de autorização (authorization decision point) negou a
        requisição. O corpo é texto puro (não o envelope de erro JSON).
      content:
        text/plain:
          schema:
            type: string
    NotFound:
      description: >-
        O recurso está ausente, soft-deleted ou pertence a outro tenant — um
        `error` uniforme de `not_found` (sem oráculo de existência).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: >-
        Uma falha de formato corrigível pelo chamador — `error` é
        `validation_error`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Um JWT bearer emitido pelo plugin-auth (lib-auth). A identidade do
        tenant é resolvida a partir das claims validadas do token; a superfície
        `/v1` nunca lê um tenant do corpo, do path ou da query. Chamadores de
        máquina obtêm um token via o fluxo client-credentials do plugin-auth. A
        superfície `/admin` autoriza contra um escopo de operador e não carrega
        contexto de tenant.

````