Set the tenant worker portal base URL

Stores or updates the authenticated tenant’s worker portal base URL. The URL must use HTTPS, contain no credentials or fragment, and be at most 255 characters. The response returns the stored configuration. Registering a portal is optional. When the tenant has one, the gateway injects it as the type 0 contact of every bid proposal that carries no portalBaseUrl of its own and names no originador with a registered portal. When no portal resolves for a bid, the bid travels with the client’s own contacts alone and must carry at least one contact of type 1 through 4.

PUT /v1/credentials/dataprev/portal-base-url

Set the tenant worker portal base URL

cURL

curl --request PUT \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/credentials/dataprev/portal-base-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "portalBaseUrl": "https://portal.example.com/formalizacao"
}
'

200

{
  "portalBaseUrl": "https://portal.example.com/formalizacao"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency · string

Optional idempotency key. Sent again with the SAME body, the stored response is replayed and the URL is stored once; sent again with a DIFFERENT body, the request is refused with 422 because the key was already spent on another intent. Absent, the request executes once, exactly as it always has.

Ejemplo:

"idem-1"

Cuerpo

application/json

portalBaseUrl · string<uri> · requerido

Base URL of the tenant's worker portal. Must use HTTPS, contain no credentials or fragment, and be at most 255 characters. When a tenant registers one, the gateway injects it as the type 0 contact of each bid proposal that carries no portalBaseUrl of its own and names no originador with a registered portal. Registering a portal is optional.

Maximum string length: 255

Pattern: ^https://[^/?#@]+([/?][^#]*)?$

Ejemplo:

"https://portal.example.com/formalizacao"

Respuesta

200

application/json

OK

portalBaseUrl · string<uri> · requerido

Base URL of the tenant's worker portal. Must use HTTPS, contain no credentials or fragment, and be at most 255 characters. When a tenant registers one, the gateway injects it as the type 0 contact of each bid proposal that carries no portalBaseUrl of its own and names no originador with a registered portal. Registering a portal is optional.

Maximum string length: 255

Pattern: ^https://[^/?#@]+([/?][^#]*)?$

Ejemplo:

"https://portal.example.com/formalizacao"