Using REST API's by Glenn Inn
Sometimes you may have an application that needs to lookup the account information given a BlueJeans username.
This step by step guide will walk you the search process using Meeting's enterprise search API
BlueJeans REST API messages must contain certain formatting values in order to be recognized as valid. Please ensure that each REST call has the following fields:
Step 1
Get Access to the Enterprise
The first step an application must do is get Administrative access to the enterprise.
Typically this type of authentication utilizes a Client_Code OAuth process. The OAuth call will yield a enterprise user access token which becomes your software passkey to make API calls with enterprise administrative privileges.
The keys used by a Client_Code API call are generated by through the Enterprise Administrator Web Portal. Your administrator can provide you with a set of keys dedicated just to your application. You can find more information here about keys and client authentication: How-to authenticate my applications.
BlueJeans uses the industry standard OAuth protocol for authentication.
{
"grant_type": "client_credentials",
"client_id": "anEnterpriseKey",
"client_secret": "cc1c2...24a3f04"
}
{
"access_token": "a61e6f2842e04b9c8254428628e0e7c4",
"expires_in": 3600,
"scope": {
"enterprise": 28663,
"partitionName": "z2",
"partition": {
"id": 2,
"name": "z2"
}
}
}
Step 2(a)
Look for user from a partial string name
Perhaps you need to find the account information for a user whose name is Stavros Jones. If you do not know Stavro's email address, you can do a string search instead.
For this search, we will use the partial string "Stav" to return all accounts whose username, first name, middle name, last name, or email address contain this string
BlueJeans will return Stavros' unique account id: 1483589
Along with this API call, you must pass the access_token obtained from the Authentication step.
fields=username,firstName,middleName,lastName,isEnterpriseAdmin,email textSearch=Stav pageSize=10
{
"count": 2,
"users": [
{
"firstName": "Stavros",
"lastName": "Jones",
"middleName": "",
"id": 1483589,
"isEnterpriseAdmin": true,
"uri": "/v1/user/1483589",
"email": "sjones@mycompany.com",
"username": "sjones"
},
{
"firstName": "Julianne",
"lastName": "Donostavian",
"middleName": "",
"id": 460351,
"isEnterpriseAdmin": false,
"uri": "/v1/user/460351",
"email": "jdonstavian@mycompany.com",
"username": "jdonstavian"
}
]
}
Step 2(b)
Look for user by email address
Perhaps you know the email address of the account. Here you can search for the account information for sjones@mycompany.com.
BlueJeans will return Stavros' unique account id: 1483589
Along with this API call, you must pass the access_token obtained from the Authentication step.
fields=username,firstName,middleName,lastName,isEnterpriseAdmin,email emailId=sjones@mycompany.com pageSize=10
{
"count": 1,
"users": [
{
"firstName": "Stavros",
"lastName": "Jones",
"middleName": "",
"id": 1483589,
"isEnterpriseAdmin": true,
"uri": "/v1/user/1483589",
"email": "sjones@mycompany.com",
"username": "sjones"
}
]
}
Step 3
Look-up full user information
Now that we have the Unique User ID number for Stavros, 1483589, we can retrieve his full account information.
Along with this API call, you must pass the access_token obtained from the Authentication step.
userId
{
"id": 1483589,
"username": "sjones",
"firstName": "Stavros",
"lastName": "Jones",
"emailId": "sjones@mycompany.com",
"company": "My Company",
"middleName": "",
"title": "Chief Muckraker",
"language": "en",
. . . and many more ...
}