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

**URL:** <https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293>\
**Category:** Users and Groups\
**Tags:** api\
**Created:** [October 27, 2025, 11:11am UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293 "2025-10-27T11:11:02Z")\
**Posts on this page:** 11\
**Page:** 1

<div class="post-metadata">

**Author:** ![connectivity](https://avatars.discourse-cdn.com/v4/letter/c/7ea924/32.png) [@connectivity](https://devforum.zoom.us/u/connectivity)\
**Post date:** [October 27, 2025, 11:11am UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/1 "2025-10-27T11:11:02Z")

</div>

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?

---

<div class="post-metadata">

**Author:** ![john33](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/john33/32/71961_2.png) [@john33](https://devforum.zoom.us/u/john33)\
**Post date:** [October 27, 2025, 2:23pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/2 "2025-10-27T14:23:29Z")

</div>

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`).

---

<div class="post-metadata">

**Author:** ![connectivity](https://avatars.discourse-cdn.com/v4/letter/c/7ea924/32.png) [@connectivity](https://devforum.zoom.us/u/connectivity)\
**Post date:** [October 28, 2025, 6:30am UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/3 "2025-10-28T06:30:55Z")

</div>

Hi @john33 ,

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

 ![image](https://us1.discourse-cdn.com/flex016/uploads/zoomdeveloper/original/3X/6/b/6b8ff1078252c103d685ef6724cda3536c0a2004.jpeg)

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.

---

<div class="post-metadata">

**Author:** ![elisa.zoom](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/elisa.zoom/32/47836_2.png) [@elisa.zoom](https://devforum.zoom.us/u/elisa.zoom)\
**Post date:** [October 31, 2025, 7:03pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/4 "2025-10-31T19:03:35Z")

</div>

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.

---

<div class="post-metadata">

**Author:** ![connectivity](https://avatars.discourse-cdn.com/v4/letter/c/7ea924/32.png) [@connectivity](https://devforum.zoom.us/u/connectivity)\
**Post date:** [November 1, 2025, 3:52pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/5 "2025-11-01T15:52:23Z")

</div>

Hi Elisa / Dev forum,

I am analysing the feasibility to use the Zoom Users API (ref: [Users APIs](https://developers.zoom.us/docs/api/users/#tag/users/post/users) ) or SCIM2 API (ref: [SCIM2 APIs](https://developers.zoom.us/docs/api/scim2/#tag/user/post/scim2/Users) ) 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](https://developers.zoom.us/docs/api/scim2/#tag/user/post/scim2/Users) ).  
Further, while the Users API (ref: [Users APIs](https://developers.zoom.us/docs/api/users/#tag/users/post/users) ) 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](https://developers.zoom.us/docs/api/scim2/#tag/user/post/scim2/Users) ). However, I need confirmation if these fields or their equivalents are supported or present in the Create User API (ref: [Users APIs](https://developers.zoom.us/docs/api/users/#tag/users/post/users) ).
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` and`vanity_url` fields from GET User API and `vanity_name` field from Update (PATCH) User API?

Thanks,  
Jaydeep  
Connectivity

---

<div class="post-metadata">

**Author:** ![connectivity](https://avatars.discourse-cdn.com/v4/letter/c/7ea924/32.png) [@connectivity](https://devforum.zoom.us/u/connectivity)\
**Post date:** [November 4, 2025, 5:47am UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/6 "2025-11-04T05:47:05Z")

</div>

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

Thanks  
Jaydeep  
Connectivity

---

<div class="post-metadata">

**Author:** ![elisa.zoom](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/elisa.zoom/32/47836_2.png) [@elisa.zoom](https://devforum.zoom.us/u/elisa.zoom)\
**Post date:** [November 4, 2025, 2:44pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/7 "2025-11-04T14:44:54Z")

</div>

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](https://developers.zoom.us/docs/api/scim2/#description/introduction):

- Zoom Owner or Admin privileges.
- Business or Education account with approved [Vanity URL](https://support.zoom.us/hc/en-us/articles/215062646-Guidelines-for-Vanity-URL-Requests).
- [Single Sign-On](https://support.zoom.us/hc/en-us/articles/201363003-Getting-Started-with-SSO) enabled.

The Create users API does not have an equivalent for manager or [personalLinkName](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0068443#h_08f381ef-1e88-417c-b014-a2b9ad4abbda), 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!

---

<div class="post-metadata">

**Author:** ![connectivity](https://avatars.discourse-cdn.com/v4/letter/c/7ea924/32.png) [@connectivity](https://devforum.zoom.us/u/connectivity)\
**Post date:** [November 5, 2025, 1:58pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/8 "2025-11-05T13:58:27Z")

</div>

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_name`is 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](https://developers.zoom.us/docs/api/users/#tag/users/get/users) and [Create User](https://developers.zoom.us/docs/api/users/#tag/users/post/users) APIs?

Thanks,  
Jaydeep - Connectivity

---

<div class="post-metadata">

**Author:** ![connectivity](https://avatars.discourse-cdn.com/v4/letter/c/7ea924/32.png) [@connectivity](https://devforum.zoom.us/u/connectivity)\
**Post date:** [November 6, 2025, 8:42am UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/9 "2025-11-06T08:42:19Z")

</div>

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?

---

<div class="post-metadata">

**Author:** ![elisa.zoom](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/elisa.zoom/32/47836_2.png) [@elisa.zoom](https://devforum.zoom.us/u/elisa.zoom)\
**Post date:** [November 6, 2025, 9:11pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/10 "2025-11-06T21:11:05Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![elisa.zoom](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/elisa.zoom/32/47836_2.png) [@elisa.zoom](https://devforum.zoom.us/u/elisa.zoom)\
**Post date:** [November 10, 2025, 1:51pm UTC](https://devforum.zoom.us/t/which-parameter-used-to-identify-the-usertype-in-scim-and-rest-api/138293/11 "2025-11-10T13:51:03Z")

</div>

Hi @connectivity  
As an update, I am able to get the manager field back in my response body when calling the Get a user endpoint. Just make sure when you send your PATCH request, the manager’s name matches the users name within the Zoom account or it has the correct email address..  
Hope it helps
