· 4 years ago · Aug 26, 2021, 10:14 AM
1{
2 "type": "object",
3 "properties": {
4 "basic": {
5 "type": "object",
6 "properties": {
7 "name": {
8 "type": "string",
9 "description": "Name of the Class Room."
10 },
11 "activation_code": {
12 "type": "string",
13 "description": "Activation Code is the code that is used to complete the setup of the Class Room."
14 },
15 "room_passcode": {
16 "type": "string",
17 "description": "1-16 digit number or characters that is used to secure your Class Rooms application. This code must be entered on your Class Room Controller to change settings or sign out.",
18 "minLength": 1,
19 "maxLength": 16
20 },
21 "users": {
22 "type": "array",
23 "description": "Information about the users.",
24 "items": {
25 "type": "object",
26 "required": [
27 "email",
28 "type"
29 ],
30 "properties": {
31 "id": {
32 "type": "string",
33 "description": "The user's ID. \n\nThe API does **not** return this value for users with the `pending` status."
34 },
35 "type": {
36 "type": "integer",
37 "description": "The user's assigned plan type: \n* `1` — Basic. \n* `2` — Licensed. \n* `3` — On-prem. \n* `99` — None (this can only be set with `ssoCreate`).",
38 "enum": [
39 1,
40 2,
41 3,
42 99
43 ],
44 "example": 1
45 },
46 "status": {
47 "type": "string",
48 "description": "The user's status: \n* `active` — An active user. \n* `inactive` — A deactivated user. \n* `pending` — A pending user.",
49 "enum": [
50 "active",
51 "inactive",
52 "pending"
53 ],
54 "example": "active"
55 },
56 "role_id": {
57 "type": "string",
58 "description": "The unique ID of the user's assigned [role](https://marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles)."
59 },
60 "group_ids": {
61 "type": "array",
62 "description": "The IDs of groups where the user is a member.",
63 "items": {
64 "type": "string"
65 }
66 },
67 "verified": {
68 "type": "integer",
69 "description": "Display whether the user's email address for the Zoom account is verified: \n* `1` — A verified user email. \n* `0` — The user's email **not** verified.",
70 "enum": [
71 1,
72 0
73 ]
74 },
75 "custom_attributes": {
76 "type": "array",
77 "description": "Information about the user's custom attributes.\n\nThis field is **only** returned if users are assigned custom attributes and you provided the `custom_attributes` value for the `include_fields` query parameter in the API request.",
78 "items": {
79 "type": "object",
80 "properties": {
81 "key": {
82 "type": "string",
83 "description": "The custom attribute's unique ID."
84 },
85 "name": {
86 "type": "string",
87 "description": "The custom attribute's name."
88 },
89 "value": {
90 "type": "string",
91 "description": "The custom attribute's value."
92 }
93 }
94 }
95 }
96 }
97 }
98 }
99 }
100 }
101 }
102 }