Log in With Username and Password (v3)

POST

/v3/login

POST

/v3/login

curl -X POST https://api.megaport.com/v3/login \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "password=Dfjhgedcifk%40!23" \
     -d "username=megaport.newuser%40abcd.com"

{
  "data": {
    "accountManager": {
      "active": true,
      "email": "luke.richardson@megaport.com",
      "featureFlags": [],
      "firstName": "Luke",
      "lastName": "Richardson",
      "name": "Luke Richardson",
      "newsletter": true,
      "promotions": true,
      "uid": "1a9cdeaf-549b-4d8a-9f5d-9819f92c4e45"
    },
    "accountType": "ADMIN",
    "apiKey": false,
    "authorities": {
      "bec27ded-29fb-43dd-8df8-894eb5ca1e98": {
        "end_user": true
      }
    },
    "channelPartner": false,
    "companyConfiguration": {
      "consolidatedSettings": [
        {
          "key": "NOTIFICATIONS_ENABLED",
          "value": true
        },
        {
          "key": "INTERCOM_ENABLED",
          "value": true
        },
        {
          "key": "JIRA_CHAT_ENABLED",
          "value": true
        },
        {
          "key": "MARKET_AUSTRALIA",
          "value": true
        },
        {
          "key": "MARKET_HONG_KONG",
          "value": true
        },
        {
          "key": "MARKET_SINGAPORE",
          "value": true
        },
        {
          "key": "MARKET_SWITZERLAND",
          "value": true
        },
        {
          "key": "MARKET_NEW_ZEALAND",
          "value": true
        },
        {
          "key": "MARKET_US",
          "value": true
        },
        {
          "key": "MARKET_CANADA",
          "value": true
        },
        {
          "key": "MARKET_IRELAND",
          "value": true
        },
        {
          "key": "MARKET_SWEDEN",
          "value": true
        },
        {
          "key": "MARKET_NETHERLANDS",
          "value": true
        },
        {
          "key": "MARKET_GERMANY",
          "value": true
        },
        {
          "key": "MARKET_GERMANY_ECIX",
          "value": true
        },
        {
          "key": "MARKET_BULGARIA",
          "value": true
        },
        {
          "key": "MARKET_UK",
          "value": true
        },
        {
          "key": "MARKET_NORWAY",
          "value": true
        },
        {
          "key": "MARKET_FINLAND",
          "value": true
        },
        {
          "key": "MARKET_AUSTRIA",
          "value": true
        },
        {
          "key": "MARKET_POLAND",
          "value": true
        },
        {
          "key": "MARKET_DENMARK",
          "value": true
        },
        {
          "key": "MARKET_BELGIUM",
          "value": true
        },
        {
          "key": "MARKET_FRANCE",
          "value": true
        },
        {
          "key": "MARKET_JAPAN",
          "value": true
        },
        {
          "key": "MARKET_BRAZIL",
          "value": true
        },
        {
          "key": "MARKET_ITALY",
          "value": true
        },
        {
          "key": "MARKET_SPAIN",
          "value": true
        },
        {
          "key": "MARKET_LUXEMBOURG",
          "value": true
        },
        {
          "key": "REGISTRATION_TYPE_EMAIL_LINK",
          "value": true
        },
        {
          "key": "REGISTRATION_TYPE_USER_PROVIDES_CREDENTIALS",
          "value": false
        },
        {
          "key": "VANTAGE_PREFERRED",
          "value": false
        },
        {
          "key": "VANTAGE_PRESTIGE",
          "value": false
        },
        {
          "key": "DASHBOARD_ENABLED",
          "value": true
        },
        {
          "key": "COMPANY_PROFILE_ENABLED",
          "value": true
        },
        {
          "key": "MARKETPLACE_PROFILE_ENABLED",
          "value": true
        },
        {
          "key": "PRICING_VISIBLE",
          "value": true
        },
        {
          "key": "PAYS_BILL",
          "value": true
        },
        {
          "key": "PRODUCT_TYPE_MEGAPORT",
          "value": true
        },
        {
          "key": "PRODUCT_TYPE_IX",
          "value": true
        },
        {
          "key": "PRODUCT_TYPE_MVE",
          "value": true
        },
        {
          "key": "PRODUCT_TYPE_MCR2",
          "value": true
        },
        {
          "key": "PRODUCT_TYPE_VXC",
          "value": true
        },
        {
          "key": "MVE_BETA_VMWARE",
          "value": false
        },
        {
          "key": "MVE_BETA_FORTINET",
          "value": false
        },
        {
          "key": "MVE_BETA_CISCO",
          "value": false
        },
        {
          "key": "MVE_BETA_VERSA",
          "value": false
        },
        {
          "key": "MVE_BETA_ARUBA",
          "value": false
        },
        {
          "key": "MVE_VENDOR_VMWARE",
          "value": true
        },
        {
          "key": "MVE_VENDOR_FORTINET",
          "value": true
        },
        {
          "key": "MVE_VENDOR_CISCO",
          "value": true
        },
        {
          "key": "MVE_VENDOR_VERSA",
          "value": true
        },
        {
          "key": "MVE_VENDOR_ARUBA",
          "value": true
        },
        {
          "key": "VANTAGE_PARTNER",
          "value": false
        },
        {
          "key": "PORTAL_ACCESS_TYPE_STANDARD",
          "value": true
        },
        {
          "key": "PORTAL_ACCESS_TYPE_WHITELABEL",
          "value": false
        },
        {
          "key": "PORTAL_ACCESS_TYPE_NONE",
          "value": false
        }
      ]
    },
    "companyId": 1269,
    "companyName": "Public Access",
    "companyType": "DEFAULT",
    "companyUid": "bec27ded-29fb-43dd-8df8-894eb5ca1e98",
    "email": "megaport.newuser@abcd.com",
    "expiryDate": "",
    "featureFlags": [
      "pv_manual_mvp",
      "distributor_support",
      "vxc_20g",
      "term_mcr",
      "partner_portal",
      "validation"
    ],
    "firstName": "p",
    "forcePassword": false,
    "fullName": "p k",
    "idpId": "ec81f4d2-5902-4dba-9df6-ad212a1b2295",
    "language": "English",
    "lastName": "k",
    "locale": "United Kingdom",
    "loginDate": 1644820229860,
    "name": "p k",
    "nearestCountry": "",
    "new": false,
    "oAuthToken": {
      "accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIwMGNmMGQ3YS1iODM1LTQ3ODItOGM1MC0wZGY5ZjdlNjAxNjUiLCJ0b2tlbl91c2UiOiJhY2Nlc3MiLCJpc3MiOiJodHRwczovL2FwaS5tZWdhcG9ydC5jb20vdjIvbG9naW4iLCJncm91cHMiOlsicm9sZTphZG1pbiIsImNvbXBhbnk6YzEzNWQ3M2EtZjU0MC00ZGMxLWE0NzUtNGMxZjU1OTlhOWY0IiwicGVybWlzc2lvbjpoZWxsbyIsInBlcm1pc3Npb246d29ybGQiXSwiZXhwIjoxNjQ0ODIzNzAwLCJ1c2VybmFtZSI6ImpvZXkudHJpYmJpYW5pQGZyaWVuZHMuY29tIn0.cjcG-0kNpUu51BnrhI9D7R_7x2qFnE_Vu8iTUhDWGZwNYlpd8EsltwOnpT3A3HVs76-SK4MLyiP3-4sPcI4IhQ",
      "expiresIn": 1000,
      "idToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIwMGNmMGQ3YS1iODM1LTQ3ODItOGM1MC0wZGY5ZjdlNjAxNjUiLCJ0b2tlbl91c2UiOiJpZCIsImlzcyI6Imh0dHBzOi8vYXBpLm1lZ2Fwb3J0LmNvbS92Mi9sb2dpbiIsImdyb3VwcyI6WyJyb2xlOmFkbWluIiwiY29tcGFueTpjMTM1ZDczYS1mNTQwLTRkYzEtYTQ3NS00YzFmNTU5OWE5ZjQiLCJwZXJtaXNzaW9uOmhlbGxvIiwicGVybWlzc2lvbjp3b3JsZCJdLCJleHAiOjE2NDQ4MjM3MDAsImdpdmVuX25hbWUiOiJKb2V5IiwiZmFtaWx5X25hbWUiOiJUcmliYmlhbmkiLCJlbWFpbCI6ImpvZXkudHJpYmJpYW5pQGZyaWVuZHMuY29tIiwidXNlcm5hbWUiOiJqb2V5LnRyaWJiaWFuaUBmcmllbmRzLmNvbSJ9.JTPDc45yWhOlA6Wjm1t-rOkS8cZcA2UypLFlYfFvAQ3PyPFeOfhzWU290Ae14__ercZ3cOa812vgNveCb8WRgQ",
      "tokenType": "Bearer"
    },
    "parentCompanyUid": "",
    "permissions": {
      "bec27ded-29fb-43dd-8df8-894eb5ca1e98": [
        "end_user"
      ]
    },
    "personId": 47501,
    "personUid": "379473d7-ebc8-455e-bffa-370f9378240c",
    "phone": "",
    "region": "",
    "requireTotp": false,
    "rootAccountType": "ADMIN",
    "sourceIp": "192.168.1.1",
    "supportOverride": false,
    "supportOverrideId": "",
    "t": 1,
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.80 Safari/537.36",
    "username": "megaport.newuser@abcd.com"
  },
  "message": "Login successfully",
  "terms": "This data is subject to the Acceptable Use Policy https://www.megaport.com/legal/acceptable-use-policy"
}

Logs a user in to the Megaport Portal when they supply a valid username and password.

This endpoint is called to log an existing user into the system. The endpoint can accept either an encoded password or a plain text password. If multi-factor authentication is enabled on the account, then a valid oneTimePassword value must be provided.

Note: If you receive error code 409 Conflict in a response when using this endpoint, it means that the user’s email address has not yet been verified. The email address will need to be verified first using the instructions in the Setting Up a Megaport Account section of the Megaport documentation. For more information, see Setting Up a Megaport Account.

Request

This endpoint expects an object.

passwordstringOptional

usernamestringOptional

Response

dataobjectOptional

messagestringOptional

termsstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

409

Conflict Error