Monogoto
Back to Monogoto website
  • Welcome
  • Getting Started
    • Quick Start
    • Device Configurations
      • IoT Modules
        • NORDIC nRF9160 DK
        • Quectel BG95-MX
        • Quectel BG96
        • Murata LBAD0XX1SC-DM
          • Satellite NTN Network
        • Sierra Wireless WP7607
        • Sierra Wireless WP7610
        • Sierra Wireless MC7700
        • SIMCom SIM7070G
          • Waveshare SIM7070G
        • SIMCom SIM7600G-H
          • Waveshare SIM7600G-H
        • Telit HE910
        • Thales Cinterion TX62
        • u-blox SARA R4
          • SODAQ SARA R41XM
        • Cellular Devices
          • Openwrt EG95
          • ProView 4GPro-W
          • Teltonika RUT240
          • Teltonika FMB920
          • InHand IR302
          • Provision-ISR PR-LTE01W
          • Sierra Wireless RV50 AirLink
          • Smart Cash Register Configuration to Use Cellular SIM as WiFi Backup
          • Nayax Nova 40
      • iPhone Device
      • Android Device
      • Raspberry Pi
    • Monogoto SIM
      • IoT SIM card
      • Embedded SIM
      • eSIM
      • iSIM
        • Murata LBAD0XX1SC
        • Quectel BG770A-SN
      • SGP.32
        • Kigen Pulse
      • Monogoto SIM Tool Kit (MTK)
    • Cellular Identities in Monogoto
    • Coverage Lists
      • Identity B Coverage
      • Identity C Coverage
      • Identity E Coverage
      • Identity F Coverage
      • Identity P Coverage
      • Identity U Coverage
      • NTN Satellite Coverage
      • LP-WAN Coverage
    • Features List
    • Community Forum
  • FAQ
  • Hub
    • Intro
      • Signup
      • Login
      • Logout
      • Users
        • Create a new user
        • Delete a user
        • Manage users
        • User password reset
      • General Elements
    • Dashboards
      • Active SIMs and Data Usage
        • Daily Active Things
        • Daily Data Usage
        • Top Consuming Things
        • Top Profiles in Use
        • Top Groups by Data Usage
        • Top Networks by Data Usage
        • Top Groups by Active Things
        • Top Networks by Active Things
      • Data Flows
        • Data Transfer
        • Top Destinations
        • Breakout
        • Services
        • Protocols
        • TCP Flags
        • Top Things (upload/download)
    • Things
      • Thing details
        • Understanding OPLMN and FPLMN on the Thing details page
      • Quality of Service
        • Thing QoS tests for public connectivity
        • Thing QoS monitoring for private connectivity
      • SMS
        • Incoming SMS
        • Outgoing SMS
        • SMS Monitoring
      • Location Service
      • NetFlow
    • Campaigns
      • Campaigns Table
      • Campaign Details
      • SMS Campaign
    • Private Networks
      • Backhaul
      • Edge
        • Edge Events
          • Time
          • Messages
          • msg-type
          • Node
          • Direction
          • Interface
          • Type
      • Radio
    • Inbox
    • Integrations
      • Slack
      • Zapier
      • Webhook
        • Webhook CDRs
          • Webhook SMS CDR
          • Webhook DATA CDR
      • Email
    • Captures
      • Basics on How to Read a Packet Capture File
    • Orders
      • Create a new order
    • Payments
  • Advanced Console
    • Intro
    • Security
    • Network
      • Create new Network
      • Edit Network Settings
      • Apply Network Settings
      • Delete Network
      • Add Network NAT
      • Edit Network NAT
      • Delete Network NAT
      • Add Network Route
      • Edit Network Route
      • Delete Network Route
      • Add Network VPN
      • Network VPN status
      • Edit Network VPN
      • Delete Network VPN
      • Download Network VPN configuration
      • Reconnect Network VPN
      • Ping Network VPN
      • How Devices in The Same Network Can Communicate with Each Other?
    • Things Groups
      • Create Things Group
      • Assign Things to Group
      • Edit Things Group
      • Delete Things Group
      • Override Roaming Policy
    • Things
      • Define Thing Status
      • Edit Things Details
      • Refresh Connection
    • Alerts
      • Alert Metrics (types)
      • Create New Alert
      • Disable/Enable Alert
      • Edit Alert
      • Delete Alert
    • Global Pools
    • Price Plans
    • Webhooks
      • Outgoing (MO) SMS Webhook
      • Incoming (MT) SMS Webhook
      • Outgoing (MO) Voice Webhook
      • Incoming (MT) Voice Webhook
      • Triggered Alert Webhook
  • Developer
    • API
      • Authentication
      • Things
        • Get Things List
        • Get Thing Information
        • Get Thing State
        • Update Thing State
        • Update Thing Name
        • Update Thing Description
        • Get Thing Data Session Status
        • Get Thing ICCID using IMSI
        • Get Thing Lifetime Data Usage
        • Get Thing Events Logs
        • Ping Thing IP Address
        • Lock Thing to IMEI
        • Download Thing PCAP File
        • Refresh Thing Network Connection
        • Get Things Services Usage Report
      • Things Groups
        • Get Things Group List
        • Move Thing to Different Things Group
        • Get Things Group Information
        • Lock Things Group to IMEI range (TAC)
      • eSIM
        • Get an eSIM
        • Cancel an eSIM
        • Download an eSIM
      • Alerts
        • Get Triggered Alerts
      • SMS
        • Check if MT SMS was Received
        • Send SMS to Thing
      • Pricing
        • Get Pricing Plan Information
      • Get Roaming Policy
    • Cloud Integrations
      • AWS IoT Core
      • Ubidots
  • Private Networks
    • Intro
      • Getting Started
      • Spectrum Allocation
    • Monogoto Edge
      • 4G Edge Components
      • 5G Edge Components
      • Edge NUC
      • Edge API
        • Authentication
        • Get Edge Configuration
        • Get Edge ID
        • Get Edge CID
        • Get MME S6A And AMF AUSF Status
        • Get Radio List
        • Get Subscriber Information
        • Get Subscription Status
        • Patch Subscription Status
        • Get IMSI IP Mapping
        • Patch IMSI IP Mapping
        • Delete IMSI IP Mapping
        • Get PLMN
        • Post PLMN
        • Get Network Operator Name
        • Patch Network Operator Name
        • Get APN
        • Get APN IP Pool Mapping
        • Get CDR Logs
        • Post PING
        • Get iperf
        • Patch iperf
        • Get Speed Test
        • Get Data Speed
        • Get Capture
        • Post Capture
    • eNodeB
      • Airspan AirVelocity 1500
      • Baicells Nova 227
      • Baicells Nova 442i
      • Baicells Neutrino 430
      • Baicells Nova 230i
      • BreezeCOMPACT 1000
      • Foxconn T99B226
      • Ubiik goRAN
      • Ubiik FreeRAN
      • T&W N02008
      • Mosolabs SCE4255W
      • Mosolabs SCO4255P
    • gNodeB
      • Mosolabs SCE5164
      • Baicells Stellar 227
    • CPE & UE
      • Airspan AirSpot 5410
      • Sierra Wireless EM7565
      • DG505G CBRS 5G USB Dongle
      • DG10 CBRS USB Dongle
      • D-Link DWP-1010W CPE
      • D-Link DWM-311-G 5G M2M
      • D-Link G530 Router
      • IPC SCB800 CBRS Camera
      • Telit LM960A9-P
      • Moxa 5G CCG-1510-US-T
      • InHand 5G ODU2000
      • Peplink MAX BR1 Mini 5G
      • T&W 5G Router
      • Telit LM960A18
      • Baicells EG7010C-M11 CPE
      • Baicells EG7035E-M11 CPE
      • Baicells EG8015G-M11 CPE
      • Telrad 9000 CPE
      • SRW620 CPE
      • Amit IDG500-0GT01
      • Jacs TD0231 Router
  • NTN Satellite Networks
    • NTN Satellite Coverage
    • NTN Billing
    • NB-IoT: Signaling NIDD vs IP Connectivity
    • VPNs in NTN
    • UDP Communication in NTN
    • How to Order NTN Developer Kit?
    • NTN Certified Devices
      • NTN Certified Modules
        • Murata LBAD0XX1SC-DM Satellite NTN Network
        • Quectel BG95-S5 Satellite NTN Network
        • Quectel BG770A-SN Satellite NTN Network
        • Quectel CC660D-LS Satellite NTN Network
        • SIMCom 7070G-HP-S Satellite NTN Network
        • Murata ALT1250 Satellite NTN Network
      • NTN Certified Chipsets
  • University
    • AT Commands
      • What AT Commands Should I Use to Debug a Connectivity Issue?
      • How to Send AT Commands to a Teltonika Router?
    • LTE bands
    • RAT Type (Radio Access Technology)
    • Low Power Modes: eDRX & PSM
    • What is MCC/MNC?
    • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. Developer
  2. API

Authentication

The following guide describes how to obtain a token for usage with Monogoto API functionality.

Authenticate your user account to obtain a login token

POST https://console.monogoto.io/Auth

Request Body

Name
Type
Description

UserName*

String

Your username

Password*

String

Your password

{
    "token": "eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng",
    "refreshToken": "eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXN6lcklkjoiVklkXzg5Y2464OGEyUtND8ThhLTEzZjA0MzJhZDE3YyINTAgsretszgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MD5786bzdhfdzhY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng8vz567dfzgzfgEtT789D43dWEEW",
    "CustomerId": "cid_ecs1d3a5-f5e62a1-fe8af468wf",
    "UserId": "UserId_a76ty5a5-489a-4b87-9b9u-455f451d99fb",
    "UserName": "demo@monogoto.io",
    "Role": "UserProfileId_40e0998a-ef5c-4bbd-a18bc-2864y6100d1",
    "Realm": "customer",
    "OrganizationId": "OrganizationId_235348d7d-dd99-4111-ab2b-1ec612d9b11a",
    "AccountSettings": {
        "TwoFactorAuthentication": false
    },
    "ThingsGroupIds": [],
    "UserProfile": {
        "Permissions": {
            "API": ["view"],
            "AlertsTasksSettings": ["view", "edit", "delete"],
            "ApnAllowedToCustomer": ["view", "edit", "delete"],
            "AuditLogs": ["view"],
            "AuditLogsOwned": ["view"],
            "BillingReports": ["view"],
            "CurrencyCodes": ["view"],
            "Dashboard": ["view", "edit", "delete"],
            "ExternalHLR": ["view"],
            "GlobalSettings": ["view"],
            "IpPools": ["view", "edit", "delete"],
            "MobileSubscriber": ["view", "edit", "delete"],
            "NetwSecSettings": ["view", "edit", "delete"],
            "NetworkProvider": ["view"],
            "NetworkProviderDetails": ["view", "edit", "delete"],
            "PortalAlertsTasksSettings": ["view"],
            "PortalAuditLogs": ["view"],
            "PortalBillingReports": ["view"],
            "PortalDashboard": ["view"],
            "PortalIpPools": ["view"],
            "PortalLogin": ["view"],
            "PortalMobileIdentities": ["view"],
            "PortalNetwork": ["view"],
            "PortalPricePlanDetails": ["view"],
            "PortalRealtimeDashboard": ["view"],
            "PortalRoamingOwned": ["view"],
            "PortalSecurity": ["view"],
            "PortalSettings": ["view"],
            "PortalThings": ["view"],
            "PortalThingsGroups": ["view"],
            "PortalUsers": ["view"],
            "PricePlanDetails": ["view", "edit", "delete"],
            "RoamingOwned": ["view", "edit", "delete"],
            "Settings": ["view"],
            "Tags": ["view", "edit", "delete"],
            "TagsOwned": ["view", "edit", "delete"],
            "Things": ["view", "edit", "delete"],
            "ThingsGroup": ["view", "edit", "delete"],
            "ThingsGroupOwned": ["view", "edit", "delete"],
            "ThingsSensitiveData": ["view", "edit", "delete"],
            "UserProfile": ["view"],
            "Users": ["view", "edit", "delete"],
            "PortalReports": ["view"],
            "ReportTemplate": ["view", "edit", "delete"],
            "ReportHistory": ["view", "edit", "delete"],
            "DownloadReportInPdf": ["view", "edit", "delete"],
            "Scheduler": ["view", "edit", "delete"],
            "PortalScheduler": ["view"],
            "Search": ["view7", "edit", "delete"],
            "DownloadPCAPFile": ["view"],
            "DataLocationService": ["view"],
            "Bundle": ["view", "edit", "delete"]
        },
        "DateCreated": 1550396272390,
        "Name": "Customer Admin",
        "Realm": "customer",
        "Type": "USER_PROFILE",
        "UserProfileId": "UserProfileId_40e0998a-ef5c-4bbd-a18bc-2864y6100d1",
        "DateModified": 1606904198590,
        "cas": "160777788521644"
    }
}
{
    Access denied
}

Add your UserName and Password in the POST request to successfully obtain your login token.

{
  "UserName": "string",
  "Password": "string"
}

Example using cURL:

curl -X POST \
     --url 'https://console.monogoto.io/Auth' \
     -H 'Content-Type: application/json' \
     -d '{
        "UserName": "string",
        "Password": "string"
        }'

Example response showing the login token, CustomerID etc:

{
    "token": "eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXNlcklkIjoiVklkXzg5Yj5Y2OGEyUtNDQThhLTEzZjA0MzJhZDE3YyINTAzgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MDY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng",
    "refreshToken": "eyJhb6IkpXVCJ9.eyJSb2xlIjoiVXN4lclByb2ZpbGVJZF9kZGM2MThhNC0wNTI1LTQ2MmUtYWN3NzhhMGQxYmbSI6Im4zgFkbWluIiwiQ3VzdG9tsbCwiVXN6lcklkjoiVklkXzg5Y2464OGEyUtND8ThhLTEzZjA0MzJhZDE3YyINTAgsretszgZmUtZGI51My00ZjRiLTktN2U5Yjc0ZWU1ZThlIiwiaWNzM3MjI5L2MD5786bzdhfdzhY3NTE2Mjl9.99aSLzP7kTgK6TZGW-xalrMu0GkW6viunt3XxbNng8vz567dfzgzfgEtT789D43dWEEW",
    "CustomerId": "cid_ecs1d3a5-f5e62a1-fe8af468wf",
    "UserId": "UserId_a76ty5a5-489a-4b87-9b9u-455f451d99fb",
    "UserName": "demo@monogoto.io",
    "Role": "UserProfileId_40e0998a-ef5c-4bbd-a18bc-2864y6100d1",
    "Realm": "customer",
    "OrganizationId": "OrganizationId_235348d7d-dd99-4111-ab2b-1ec612d9b11a",
    "AccountSettings": {
        "TwoFactorAuthentication": false
    },
    "ThingsGroupIds": [],
    "UserProfile": {
        "Permissions": {
            "API": ["view"],
            "AlertsTasksSettings": ["view", "edit", "delete"],
            "ApnAllowedToCustomer": ["view", "edit", "delete"],
            "AuditLogs": ["view"],
            "AuditLogsOwned": ["view"],
            "BillingReports": ["view"],
            "CurrencyCodes": ["view"],
            "Dashboard": ["view", "edit", "delete"],
            "ExternalHLR": ["view"],
            "GlobalSettings": ["view"],
            "IpPools": ["view", "edit", "delete"],
            "MobileSubscriber": ["view", "edit", "delete"],
            "NetwSecSettings": ["view", "edit", "delete"],
            "NetworkProvider": ["view"],
            "NetworkProviderDetails": ["view", "edit", "delete"],
            "PortalAlertsTasksSettings": ["view"],
            "PortalAuditLogs": ["view"],
            "PortalBillingReports": ["view"],
            "PortalDashboard": ["view"],
            "PortalIpPools": ["view"],
            "PortalLogin": ["view"],
            "PortalMobileIdentities": ["view"],
            "PortalNetwork": ["view"],
            "PortalPricePlanDetails": ["view"],
            "PortalRealtimeDashboard": ["view"],
            "PortalRoamingOwned": ["view"],
            "PortalSecurity": ["view"],
            "PortalSettings": ["view"],
            "PortalThings": ["view"],
            "PortalThingsGroups": ["view"],
            "PortalUsers": ["view"],
            "PricePlanDetails": ["view", "edit", "delete"],
            "RoamingOwned": ["view", "edit", "delete"],
            "Settings": ["view"],
            "Tags": ["view", "edit", "delete"],
            "TagsOwned": ["view", "edit", "delete"],
            "Things": ["view", "edit", "delete"],
            "ThingsGroup": ["view", "edit", "delete"],
            "ThingsGroupOwned": ["view", "edit", "delete"],
            "ThingsSensitiveData": ["view", "edit", "delete"],
            "UserProfile": ["view"],
            "Users": ["view", "edit", "delete"],
            "PortalReports": ["view"],
            "ReportTemplate": ["view", "edit", "delete"],
            "ReportHistory": ["view", "edit", "delete"],
            "DownloadReportInPdf": ["view", "edit", "delete"],
            "Scheduler": ["view", "edit", "delete"],
            "PortalScheduler": ["view"],
            "Search": ["view7", "edit", "delete"],
            "DownloadPCAPFile": ["view"],
            "DataLocationService": ["view"],
            "Bundle": ["view", "edit", "delete"]
        },
        "DateCreated": 1550396272390,
        "Name": "Customer Admin",
        "Realm": "customer",
        "Type": "USER_PROFILE",
        "UserProfileId": "UserProfileId_40e0998a-ef5c-4bbd-a18bc-2864y6100d1",
        "DateModified": 1606904198590,
        "cas": "160777788521644"
    }
}

Authorization Header

Once you obtained a token, make sure to add your login token to the the authorization header in all requests.

-H 'authorization: Bearer {YOUR_TOKEN}'

Example

curl --request GET \
     --url https://console.monogoto.io/thing/{YOUR_THING_ID}/state \
     -H 'Accept: application/json' \
     -H 'Authorization: Bearer {YOUR_TOKEN}'

PreviousAPINextThings

Last updated 4 months ago

Was this helpful?

Error with : Failed to convert Swagger 2.0 to OpenAPI 3.1.1

  • Authenticate your user account to obtain a login token
  • Example using cURL:
  • Authorization Header