Which parameter used to identify the userType in SCIM and REST API

API and Webhooks Users and Groups
1

Hello team,
Which parameter used identify basic, licnece and on-prem (permission levels) in SCIM and REST API?
Also could you please share a equilvalent attribute of SCIM API personalLinkName and manager in REST API?

2

The parameter used to identify basic, licensed, and on-prem users in SCIM and REST API is user_type.

SCIM personalLinkName has no direct REST equivalent, but it aligns closest with personal_meeting_url or a custom field.
SCIM manager maps to the manager field under the enterprise user extension or its equivalent in REST (often nested under manager or manager_email).

3

Hi @john33 ,

Thanks for reply.
But as per API documentation userType is getting deprecated.

image
image1920×843 99.7 KB

Please confirm on this, should we still go ahead to use userType attribute?

As you already have SCIM APIs in place for user management, could you please share the long-term plan for supporting the User API? Will the User API continue to be supported, or is the plan to move completely to SCIM APIs in the future?
Our current integration is built using the User API, so we’d like to plan ahead and understand any upcoming changes to minimize impact on our customers.

4

Hi @connectivity
Thanks for reaching out to us and sorry for the late reply here!
Are you only using SCIM2 endpoints?
Allow me some time to ask internally about how to identify basic, license and on-rem in SCIM APIs.

5

Hi Elisa / Dev forum,

I am analysing the feasibility to use the Zoom Users API (ref: Users APIs ) or SCIM2 API (ref: SCIM2 APIs ) for creating a User for any of below user type:
Basic
Licensed
On-Prem
Collaboration

As per the Zoom official documentation, the SCIM2 API no longer supports user_type field which used to have 4 possible values (ref: SCIM2 APIs ).
Further, while the Users API (ref: Users APIs ) has field type, it supports only below options:
Basic [1]
Licensed [2]
Unassigned without Meetings Basic [4]
None [99]

Kindly confirm

  1. How can I use the Create User API (or SCIM2 API) to create user for On-Prem or Collaboration user type? Kindly also explain the significance / correlation of license_info_list[].license_option field with the user type.
  2. SCIM2 API allows setting up the manager and personalLinkName fields at the time of user creation (ref: SCIM2 APIs ). However, I need confirmation if these fields or their equivalents are supported or present in the Create User API (ref: Users APIs ).
  3. What is the equivalent of personalLinkName field from SCIM2 API in the 1) Update (PATCH) User API and 2) Get User API?
    If there’s no direct equivalent of personalLinkName field available in any User API, what is the correlation between personalLinkName from SCIM2 API and personal_meeting_url andvanity_url fields from GET User API and vanity_name field from Update (PATCH) User API?

Thanks,
Jaydeep
Connectivity

6

Hi @elisa.zoom , Can you please help me with above questions?

Thanks
Jaydeep
Connectivity

7

Hey @connectivity
I just heard back from our Engineering team and they confirmed that we are deprecating the userType field in the SCMI endpoint but they confirmed that we do not have a set date on when we will be retiring this field since we are behind on updates. They also confirmed we won’t be introducing a new field to replace it, but you should be able to use it for now.

To be able to use the SCMI API, you will need to meet some prerequisites listed in our docs:

The Create users API does not have an equivalent for manager or personalLinkName, but it looks like it is the equivalent to the personal_meeting_url found in the Users API, with the main difference that you can customize the personalLinkName but not the personal_meeting_url.

Hope this helps!

8

Thank you @elisa.zoom for your response.

We are using only Users API and not SCIM2. Thus, we would like to understand-
Question1: Are the user types Collaboration and On-Prem supported in the Users API? What are their equivalent user types if any?

Upon further analysis, I find that

  1. vanity_name is exactly equivalent to personalLinkName. However, vanity_nameis available only in PATCH User API.
  2. vanity_name is available as part of vanity_url in Get User API. vanity_url is an alias for personal_meeting_url.

Kindly confirm if above understanding is correct.

Question2: Are there any plans to support manager and vanity_name / vanity_url as part of List Users and Create User APIs?

Thanks,
Jaydeep - Connectivity

9

Hi @elisa.zoom

While you find answers for the previously asked questions, can you please also confirm if the Zoom future roadmap focuses more on the Users API or the SCIM2 APIs?

10

Hi @connectivity
I did some testing on my end and I am able to use the “vanity_name” to make a Patch request and then when I query the Get a user endpoint, I can see the “vanity_url” in my response.

The only field I cant get back in my response body is the “manager” field. So I will escalate this with our Engineering team (ZSEE-185654 internal ticket for reference)

I will try to get more info on question 1. But I do not think the collaboration and on-prem are supported in the Users API