HLiberty
  1. Raiz
HLiberty
  • Bem vindo
  • Authentication
    • Adiciona para o domínio uma faixa de IP como sendo segura.
    • Remove a faixa de IP indicada do domínio.
    • Retona a lista das faixa de IP seguros do domínio.
    • Retona a lista todas as faixas de IP seguros.
    • Authenticates access and generates the token
    • Log the user out (invalidate the token).
    • Your credentials
    • Refresh authentication
    • Changes the working corporation and resets the token
  • Corporation
    • Show list of corporations
    • Create a new corporation
    • Show corporation data
    • Update corporation data
    • Delete a corporation
    • Corporation User List
    • Add user to a corporation
    • Remove user from a corporation
    • Make corporation enabled for use
    • Block corporation for use
    • Sets the corporation under maintenance
    • Defines that the corporation needs updating
    • Show corporation data by auth name
    • Add service to a corporation
    • Remove Service from a corporation
    • Tree of services, features and actions available to the corporation.
    • Corporation check
  • Service & Feature
    • AppMenu
      • Displays the menu tree with action associations.
      • Assign permissions to a workgroup in a specific application menu
      • Creates or updates an application's menu
    • Upload service features
    • Show feature list
    • Delete service
    • Update service data
    • Show service data
    • Create a service
    • Show service list
    • Remove feature action
    • Add action to Feature
    • Update feature data
    • Delete feature
    • Show feature data
    • Create a new feature to the service
  • Server
    • Get list database server
    • Creates a new database server identifier
    • Get database server identifier
    • Update database server identifier
    • Delete a server identifier
  • Start
    • Create the liberty administrator user
  • City
    • List of cities
    • Create a new city
    • Update city data
    • Delete a city
    • Link between the city x external application
    • Show city
    • Show city from identity
    • Show city from identity
    • Show city from identity
    • Show city from identity
  • External App
    • Show External App
    • Create an External App
    • Show External App
    • Update an External App
    • Delete an External App
    • Show External App
  • Person
    • List all people
    • Create a new person
    • Show person
    • Update person data
    • Delete a person
    • Link between the person x external application
    • Update the person's address
    • Show Person from External App ID and Identity
    • Show Person from External App Name and Identity
    • List all people from External App ID
    • List all people from External App Name
  • Product
    • Create a new product
    • Retrieve all products
    • Retrieve a product by ID
    • Update an existing product
    • Delete a product by ID
    • Retrieve a product by identity
    • Associate classification flags with a product
  • Contract
    • List all contracts
    • Create a new contract
    • Creates/updates a contract based on data provided by an External App
    • Creates/updates a contract based on data provided by an External App
    • Show contract
    • Alter contract
    • Link between the contract x external application
    • Update contract address
    • Make the contract active
    • Make the contract inactive
    • Show Contract from External App ID and Identity
    • List all contracts from External App ID
    • Show Contract from External App Name and Identity
    • List all contracts from External App ID
    • Update contract connection settings
    • Get the contract items
    • Define the contract items
    • Manipulation of contract flags
  • Core
    • Recover a note from Notepad
    • Get application module versions
    • Create a note in Notepad
    • Checks and updates the database
    • Checks and updates the database for all databases
    • Create database tables
    • Create a new classification
    • List all classifications
    • Get classification by ID
    • Update a classification by ID
    • Delete a classification by ID
    • Get classification by name
    • Update a classification by name
    • Delete a classification by name
  • Webhook
    • Show webhook
    • Create a new webhook
    • Show webhook
    • Alter webhook
    • Creates the link between the webhook and the group
    • Remove the link between the webhook and the group
    • Make the webhook active
    • Makes webhook inactive
  • Metric
    • List metrics
    • Create a new metric
    • Get metric details
    • Update a metric
    • Delete a metric
    • Get metric details
    • Update a metric by name
    • Delete a metric
    • Add a value to a metric
    • Add a value to a metric
    • Retrieve metric history
    • Retrieve metric history
  • User
    • Get user list
    • Creates a new user
    • Activate user
    • Inactivate user
    • Get user
    • Update user data
    • Delete user
    • Change user password
    • Get user by Login
    • Generate password reset authorization key
    • Reset user password
    • Get user global permission
    • Get service permission
    • Get service permission (by service name)
    • Create a new workgroup
    • Show workgroup list
    • Show workgroup data
    • Update workgroup data
    • Delete workgroup
    • Adds the user to the workgroup
    • Remove user from workgroup
    • Update Workgroup Access to Service
    • Update Workgroup Access to Feature
  • ISP
    • Manufacturer
      • Create a new manufacturer
      • List manufacturers
      • Update a manufacturer
      • Delete a manufacturer
      • Retrieve a manufacturer
      • Activate a manufacturer
      • Deactivate a manufacturer
    • POP
      • Create a new Point of Presence (POP)
      • List all POPs
      • Get POP by ID
      • Update a POP
      • Delete a POP
      • Activate a POP
      • Deactivate a POP
    • Radius Attribute
      • Create a new RADIUS attribute
      • List attributes
      • Update an existing attribute
      • Retrieve a specific attribute
      • Delete an attribute
      • Activate an attribute
      • Deactivate an attribute
    • Radius Layout
      • Create a new RADIUS layout
      • List all layouts
      • Get a layout by ID
      • Update a layout
      • Delete a layout
      • Activate a layout
      • Deactivate a layout
      • Add an attribute to a layout
      • Remove an attribute from a layout
      • Retrieve available RADIUS variable templates
    • Radius Pool
      • Create a new RADIUS Pool
      • List all RADIUS Pools
      • Get RADIUS Pool by ID
      • Update a RADIUS Pool
      • Delete a RADIUS Pool
      • Activate a RADIUS Pool
      • Deactivate a RADIUS Pool
    • Radius NAS
      • Create a NAS
      • List NAS (showAll)
      • Get NAS by id (show)
      • Update a NAS
      • Delete a NAS
      • Activate a NAS
      • Deactivate a NAS
  • Esquemas
    • Schemas
      • ResponsePerson
      • FeatureResponse
      • ListResponsePerson
      • ListResponseFeature
      • ManufacturerWithTimestamps
      • ServiceResponse
      • MenuItem
      • PaginationInfo
      • AppMenuItem
      • ResponseWebhook
      • ListResponseService
      • ListResponseWebhook
      • featuremap
      • WorkgroupResponse
      • ListResponseWorkgroup
      • ResponseMetric
      • ListResponseMetric
    • Response
      • Person200Response
      • Contract200Response
      • ListPerson200Response
      • ListContract200Response
      • Metric200Response
      • ListMetric200Response
      • Webhook200Response
      • ListWebhook200Response
    • Raiz
      • ResponseContract
      • Manufacturer
      • RadiusManufacturer
      • Layout
      • Pop
      • Pool
      • Classification
      • UUID
      • ContractRef
      • ListResponseContract
      • RadiusAttribute
      • LayoutAttribute
      • PopWithTimestamps
      • PoolWithTimestamps
      • ClassificationWithTimestamps
      • City
      • ContractProductRef
      • RadiusAttributeWithTimestamps
      • LayoutAttributeInput
      • Address
      • ProductRef
      • LayoutSummary
      • ClientAccessProduct
      • Nas
      • NASRef
      • Pagination
      • ClientAccess
      • NasListResponse
      • NasDetail
      • ClientAccessResponse
      • NasCreateRequest
      • NasListItem
      • NasUpdateRequest
      • NasSingleResponse
  1. Raiz

ClientAccess

{
    "id": "feaca0db-af6d-456a-a345-ac2b83b7da1b",
    "nas": {
        "id": "6fc63d2d-96f9-483b-83f7-3a611c4a8daf",
        "manufacturer": {
            "id": "85d2ddeb-2eb6-4eca-a03f-af29716fa19a",
            "name": "Mikrotik",
            "read_only": true,
            "created_at": "2025-10-15 17:00:01",
            "updated_at": "string",
            "status": true
        },
        "description": "Descrição NAS 01",
        "name": "NAS 01",
        "pop": {
            "id": "4448b3ee-d292-4bd1-aed6-57b3ad340cb0",
            "name": "Casa do Alessandro Duarte de Moraes",
            "description": "Hack na casa do Alessandro",
            "address": {
                "id": "51e8161a-482e-4d34-9bbd-670e0535113c",
                "line1": "Rua Visconde de Mauá, 1019",
                "line2": "",
                "district": "Lagoa",
                "postal_code": "96211031",
                "city": {
                    "id": "e6de10f6-b60a-40a6-aaca-705c007623ac",
                    "name": "Rio Grande",
                    "state": "RS",
                    "country": "Brasil",
                    "created_at": "2025-11-07 18:16:42",
                    "updated_at": "string",
                    "status": true
                },
                "latitude": "0.00000000",
                "longitude": "0.00000000",
                "detail": "Próximo ao minimercado Altas Horas",
                "created_at": "2025-11-07 18:16:42",
                "updated_at": "string"
            },
            "created_at": "2025-11-07 18:16:42",
            "updated_at": "2025-11-07 18:20:20",
            "status": true
        },
        "ip_v4": "192.168.0.111",
        "ip_v6": "string",
        "username": "alessandro",
        "password": "1234",
        "ssh_port": 22,
        "api_port": 8728,
        "telnet_port": 0,
        "radius_port": 0,
        "radius_secret": "string",
        "incoming_port": 0,
        "snmp_port": 0,
        "snmp_community": "string",
        "poolV4Normal": {
            "id": "c8d24093-4a18-493f-af51-3586e77e0761",
            "name": "Pool_Normal",
            "description": "Pool for customers in good standing.",
            "created_at": "2025-10-31 14:48:07",
            "updated_at": "2025-10-31 14:50:20",
            "status": true
        },
        "poolV6Normal": {},
        "poolV4Blocked": {
            "id": "80a3d080-e586-4841-89ed-fd25f447130c",
            "name": "Pool_Bloqueio",
            "description": "Pool for customers caloteiros.",
            "created_at": "2025-11-12 20:55:21",
            "updated_at": "string",
            "status": true
        },
        "poolV6Blocked": {},
        "layout": {},
        "created_at": "2025-11-18 12:51:19",
        "updated_at": "string",
        "status": true
    },
    "username": "235324alessandro.moraes",
    "password": "53540700072",
    "max_upload": 112640,
    "max_download": 500000,
    "connection_type": "PPPoE",
    "poolV4": {},
    "poolV6": {},
    "ip_v4_wan": "string",
    "ip_v6_wan_prefix": "string",
    "ip_v6_pd_prefix": "string",
    "layout": {},
    "clientaccessState": "",
    "products": [
        {
            "id": "52d73e34-1bea-49bf-96b1-f5bc06557f41",
            "isp_clientaccess_id": "feaca0db-af6d-456a-a345-ac2b83b7da1b",
            "contractproduct": {
                "id": "a070be1b-f5c4-4236-a04e-4dbfac243937",
                "contract": {
                    "id": "8fcac13d-aeeb-402c-afbb-9019ba55304e",
                    "number": "235324"
                },
                "groupname": "string",
                "agent": "string",
                "quantity": 1,
                "request_date": "string",
                "start_date": {
                    "date": "2024-12-01 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "end_date": {
                    "date": "2025-08-31 00:00:00.000000",
                    "timezone_type": 3,
                    "timezone": "UTC"
                },
                "billing_start_date": "string"
            },
            "product": {
                "id": "05baee3d-d98c-44db-af89-fceb07b94913",
                "identity": "4521",
                "name": "Pacote de velocidade 200 x 100 down/up",
                "price": 0,
                "st_product_service": "S",
                "st_combo": false,
                "combo": [
                    "string"
                ],
                "category": "connection",
                "max_download": 0,
                "max_upload": 0,
                "flags": [
                    "string"
                ]
            }
        }
    ]
}
Built with