> ## 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. # Definir ou rotacionar uma credencial de fila > Define ou rotaciona a credencial de saída de uma assinatura de fila (`sqs`, `rabbitmq`, `eventbridge`) com sondagem na escrita (probe-on-write): a credencial candidata é mantida em memória, sondada (conexão + autenticação) imediatamente e persistida criptografada apenas em caso de sucesso da sondagem — uma sondagem que falha não armazena nada. Uma sondagem bem-sucedida transiciona a assinatura de `pending_verification` para `active`. A credencial é somente escrita (write-only): ela é fornecida apenas aqui e nunca é retornada, nem mesmo mascarada, em nenhum caminho de leitura. Uma falha de sondagem classificada ainda é um `200`. Esta rota é naturalmente idempotente e não exige o cabeçalho `X-Idempotency`. ## OpenAPI ````yaml pt/openapi/v3-current/streaming-hub.yaml put /v1/subscriptions/{id}/credential 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":""}` (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}/credential: put: tags: - Subscriptions summary: Definir ou rotacionar uma credencial de fila description: >- Define ou rotaciona a credencial de saída de uma assinatura de fila (`sqs`, `rabbitmq`, `eventbridge`) com sondagem na escrita (probe-on-write): a credencial candidata é mantida em memória, sondada (conexão + autenticação) imediatamente e persistida criptografada apenas em caso de sucesso da sondagem — uma sondagem que falha não armazena nada. Uma sondagem bem-sucedida transiciona a assinatura de `pending_verification` para `active`. A credencial é somente escrita (write-only): ela é fornecida apenas aqui e nunca é retornada, nem mesmo mascarada, em nenhum caminho de leitura. Uma falha de sondagem classificada ainda é um `200`. Esta rota é naturalmente idempotente e não exige o cabeçalho `X-Idempotency`. operationId: putSubscriptionCredential parameters: - $ref: '#/components/parameters/SubscriptionId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CredentialRequest' responses: '200': description: >- A sondagem rodou; o corpo carrega o resultado classificado. Em caso de sucesso a credencial foi persistida e a assinatura está `active`; em uma falha classificada nada foi persistido. content: application/json: schema: $ref: '#/components/schemas/ProbeResult' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': description: >- A requisição é corrigível pelo chamador. `error` é `validation_error` (um `sinkConfig` ausente ou vazio) ou `endpoint_blocked` (o host do broker resolveu para um endereço bloqueado, privado ou de metadados). content: application/json: schema: $ref: '#/components/schemas/Error' '500': $ref: '#/components/responses/InternalError' 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: CredentialRequest: type: object additionalProperties: false description: >- The queue-credential body. `sinkConfig` is a kind-specific, write-only object that is probed and, on success, stored encrypted. It is never returned on any read path. properties: sinkConfig: type: object additionalProperties: true description: >- The candidate outbound credential for the queue kind. For `rabbitmq`, an object such as `{"uri":"amqps://user:pass@broker.example.com:5671/vhost"}`; for AWS kinds, the region and access material. Write-only — never logged or returned. examples: - uri: amqps://user:pass@broker.example.com:5671/vhost required: - sinkConfig ProbeResult: type: object additionalProperties: false description: >- The classified result of a synchronous probe (ping, verify, or credential write). A classified failure is still returned with HTTP `200` — the probe ran and produced a verdict. It carries no secret, endpoint, or detail string. properties: outcome: $ref: '#/components/schemas/Outcome' statusCode: type: integer description: >- The target's protocol status. For webhook probes, the HTTP status (`0` when none applies, e.g. a transport error or a blocked endpoint). For queue-kind credential probes, always `0`. examples: - 200 errorClass: type: string description: A frozen taxonomy token classifying a failure. Empty on success. examples: - '' required: - outcome - statusCode - errorClass 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 Outcome: type: string description: The classified verdict of a synchronous probe. enum: - ok - failed responses: BadRequest: description: O corpo da requisição está malformado — `error` é `bad_request`. content: application/json: schema: $ref: '#/components/schemas/Error' 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' InternalError: description: >- Uma falha de infraestrutura. `error` é `internal_error` (sanitizado; o detalhe é logado, nunca retornado). 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. ````