> ## 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.

# Configure a URL base do portal do trabalhador do tenant

> Armazena ou atualiza a URL base do portal do trabalhador do tenant autenticado. A URL deve usar HTTPS, não conter credenciais nem fragmentos e ter no máximo 255 caracteres. A resposta retorna a configuração armazenada. O gateway injeta essa URL como contato obrigatório do tipo 0 em cada proposta de oferta.



## OpenAPI

````yaml pt/openapi/v3-current/consignado.yaml put /v1/credentials/dataprev/portal-base-url
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    Superfície OpenAPI 3.1 do Lerian Consignado — Dataprev, o rail da jornada de
    crédito que armazena as credenciais de acesso e a configuração do Dataprev
    de cada tenant. Abrange o estado por tenant, a rotação do certificado de
    cliente e do OAuth2, a configuração do código COMPE do solicitante e a URL
    base do portal do trabalhador. O material secreto é gravado no cofre de
    segredos do tenant e nunca é retornado por nenhuma operação. O código
    público do solicitante e a configuração do portal são armazenados como
    metadados não secretos.
  license:
    name: Lerian Studio General License
  title: Lerian Consignado API
  version: v1.0.0
servers:
  - url: https://consignado.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Custódia de credenciais do Dataprev e configuração pública do rail por
      tenant (upload, status, rotação, revogação, código do solicitante e URL
      base do portal do trabalhador)
    name: Credentials
paths:
  /v1/credentials/dataprev/portal-base-url:
    put:
      tags:
        - Credentials
      summary: Configure a URL base do portal do trabalhador do tenant
      description: >-
        Armazena ou atualiza a URL base do portal do trabalhador do tenant
        autenticado. A URL deve usar HTTPS, não conter credenciais nem
        fragmentos e ter no máximo 255 caracteres. A resposta retorna a
        configuração armazenada. O gateway injeta essa URL como contato
        obrigatório do tipo 0 em cada proposta de oferta.
      operationId: putDataprevPortalBaseURL
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutPortalBaseURLRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutPortalBaseURLRequest'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    PutPortalBaseURLRequest:
      additionalProperties: false
      properties:
        portalBaseUrl:
          description: >-
            Base URL of the tenant's worker portal. Must use HTTPS, contain no
            credentials or fragment, and be at most 255 characters. The gateway
            injects this URL as the required type 0 contact in each bid
            proposal.
          examples:
            - https://portal.example.com/formalizacao
          format: uri
          maxLength: 255
          pattern: ^https://[^#]+$
          type: string
      required:
        - portalBaseUrl
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````