Mike Swanson
6942827391
Author: Mike Swanson Machine: Mikes-MacBook-Air.local Timestamp: 2026-07-09 14:52:07
12 KiB
Yealink Management Cloud Service(YMCS)_User Guide.pdf - Pages 881-900
Source: Yealink Management Cloud Service(YMCS)_User Guide.pdf Pages: 881-900 of 953 Chunk: 45
Yealink Management Cloud Service(YMCS) U...
// Request Data function request(method, endpoint, requestBody, headers){ // Create a GlideHTTPRequest object var httpRequest = new sn_ws.RESTMessageV2(); // Set the endpoint for REST messages httpRequest.setEndpoint(endpoint); // Set the HTTP method to POST httpRequest.setHttpMethod(method); // Set the HTTP headers if (headers) { for (var key in headers) { if (headers.hasOwnProperty(key)) { httpRequest.setRequestHeader(key, headers[key]); } } } // Send a request and get a response httpRequest.setRequestHeader("Content-Type", "application/json"); httpRequest.setRequestBody(JSON.stringify(requestBody)); var httpResponse = httpRequest.execute(); // Get the response body (body) return httpResponse.getBody(); }
// Build authentication information function getBasicAuth(accessKeyId, accessKeySecret) { var credentials = accessKeyId + ':' + accessKeySecret; var base64Credentials = GlideStringUtil.base64Encode(credentials); return 'Basic ' + base64Credentials; }
// generateUUID function getNonce() {
66 / 108
Yealink Management Cloud Service(YMCS) U...
return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) { var r = Math.random() * 16 | 0, v = c == 'x' ? r : (r & 0x3 | 0x8); return v.toString(16); }); }
// is error function isError(responseObject){ if (responseObject && !responseObject.hasOwnProperty('error')) { return false; } if (responseObject && (!responseObject['error'] || responseObject['error'] == '')) { return false; } clearTokenCache(); return true; }
Single Sign-On Step 1 Configure Microsoft Azure AD Login Method
Procedure
-
Log in to the Azure admin portal.
-
Click
67 / 108
Yealink Management Cloud Service(YMCS) U...
Azure Active Directory in the top-left corner.
-
Click Enterprise applications in the left navigation bar.
68 / 108
Yealink Management Cloud Service(YMCS) U...
-
Click All applications > New application.
-
Click Create your own application. Enter the application name and check Register an application to integrate with Azure AD (App you’re deploying) and click Create.
69 / 108
Yealink Management Cloud Service(YMCS) U...
-
Check Accounts in this organizational directory only (wmroomtest only - Single tenant) to support trial for users in the current tenant directory and click Register.
-
Go back to the Azure Active Directory home page, click App registrations, find and click the application you just create.
70 / 108
Yealink Management Cloud Service(YMCS) U...
-
Go to the application details page. The Application (client) ID is the Client ID and the directory (tenant) is the Tenant ID.
-
Click Authentication > Add a platform in the left navigation bar and select Web.
71 / 108
Yealink Management Cloud Service(YMCS) U...
-
Enter the login address in the Redirect URIs field, the logout address in the Front- channel logout URL field, and select the check box of ID tokens (used for implicit and hybrid flows) and click Configure. Please enter the following login and logout addresses according to your site.
-
The configuration is complete. You can perform further SSO configuration in the YMCS platform.
EU Login address https://eu.ymcs.yealink.com/manager/front/auth/ region signin-oidc
Logout https://eu.ymcs.yealink.com/manager/front/auth/
address logout
72 / 108
Yealink Management Cloud Service(YMCS) U...
US Login address https://us.ymcs.yealink.com/manager/front/auth/ region signin-oidc
Logout https://us.ymcs.yealink.com/manager/front/auth/
address logout
AU Login address https://au.ymcs.yealink.com/manager/front/auth/ region signin-oidc
Logout https://au.ymcs.yealink.com/manager/front/auth/
address logout
UAE Login address https://uae.ymcs.yealink.com/manager/front/auth/signin- region oidc
Logout address https://uae.ymcs.yealink.com/manager/front/auth/logout
Step 2 Enable and Configure SSO
Introduction After enabling single sign-on and creating third-party administrator accounts, you can use these accounts to sign in to the YMCS platform with the account and password of the third-party platform (only Microsoft accounts are supported), improving login efficiency and avoiding security risks.
Procedure Enable SSO
-
Sign in to YMCS.
-
Click System > Integration > Single Sign-On.
73 / 108
Yealink Management Cloud Service(YMCS) U...
- Click the toggle beside Single Sign-On to enable it.
- Select an authentication platform (currently, only Microsoft Azure AD is supported).
- Refer to the Microsoft AD login configuration method and enter the Client ID of Microsoft Azure AD as well as the Tenant ID to configure the authentication platform.
- Click Save.
Create a Sub Account with SSO Feature Please refer to add sub accounts to create a sub account with SSO feature. Once configured, this sub account can log in to the YMCS platform using SSO. Step 3 Sign In via SSO
Introduction You can use your Microsoft account to easily log in to the YMCS platform, effectively improving login efficiency and avoiding some of the security risks.
Prerequisites Your enterprise has configure Microsoft Azure AD login method and enabled SSO. The enterprise administrator has created a third-party administrator account for you.
Procedure
- For the first login, click the login address in the email or enter the login address in the browser address bar.
💡 TIP
74 / 108
Yealink Management Cloud Service(YMCS) U...
You can use the global address (https://ymcs.yealink.com/manager/
login) to sign in, and YMCS will automatically detect and redirect you to
your region.
-
Optional: Switch the language in the top-right corner.
-
Click SSO.
-
Enter the third-party account and click Continue.
-
On the Microsoft login authentication page, enter your Microsoft account and password. After finishing the verification, you can log in to YMCS.
75 / 108
Yealink Management Cloud Service(YMCS) U...
API Introduction You can view the enterprise's API domain name on the API service interface, as well as the AccessKey ID and AccessKey Secret used for identity verification in API requests.
💡 NOTE Only super administrators can see the API interface.
Procedure
-
Log in to YMCS.
-
Click System > Integration > API.
76 / 108
Yealink Management Cloud Service(YMCS) U...
-
Do one of the following: Click Edit to Reacquire or Delete the authentication information. The old authentication information will become invalid immediately. Click
to view the corresponding information.
77 / 108
Yealink Management Cloud Service(YMCS) U...
Click
to copy the corresponding information.
78 / 108
Yealink Management Cloud Service(YMCS) U...
Log Management Introduction Any operations performed by the administrator, the sub-administrator, or the superior channel on the YMCS are recorded as the operation logs. You can view these operation records through log management to obtain details such as the operation target, operator, and operation time. Procedure
-
Sign in to YMCS.
-
Click System > Logs.
-
You can find specific operation records by selecting a start time or searching for an operator/IP.
79 / 108
Yealink Management Cloud Service(YMCS) U...
Manage Sub Accounts and Their Permission Sub Accounts Add Sub Accounts
Introduction You can add sub accounts for your organization, which can log in to YMCS and have specific operational permission granted by you for relevant features. Only the main account (the registered email address used when the enterprise was created) and super administrators have the authority to manage sub- accounts and associate roles with them.
Procedure
-
Sign in to YMCS.
-
Click System > Sub Accounts > Sub Accounts > Add.
-
Edit the sub-account-related information. Account Type: Select the account type as Ordinary/External. Ordinary: The sub-account is created in YMCS.
80 / 108
Yealink Management Cloud Service(YMCS) U...
External: You can use the Microsoft account credentials to sign in to YMCS via
SSO.
💡 NOTE You need to configure SSO before creating a third-party account.
Email: Enter the email address of this account.
Contact: Enter the contact name.
Phone Number: Edit the phone number of the contact.
Role: Select Administrator.
Login Protection: Enable or disable the login protection feature.
Description: Enter a description.
-
Click OK. The sub account is created. At the same time, the sub account will receive an email containing the login address, the username, the password and other information.
81 / 108
Yealink Management Cloud Service(YMCS) U...
82 / 108
Yealink Management Cloud Service(YMCS) U...
Manage Sub Accounts Introduction You can add sub accounts for your organization, which can log in to YMCS and have specific operational permission for relevant features.
Go to the Sub Account List Procedure
- Sign in to YMCS.
- Click System > Sub Accounts > Sub Accounts.
Edit Sub Account Procedure
- In the sub account list, click Edit on the right side of the desired account to edit the related information.
Enable/Disable Login Protection Procedure
-
In the sub account list, click and select
83 / 108
Yealink Management Cloud Service(YMCS) U...
and select Enable Login Protection/Disable Login Protection.
Enable/Disable Sub Account Introduction The sub account is activated by default after it is created. You can enable or disable the sub account. When the account status changes, the sub account will get notifications via email. Procedure
-
In the sub account list, click and select
84 / 108
Yealink Management Cloud Service(YMCS) U...
and select Enable Account/Disable Account. 2. If the account is disabled, the account cannot sign in to YMCS.
Reset Password Password reset can deal with password leakage and manage personnel changes to enhance security. Procedure
-
In the sub account list, click and select
85 / 108