Auth

Users must authenticate successfully before any further API calls can be made. There are two methods for authenticating to api outlined in this section.

API Key

API Keys are provisioned by Support against your Console Connect User Account. Email Support to request a key.

Here is an example request using an API Key:

curl -X GET https://api.consoleconnect.com/api/company/exampleCo/ports \
-H "Authorization: Bearer [[api key]]"

portal-token (Deprecated)

The portal-token method of authentication will be removed soon. Please use API keys to authenticate. Contact Support if a portal-token is required in the meantime.

Get current user

Retrieve account details for the authenticated user.

Securityapi-key

Responses

200

401

Unauthorized

get/api/auth/token

Response samples

application/json

{"id": "669xxxxxxxxxxxxxxxxxxxxx",
"companies": [{"id": "5daxxxxxxxxxxxxxxxxxxxxx",
"username": "samplecompanyname",
"officeAddress": null,
"system": {"welcomeMessage": null
},
"company": {"privacy": {"network": {"mode": "PRIVATE",
"blackListIds": [ ],
"whiteListIds": ["66aad8c7caac3ecbecbd8790"
]
},
"community": {"mode": "PRIVATE",
"blackListIds": [ ],
"whiteListIds": ["66aad8de1c740284bf0b2148"
]
}
},
"industry": null,
"partnerType": null,
"companySize": null,
"dateFounded": null,
"businessRegistrationCertRejectedReason": null,
"clientId": null,
"first": null,
"last": null,
"address": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"fax": null,
"emailDomains": ["email.com"
],
"website": "email.com",
"businessType": "Internal",
"registeredName": "Some Registered Name",
"addresses": [{"geo": {"type": "Point",
"coordinates": [ ]
},
"registered": true,
"address": "123/F, Address street",
"city": "City",
"state": null,
"zip": "123456",
"country": "Country",
"email": null,
"phone": null
}
],
"businessRegistrationCertVerified": "UNVERIFIED",
"regionalInternetRegistry": [ ],
"businessDevelopmentManagerTypePreference": "DATA",
"isIoTDemoCompany": false,
"businessRegistrationCertReference": "5d1xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"businessRegistrationCertUploadedAt": "2024-03-28T14:02:43.261Z",
"isSDWAN": false
},
"cloudProviderDetails": {"asn": {"range": [ ]
},
"bgpAuthority": "PCCWGLOBAL",
"companyType": "DCP"
},
"stats": {"members": 25,
"interconnections": 0,
"followers": 0,
"following": 0,
"privateArticles": 0,
"privateEvents": 0,
"privatePosts": 0,
"articles": 1,
"events": 0,
"posts": 0
},
"overviewImage": null,
"accountManagerEmail": null,
"accountManagerId": null,
"createdAt": "2019-10-16T09:24:25.171Z",
"updatedAt": "2024-07-23T10:54:07.146Z",
"deletedAt": null,
"deleted": false,
"verified": true,
"tags": ["Analytics"
],
"status": "ACTIVE",
"displayOrder": 0,
"groups": [ ],
"location": null,
"summary": "",
"headline": null,
"background": "667xxxxxxxxxxxxxxxxxxxxx",
"avatarId": "5f8xxxxxxxxxxxxxxxxxxxxx",
"name": "Sample Company Name",
"type": "COMPANY",
"oldAvatarId": "5e3xxxxxxxxxxxxxxxxxxxxx",
"verifiedIdentity": true,
"defaultPaymentType": "invoice",
"portsPending": 0,
"portsActive": 4,
"portsDisabled": 0,
"categories": ["NaaS",
"Enterprise"
],
"isCloudProvider": false,
"signedCompanyRefId": 12,
"signedCompanyVerified": true,
"businessRegistrationNumber": "317xxxxx-xxx-xx-xx-x",
"companies": [ ],
"online": false,
"isFollowing": false,
"isFollowee": false,
"linkUserCompany": { }
}
],
"linkUserCompany": {"5daxxxxxxxxxxxxxxxxxxxxx": {"state": "ACTIVE",
"deleted": false,
"id": "669xxxxxxxxxxxxxxxxxxxxx",
"userId": "669xxxxxxxxxxxxxxxxxxxxx",
"companyId": "5daxxxxxxxxxxxxxxxxxxxxx",
"roleIds": ["66aada952027420ab258aecd",
"66aada9ad8cf4a2092ee6f67"
],
"deletedAt": null,
"createdAt": "2024-07-12T08:27:08.033Z",
"updatedAt": "2024-07-12T08:40:48.135Z",
"roles": ["NETWORKCONTROL",
"USER"
],
"permissions": {"roles": [{"name": "NETWORKCONTROL",
"display": "Network Admin",
"icon": "flow switch",
"keyholder": false,
"visible": true,
"shieldOnly": false,
"systemDefault": false,
"unauthenticatedSystemDefault": false,
"id": "55exxxxxxxxxxxxxxxxxxxxx",
"deletedAt": null,
"displayOrder": -299,
"description": "A Network Admin may create, edit, remove, and otherwise manage all of your company's ports, connections and virtual routers",
"tags": ["networkadmin",
"console"
],
"createdAt": "2015-09-30T04:00:00.000Z",
"updatedAt": "2024-05-08T06:57:07.109Z",
"policyIds": ["66aadac907cf5d784e8798a0"
],
"deleted": false,
"permissions": {"company-actions": false,
"company-update": false,
"connection-create": true,
"connection-delete": true,
"connection-modify": true,
"connection-read": true,
"order-create": true,
"order-delete": true,
"order-modify": true,
"order-query": true,
"ports-edit": true,
"ports-read": true,
"user-moderation": false
},
"permissionIds": ["66aadbb9b80425a0177b2aae"
],
"queryable": true,
"companyIds": [ ],
"readOnly": false,
"policies": [{"name": "Console - Network read and write",
"description": "Close Support Tickets for Console Users",
"definition": {"Statement": [{"Action": ["product:DeleteSupportTicket"
],
"Resource": ["rn:cc-api:product::${cc:accountId}:*"
],
"Effect": "Allow",
"Sid": "ProductDeleteSupportTicket"
}
]
},
"id": "66aadac907cf5d784e8798a0",
"deletedAt": null
}
]
},
{"name": "USER",
"display": "Company Member",
"icon": "user outline",
"keyholder": false,
"visible": true,
"shieldOnly": false,
"systemDefault": false,
"unauthenticatedSystemDefault": false,
"id": "55exxxxxxxxxxxxxxxxxxxxx",
"deletedAt": null,
"displayOrder": 300,
"description": "A Member is associated with your company but may not edit company profile information or view company network information",
"tags": ["console"
],
"createdAt": "2015-09-03T06:48:40.377Z",
"updatedAt": "2024-04-02T07:11:45.902Z",
"policyIds": ["66aade651799c8f777e26ec9"
],
"deleted": false,
"permissions": {"company-actions": false,
"company-update": false,
"connection-create": false,
"connection-delete": false,
"connection-modify": false,
"connection-read": false,
"order-create": false,
"order-delete": false,
"order-modify": false,
"order-query": false,
"ports-edit": false,
"ports-read": false,
"user-moderation": false
},
"queryable": false,
"permissionIds": [ ],
"companyIds": [ ],
"readOnly": true,
"policies": [{"name": "Console  - Company Members Read",
"description": "Feature - ZScalerOrder",
"definition": {"Statement": [{"Action": ["feature:EnableZScalerOrder"
],
"Resource": ["*"
],
"Effect": "Allow",
"Sid": "enable-zscaler-order"
}
]
},
"id": "66aade80e5efc037d719edce",
"deletedAt": null
}
]
}
],
"groups": {"NETWORKCONTROL": {"company-actions": false,
"company-update": false,
"connection-create": true,
"connection-delete": true,
"connection-modify": true,
"connection-read": true,
"order-create": true,
"order-delete": true,
"order-modify": true,
"order-query": true,
"ports-edit": true,
"ports-read": true,
"user-moderation": false
},
"USER": {"company-actions": false,
"company-update": false,
"connection-create": false,
"connection-delete": false,
"connection-modify": false,
"connection-read": false,
"order-create": false,
"order-delete": false,
"order-modify": false,
"order-query": false,
"ports-edit": false,
"ports-read": false,
"user-moderation": false
}
}
}
}
},
"capabilities": {"layer2": false,
"layer2Metros": [ ],
"layer2Regions": [ ]
},
"system": {"welcomeMessage": null
},
"cloudProviderDetails": {"asn": {"range": [ ]
},
"companyType": "DCP",
"bgpAuthority": "PCCWGLOBAL"
},
"settings": {"alertMeWhenNewFollower": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenCompanyNewFollower": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenMentionedInPost": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenCompanyMentionedInPost": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenCompanyMemberMentionedInPost": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenCommentInPost": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenCommentInPostByCompany": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenCommentInPostByCompanyMember": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenJoinCompanyRequest": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenJoinCompany": {"category": "communityAndMessages",
"option": true
},
"alertMeWhenInterconnectRequest": {"category": "network",
"option": true
},
"alertMeWhenCompanyJoinsConsole": {"category": "network",
"option": true
},
"alertMeWhenNetworkRelatedEvent": {"category": "network",
"option": true
},
"dismissPlanChangeMessage": {"category": "hidden",
"option": true
},
"alertWhenKeywordsMentioned": {"category": "communityAndMessages",
"option": [ ],
"enabled": true
},
"emailWhenMessageReceived": {"category": "communityAndMessages",
"option": "ALL"
}
},
"stats": {"posts": 0,
"events": 0,
"articles": 0,
"privatePosts": 0,
"privateEvents": 0,
"privateArticles": 0,
"following": 1,
"followers": 0,
"interconnections": 0,
"members": 0
},
"type": "PERSON",
"name": "Sample Full Name",
"email": "sample.email@email.com",
"avatarId": null,
"background": null,
"overviewImage": null,
"headline": "Sample Headline",
"summary": null,
"legalEntityId": null,
"location": null,
"passwordUpdatedAt": null,
"canInviteExternal": false,
"optIntoMarketingEmail": false,
"groups": [ ],
"following": ["5a0xxxxxxxxxxxxxxxxxxxxx"
],
"phone": null,
"needsEmailVerification": false,
"newEmail": null,
"displayOrder": -299,
"newEmailTokenCreatedAt": null,
"status": "ACTIVE",
"tags": [ ],
"categories": [ ],
"verified": false,
"verifiedIdentity": false,
"deleted": false,
"deletedAt": null,
"businessRegistrationNumber": null,
"isCloudProvider": false,
"signedCompanyRefId": null,
"signedCompanyVerified": false,
"accountManagerEmail": null,
"accountManagerId": null,
"username": "sampleusername",
"updatedAt": "2024-07-19T08:15:22.521Z",
"createdAt": "2024-07-12T05:31:06.475Z",
"lastLoggedIn": "2024-07-19T08:15:22.521Z",
"online": false,
"token": null,
"hasAcceptedConsoleTermsOfUse": true
}

➔ Next to Agreements