@seamapi/types 1.245.1 → 1.247.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +448 -103
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +313 -2
- package/lib/seam/connect/models/acs/acs-user.js +72 -20
- package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +147 -2
- package/lib/seam/connect/openapi.js +387 -68
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +166 -0
- package/package.json +2 -2
- package/src/lib/seam/connect/models/acs/acs-user.ts +90 -20
- package/src/lib/seam/connect/openapi.ts +450 -68
- package/src/lib/seam/connect/route-types.ts +166 -0
package/dist/connect.cjs
CHANGED
|
@@ -1415,34 +1415,60 @@ zod.z.object({
|
|
|
1415
1415
|
});
|
|
1416
1416
|
var acs_users_warnings = zod.z.union([acs_users_being_deleted, acs_users_salto_ks_user_not_subscribed]).describe("Warning associated with the `acs_user`.");
|
|
1417
1417
|
var user_fields = zod.z.object({
|
|
1418
|
-
full_name: zod.z.string().optional(),
|
|
1418
|
+
full_name: zod.z.string().optional().describe("Full name of the `acs_user`."),
|
|
1419
1419
|
email: zod.z.string().email().optional().describe(`
|
|
1420
1420
|
---
|
|
1421
1421
|
deprecated: use email_address.
|
|
1422
1422
|
---
|
|
1423
1423
|
`),
|
|
1424
|
-
email_address: zod.z.string().email().optional(),
|
|
1425
|
-
phone_number: phone_number.optional()
|
|
1424
|
+
email_address: zod.z.string().email().optional().describe("Email address of the `acs_user`."),
|
|
1425
|
+
phone_number: phone_number.optional().describe(
|
|
1426
|
+
"Phone number of the `acs_user` in E.164 format (for example, `+15555550100`)."
|
|
1427
|
+
)
|
|
1426
1428
|
});
|
|
1427
1429
|
var common_acs_user = zod.z.object({
|
|
1428
|
-
acs_user_id: zod.z.string().uuid(),
|
|
1429
|
-
acs_system_id: zod.z.string().uuid()
|
|
1430
|
+
acs_user_id: zod.z.string().uuid().describe("ID of the `acs_user`."),
|
|
1431
|
+
acs_system_id: zod.z.string().uuid().describe(
|
|
1432
|
+
"ID of the access control system that contains the `acs_user`."
|
|
1433
|
+
),
|
|
1430
1434
|
hid_acs_system_id: zod.z.string().uuid().optional(),
|
|
1431
|
-
workspace_id: zod.z.string().uuid()
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1435
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
1436
|
+
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`."
|
|
1437
|
+
),
|
|
1438
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the `acs_user` was created."),
|
|
1439
|
+
display_name: zod.z.string().describe("Display name for the `acs_user`."),
|
|
1440
|
+
external_type: acs_user_external_type.optional().describe("Brand-specific terminology for the `acs_user` type."),
|
|
1441
|
+
external_type_display_name: zod.z.string().optional().describe(
|
|
1442
|
+
"Display name that corresponds to the brand-specific terminology for the `acs_user` type."
|
|
1443
|
+
),
|
|
1444
|
+
is_suspended: zod.z.boolean().describe(
|
|
1445
|
+
"Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users)."
|
|
1446
|
+
),
|
|
1447
|
+
access_schedule: schedule.optional().describe(
|
|
1448
|
+
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access."
|
|
1449
|
+
),
|
|
1450
|
+
user_identity_id: zod.z.string().optional().describe("ID of the user identity associated with the `acs_user`."),
|
|
1451
|
+
user_identity_full_name: zod.z.string().nullable().optional().describe(
|
|
1452
|
+
"Full name of the user identity associated with the `acs_user`."
|
|
1453
|
+
),
|
|
1454
|
+
user_identity_email_address: zod.z.string().nullable().optional().describe(
|
|
1455
|
+
"Email address of the user identity associated with the `acs_user`."
|
|
1456
|
+
),
|
|
1457
|
+
user_identity_phone_number: zod.z.string().nullable().optional().describe(
|
|
1458
|
+
"Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`)."
|
|
1459
|
+
),
|
|
1460
|
+
latest_desired_state_synced_with_provider_at: zod.z.string().datetime().optional().describe(`
|
|
1461
|
+
---
|
|
1462
|
+
undocumented: Only used internally.
|
|
1463
|
+
---
|
|
1464
|
+
`),
|
|
1465
|
+
is_latest_desired_state_synced_with_provider: zod.z.boolean().optional().describe(`
|
|
1466
|
+
---
|
|
1467
|
+
undocumented: Only used internally.
|
|
1468
|
+
---
|
|
1469
|
+
`),
|
|
1470
|
+
warnings: zod.z.array(acs_users_warnings).describe("Warnings associated with the `acs_user`."),
|
|
1471
|
+
errors: zod.z.array(acs_user_errors).describe("Errors associated with the `acs_user`.")
|
|
1446
1472
|
}).merge(user_fields);
|
|
1447
1473
|
var acs_user = common_acs_user.merge(
|
|
1448
1474
|
zod.z.object({
|
|
@@ -3050,6 +3076,7 @@ var openapi_default = {
|
|
|
3050
3076
|
acs_user: {
|
|
3051
3077
|
properties: {
|
|
3052
3078
|
access_schedule: {
|
|
3079
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
3053
3080
|
properties: {
|
|
3054
3081
|
ends_at: { format: "date-time", type: "string" },
|
|
3055
3082
|
starts_at: { format: "date-time", type: "string" }
|
|
@@ -3057,18 +3084,38 @@ var openapi_default = {
|
|
|
3057
3084
|
required: ["starts_at", "ends_at"],
|
|
3058
3085
|
type: "object"
|
|
3059
3086
|
},
|
|
3060
|
-
acs_system_id: {
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3087
|
+
acs_system_id: {
|
|
3088
|
+
description: "ID of the access control system that contains the `acs_user`.",
|
|
3089
|
+
format: "uuid",
|
|
3090
|
+
type: "string"
|
|
3091
|
+
},
|
|
3092
|
+
acs_user_id: {
|
|
3093
|
+
description: "ID of the `acs_user`.",
|
|
3094
|
+
format: "uuid",
|
|
3095
|
+
type: "string"
|
|
3096
|
+
},
|
|
3097
|
+
created_at: {
|
|
3098
|
+
description: "Date and time at which the `acs_user` was created.",
|
|
3099
|
+
format: "date-time",
|
|
3100
|
+
type: "string"
|
|
3101
|
+
},
|
|
3102
|
+
display_name: {
|
|
3103
|
+
description: "Display name for the `acs_user`.",
|
|
3104
|
+
type: "string"
|
|
3105
|
+
},
|
|
3064
3106
|
email: {
|
|
3065
3107
|
deprecated: true,
|
|
3066
3108
|
format: "email",
|
|
3067
3109
|
type: "string",
|
|
3068
3110
|
"x-deprecated": "use email_address."
|
|
3069
3111
|
},
|
|
3070
|
-
email_address: {
|
|
3112
|
+
email_address: {
|
|
3113
|
+
description: "Email address of the `acs_user`.",
|
|
3114
|
+
format: "email",
|
|
3115
|
+
type: "string"
|
|
3116
|
+
},
|
|
3071
3117
|
errors: {
|
|
3118
|
+
description: "Errors associated with the `acs_user`.",
|
|
3072
3119
|
items: {
|
|
3073
3120
|
description: "Error associated with the `acs_user`.",
|
|
3074
3121
|
oneOf: [
|
|
@@ -3177,6 +3224,7 @@ var openapi_default = {
|
|
|
3177
3224
|
type: "array"
|
|
3178
3225
|
},
|
|
3179
3226
|
external_type: {
|
|
3227
|
+
description: "Brand-specific terminology for the `acs_user` type.",
|
|
3180
3228
|
enum: [
|
|
3181
3229
|
"pti_user",
|
|
3182
3230
|
"brivo_user",
|
|
@@ -3186,22 +3234,54 @@ var openapi_default = {
|
|
|
3186
3234
|
],
|
|
3187
3235
|
type: "string"
|
|
3188
3236
|
},
|
|
3189
|
-
external_type_display_name: {
|
|
3190
|
-
|
|
3237
|
+
external_type_display_name: {
|
|
3238
|
+
description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
|
|
3239
|
+
type: "string"
|
|
3240
|
+
},
|
|
3241
|
+
full_name: {
|
|
3242
|
+
description: "Full name of the `acs_user`.",
|
|
3243
|
+
type: "string"
|
|
3244
|
+
},
|
|
3191
3245
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
3192
|
-
is_latest_desired_state_synced_with_provider: {
|
|
3246
|
+
is_latest_desired_state_synced_with_provider: {
|
|
3247
|
+
type: "boolean",
|
|
3248
|
+
"x-undocumented": "Only used internally."
|
|
3249
|
+
},
|
|
3193
3250
|
is_managed: { enum: [true], type: "boolean" },
|
|
3194
|
-
is_suspended: {
|
|
3251
|
+
is_suspended: {
|
|
3252
|
+
description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
3253
|
+
type: "boolean"
|
|
3254
|
+
},
|
|
3195
3255
|
latest_desired_state_synced_with_provider_at: {
|
|
3196
3256
|
format: "date-time",
|
|
3257
|
+
type: "string",
|
|
3258
|
+
"x-undocumented": "Only used internally."
|
|
3259
|
+
},
|
|
3260
|
+
phone_number: {
|
|
3261
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
3262
|
+
type: "string"
|
|
3263
|
+
},
|
|
3264
|
+
user_identity_email_address: {
|
|
3265
|
+
description: "Email address of the user identity associated with the `acs_user`.",
|
|
3266
|
+
nullable: true,
|
|
3267
|
+
type: "string"
|
|
3268
|
+
},
|
|
3269
|
+
user_identity_full_name: {
|
|
3270
|
+
description: "Full name of the user identity associated with the `acs_user`.",
|
|
3271
|
+
nullable: true,
|
|
3272
|
+
type: "string"
|
|
3273
|
+
},
|
|
3274
|
+
user_identity_id: {
|
|
3275
|
+
description: "ID of the user identity associated with the `acs_user`.",
|
|
3276
|
+
type: "string"
|
|
3277
|
+
},
|
|
3278
|
+
user_identity_phone_number: {
|
|
3279
|
+
description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
3280
|
+
nullable: true,
|
|
3197
3281
|
type: "string"
|
|
3198
3282
|
},
|
|
3199
|
-
phone_number: { type: "string" },
|
|
3200
|
-
user_identity_email_address: { nullable: true, type: "string" },
|
|
3201
|
-
user_identity_full_name: { nullable: true, type: "string" },
|
|
3202
|
-
user_identity_id: { type: "string" },
|
|
3203
|
-
user_identity_phone_number: { nullable: true, type: "string" },
|
|
3204
3283
|
warnings: {
|
|
3284
|
+
description: "Warnings associated with the `acs_user`.",
|
|
3205
3285
|
items: {
|
|
3206
3286
|
description: "Warning associated with the `acs_user`.",
|
|
3207
3287
|
oneOf: [
|
|
@@ -3232,7 +3312,11 @@ var openapi_default = {
|
|
|
3232
3312
|
},
|
|
3233
3313
|
type: "array"
|
|
3234
3314
|
},
|
|
3235
|
-
workspace_id: {
|
|
3315
|
+
workspace_id: {
|
|
3316
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
|
|
3317
|
+
format: "uuid",
|
|
3318
|
+
type: "string"
|
|
3319
|
+
}
|
|
3236
3320
|
},
|
|
3237
3321
|
required: [
|
|
3238
3322
|
"acs_user_id",
|
|
@@ -9761,14 +9845,23 @@ var openapi_default = {
|
|
|
9761
9845
|
},
|
|
9762
9846
|
"/acs/users/add_to_access_group": {
|
|
9763
9847
|
post: {
|
|
9848
|
+
description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
9764
9849
|
operationId: "acsUsersAddToAccessGroupPost",
|
|
9765
9850
|
requestBody: {
|
|
9766
9851
|
content: {
|
|
9767
9852
|
"application/json": {
|
|
9768
9853
|
schema: {
|
|
9769
9854
|
properties: {
|
|
9770
|
-
acs_access_group_id: {
|
|
9771
|
-
|
|
9855
|
+
acs_access_group_id: {
|
|
9856
|
+
description: "ID of the desired access group.",
|
|
9857
|
+
format: "uuid",
|
|
9858
|
+
type: "string"
|
|
9859
|
+
},
|
|
9860
|
+
acs_user_id: {
|
|
9861
|
+
description: "ID of the desired `acs_user`.",
|
|
9862
|
+
format: "uuid",
|
|
9863
|
+
type: "string"
|
|
9864
|
+
}
|
|
9772
9865
|
},
|
|
9773
9866
|
required: ["acs_user_id", "acs_access_group_id"],
|
|
9774
9867
|
type: "object"
|
|
@@ -9800,17 +9893,27 @@ var openapi_default = {
|
|
|
9800
9893
|
summary: "/acs/users/add_to_access_group",
|
|
9801
9894
|
tags: ["/acs"],
|
|
9802
9895
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
9803
|
-
"x-fern-sdk-method-name": "add_to_access_group"
|
|
9896
|
+
"x-fern-sdk-method-name": "add_to_access_group",
|
|
9897
|
+
"x-title": "Add an ACS User to an Access Group"
|
|
9804
9898
|
},
|
|
9805
9899
|
put: {
|
|
9900
|
+
description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
9806
9901
|
operationId: "acsUsersAddToAccessGroupPut",
|
|
9807
9902
|
requestBody: {
|
|
9808
9903
|
content: {
|
|
9809
9904
|
"application/json": {
|
|
9810
9905
|
schema: {
|
|
9811
9906
|
properties: {
|
|
9812
|
-
acs_access_group_id: {
|
|
9813
|
-
|
|
9907
|
+
acs_access_group_id: {
|
|
9908
|
+
description: "ID of the desired access group.",
|
|
9909
|
+
format: "uuid",
|
|
9910
|
+
type: "string"
|
|
9911
|
+
},
|
|
9912
|
+
acs_user_id: {
|
|
9913
|
+
description: "ID of the desired `acs_user`.",
|
|
9914
|
+
format: "uuid",
|
|
9915
|
+
type: "string"
|
|
9916
|
+
}
|
|
9814
9917
|
},
|
|
9815
9918
|
required: ["acs_user_id", "acs_access_group_id"],
|
|
9816
9919
|
type: "object"
|
|
@@ -9841,11 +9944,13 @@ var openapi_default = {
|
|
|
9841
9944
|
],
|
|
9842
9945
|
summary: "/acs/users/add_to_access_group",
|
|
9843
9946
|
tags: ["/acs"],
|
|
9844
|
-
"x-fern-ignore": true
|
|
9947
|
+
"x-fern-ignore": true,
|
|
9948
|
+
"x-title": "Add an ACS User to an Access Group"
|
|
9845
9949
|
}
|
|
9846
9950
|
},
|
|
9847
9951
|
"/acs/users/create": {
|
|
9848
9952
|
post: {
|
|
9953
|
+
description: "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
9849
9954
|
operationId: "acsUsersCreatePost",
|
|
9850
9955
|
requestBody: {
|
|
9851
9956
|
content: {
|
|
@@ -9853,6 +9958,7 @@ var openapi_default = {
|
|
|
9853
9958
|
schema: {
|
|
9854
9959
|
properties: {
|
|
9855
9960
|
access_schedule: {
|
|
9961
|
+
description: "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
|
|
9856
9962
|
properties: {
|
|
9857
9963
|
ends_at: { format: "date-time", type: "string" },
|
|
9858
9964
|
starts_at: { format: "date-time", type: "string" }
|
|
@@ -9862,20 +9968,39 @@ var openapi_default = {
|
|
|
9862
9968
|
},
|
|
9863
9969
|
acs_access_group_ids: {
|
|
9864
9970
|
default: [],
|
|
9971
|
+
description: "Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.",
|
|
9865
9972
|
items: { format: "uuid", type: "string" },
|
|
9866
9973
|
type: "array"
|
|
9867
9974
|
},
|
|
9868
|
-
acs_system_id: {
|
|
9975
|
+
acs_system_id: {
|
|
9976
|
+
description: "ID of the `acs_system` to which to add the new `acs_user`.",
|
|
9977
|
+
format: "uuid",
|
|
9978
|
+
type: "string"
|
|
9979
|
+
},
|
|
9869
9980
|
email: {
|
|
9870
9981
|
deprecated: true,
|
|
9871
9982
|
format: "email",
|
|
9872
9983
|
type: "string",
|
|
9873
9984
|
"x-deprecated": "use email_address."
|
|
9874
9985
|
},
|
|
9875
|
-
email_address: {
|
|
9876
|
-
|
|
9877
|
-
|
|
9878
|
-
|
|
9986
|
+
email_address: {
|
|
9987
|
+
description: "Email address of the `acs_user`.",
|
|
9988
|
+
format: "email",
|
|
9989
|
+
type: "string"
|
|
9990
|
+
},
|
|
9991
|
+
full_name: {
|
|
9992
|
+
description: "Full name of the `acs_user`.",
|
|
9993
|
+
type: "string"
|
|
9994
|
+
},
|
|
9995
|
+
phone_number: {
|
|
9996
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
9997
|
+
type: "string"
|
|
9998
|
+
},
|
|
9999
|
+
user_identity_id: {
|
|
10000
|
+
description: "ID of the user identity with which to associate the new `acs_user`.",
|
|
10001
|
+
format: "uuid",
|
|
10002
|
+
type: "string"
|
|
10003
|
+
}
|
|
9879
10004
|
},
|
|
9880
10005
|
required: ["acs_system_id"],
|
|
9881
10006
|
type: "object"
|
|
@@ -9911,17 +10036,26 @@ var openapi_default = {
|
|
|
9911
10036
|
tags: ["/acs"],
|
|
9912
10037
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
9913
10038
|
"x-fern-sdk-method-name": "create",
|
|
9914
|
-
"x-fern-sdk-return-value": "acs_user"
|
|
10039
|
+
"x-fern-sdk-return-value": "acs_user",
|
|
10040
|
+
"x-response-key": "acs_user",
|
|
10041
|
+
"x-title": "Create an ACS User"
|
|
9915
10042
|
}
|
|
9916
10043
|
},
|
|
9917
10044
|
"/acs/users/delete": {
|
|
9918
10045
|
post: {
|
|
10046
|
+
description: "Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
9919
10047
|
operationId: "acsUsersDeletePost",
|
|
9920
10048
|
requestBody: {
|
|
9921
10049
|
content: {
|
|
9922
10050
|
"application/json": {
|
|
9923
10051
|
schema: {
|
|
9924
|
-
properties: {
|
|
10052
|
+
properties: {
|
|
10053
|
+
acs_user_id: {
|
|
10054
|
+
description: "ID of the desired `acs_user`.",
|
|
10055
|
+
format: "uuid",
|
|
10056
|
+
type: "string"
|
|
10057
|
+
}
|
|
10058
|
+
},
|
|
9925
10059
|
required: ["acs_user_id"],
|
|
9926
10060
|
type: "object"
|
|
9927
10061
|
}
|
|
@@ -9952,17 +10086,25 @@ var openapi_default = {
|
|
|
9952
10086
|
summary: "/acs/users/delete",
|
|
9953
10087
|
tags: ["/acs"],
|
|
9954
10088
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
9955
|
-
"x-fern-sdk-method-name": "delete"
|
|
10089
|
+
"x-fern-sdk-method-name": "delete",
|
|
10090
|
+
"x-title": "Delete an ACS User"
|
|
9956
10091
|
}
|
|
9957
10092
|
},
|
|
9958
10093
|
"/acs/users/get": {
|
|
9959
10094
|
post: {
|
|
10095
|
+
description: "Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
9960
10096
|
operationId: "acsUsersGetPost",
|
|
9961
10097
|
requestBody: {
|
|
9962
10098
|
content: {
|
|
9963
10099
|
"application/json": {
|
|
9964
10100
|
schema: {
|
|
9965
|
-
properties: {
|
|
10101
|
+
properties: {
|
|
10102
|
+
acs_user_id: {
|
|
10103
|
+
description: "ID of the desired `acs_user`.",
|
|
10104
|
+
format: "uuid",
|
|
10105
|
+
type: "string"
|
|
10106
|
+
}
|
|
10107
|
+
},
|
|
9966
10108
|
required: ["acs_user_id"],
|
|
9967
10109
|
type: "object"
|
|
9968
10110
|
}
|
|
@@ -9997,23 +10139,40 @@ var openapi_default = {
|
|
|
9997
10139
|
tags: ["/acs"],
|
|
9998
10140
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
9999
10141
|
"x-fern-sdk-method-name": "get",
|
|
10000
|
-
"x-fern-sdk-return-value": "acs_user"
|
|
10142
|
+
"x-fern-sdk-return-value": "acs_user",
|
|
10143
|
+
"x-response-key": "acs_user",
|
|
10144
|
+
"x-title": "Get an ACS User"
|
|
10001
10145
|
}
|
|
10002
10146
|
},
|
|
10003
10147
|
"/acs/users/list": {
|
|
10004
10148
|
post: {
|
|
10149
|
+
description: "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10005
10150
|
operationId: "acsUsersListPost",
|
|
10006
10151
|
requestBody: {
|
|
10007
10152
|
content: {
|
|
10008
10153
|
"application/json": {
|
|
10009
10154
|
schema: {
|
|
10010
10155
|
properties: {
|
|
10011
|
-
acs_system_id: {
|
|
10156
|
+
acs_system_id: {
|
|
10157
|
+
description: "ID of the `acs_system` for which you want to retrieve all `acs_user`s.",
|
|
10158
|
+
format: "uuid",
|
|
10159
|
+
type: "string"
|
|
10160
|
+
},
|
|
10012
10161
|
created_before: { format: "date-time", type: "string" },
|
|
10013
10162
|
limit: { default: 500, format: "float", type: "number" },
|
|
10014
|
-
user_identity_email_address: {
|
|
10015
|
-
|
|
10016
|
-
|
|
10163
|
+
user_identity_email_address: {
|
|
10164
|
+
description: "Email address of the user identity for which you want to retrieve all `acs_user`s.",
|
|
10165
|
+
type: "string"
|
|
10166
|
+
},
|
|
10167
|
+
user_identity_id: {
|
|
10168
|
+
description: "ID of the user identity for which you want to retrieve all `acs_user`s.",
|
|
10169
|
+
format: "uuid",
|
|
10170
|
+
type: "string"
|
|
10171
|
+
},
|
|
10172
|
+
user_identity_phone_number: {
|
|
10173
|
+
description: "Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).",
|
|
10174
|
+
type: "string"
|
|
10175
|
+
}
|
|
10017
10176
|
},
|
|
10018
10177
|
type: "object"
|
|
10019
10178
|
}
|
|
@@ -10052,17 +10211,26 @@ var openapi_default = {
|
|
|
10052
10211
|
tags: ["/acs"],
|
|
10053
10212
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10054
10213
|
"x-fern-sdk-method-name": "list",
|
|
10055
|
-
"x-fern-sdk-return-value": "acs_users"
|
|
10214
|
+
"x-fern-sdk-return-value": "acs_users",
|
|
10215
|
+
"x-response-key": "acs_users",
|
|
10216
|
+
"x-title": "List ACS Users"
|
|
10056
10217
|
}
|
|
10057
10218
|
},
|
|
10058
10219
|
"/acs/users/list_accessible_entrances": {
|
|
10059
10220
|
post: {
|
|
10221
|
+
description: "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.",
|
|
10060
10222
|
operationId: "acsUsersListAccessibleEntrancesPost",
|
|
10061
10223
|
requestBody: {
|
|
10062
10224
|
content: {
|
|
10063
10225
|
"application/json": {
|
|
10064
10226
|
schema: {
|
|
10065
|
-
properties: {
|
|
10227
|
+
properties: {
|
|
10228
|
+
acs_user_id: {
|
|
10229
|
+
description: "ID of the desired `acs_user`.",
|
|
10230
|
+
format: "uuid",
|
|
10231
|
+
type: "string"
|
|
10232
|
+
}
|
|
10233
|
+
},
|
|
10066
10234
|
required: ["acs_user_id"],
|
|
10067
10235
|
type: "object"
|
|
10068
10236
|
}
|
|
@@ -10101,19 +10269,30 @@ var openapi_default = {
|
|
|
10101
10269
|
tags: ["/acs"],
|
|
10102
10270
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10103
10271
|
"x-fern-sdk-method-name": "list_accessible_entrances",
|
|
10104
|
-
"x-fern-sdk-return-value": "acs_entrances"
|
|
10272
|
+
"x-fern-sdk-return-value": "acs_entrances",
|
|
10273
|
+
"x-response-key": "acs_entrances",
|
|
10274
|
+
"x-title": "List ACS User-Accessible Entrances"
|
|
10105
10275
|
}
|
|
10106
10276
|
},
|
|
10107
10277
|
"/acs/users/remove_from_access_group": {
|
|
10108
10278
|
post: {
|
|
10279
|
+
description: "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
10109
10280
|
operationId: "acsUsersRemoveFromAccessGroupPost",
|
|
10110
10281
|
requestBody: {
|
|
10111
10282
|
content: {
|
|
10112
10283
|
"application/json": {
|
|
10113
10284
|
schema: {
|
|
10114
10285
|
properties: {
|
|
10115
|
-
acs_access_group_id: {
|
|
10116
|
-
|
|
10286
|
+
acs_access_group_id: {
|
|
10287
|
+
description: "ID of the desired access group.",
|
|
10288
|
+
format: "uuid",
|
|
10289
|
+
type: "string"
|
|
10290
|
+
},
|
|
10291
|
+
acs_user_id: {
|
|
10292
|
+
description: "ID of the desired `acs_user`.",
|
|
10293
|
+
format: "uuid",
|
|
10294
|
+
type: "string"
|
|
10295
|
+
}
|
|
10117
10296
|
},
|
|
10118
10297
|
required: ["acs_user_id", "acs_access_group_id"],
|
|
10119
10298
|
type: "object"
|
|
@@ -10145,17 +10324,25 @@ var openapi_default = {
|
|
|
10145
10324
|
summary: "/acs/users/remove_from_access_group",
|
|
10146
10325
|
tags: ["/acs"],
|
|
10147
10326
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10148
|
-
"x-fern-sdk-method-name": "remove_from_access_group"
|
|
10327
|
+
"x-fern-sdk-method-name": "remove_from_access_group",
|
|
10328
|
+
"x-title": "Remove an ACS User from an Access Group"
|
|
10149
10329
|
}
|
|
10150
10330
|
},
|
|
10151
10331
|
"/acs/users/revoke_access_to_all_entrances": {
|
|
10152
10332
|
post: {
|
|
10333
|
+
description: "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10153
10334
|
operationId: "acsUsersRevokeAccessToAllEntrancesPost",
|
|
10154
10335
|
requestBody: {
|
|
10155
10336
|
content: {
|
|
10156
10337
|
"application/json": {
|
|
10157
10338
|
schema: {
|
|
10158
|
-
properties: {
|
|
10339
|
+
properties: {
|
|
10340
|
+
acs_user_id: {
|
|
10341
|
+
description: "ID of the desired `acs_user`.",
|
|
10342
|
+
format: "uuid",
|
|
10343
|
+
type: "string"
|
|
10344
|
+
}
|
|
10345
|
+
},
|
|
10159
10346
|
required: ["acs_user_id"],
|
|
10160
10347
|
type: "object"
|
|
10161
10348
|
}
|
|
@@ -10186,17 +10373,25 @@ var openapi_default = {
|
|
|
10186
10373
|
summary: "/acs/users/revoke_access_to_all_entrances",
|
|
10187
10374
|
tags: ["/acs"],
|
|
10188
10375
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10189
|
-
"x-fern-sdk-method-name": "revoke_access_to_all_entrances"
|
|
10376
|
+
"x-fern-sdk-method-name": "revoke_access_to_all_entrances",
|
|
10377
|
+
"x-title": "Revoke ACS User Access to All Entrances"
|
|
10190
10378
|
}
|
|
10191
10379
|
},
|
|
10192
10380
|
"/acs/users/suspend": {
|
|
10193
10381
|
post: {
|
|
10382
|
+
description: "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.",
|
|
10194
10383
|
operationId: "acsUsersSuspendPost",
|
|
10195
10384
|
requestBody: {
|
|
10196
10385
|
content: {
|
|
10197
10386
|
"application/json": {
|
|
10198
10387
|
schema: {
|
|
10199
|
-
properties: {
|
|
10388
|
+
properties: {
|
|
10389
|
+
acs_user_id: {
|
|
10390
|
+
description: "ID of the desired `acs_user`.",
|
|
10391
|
+
format: "uuid",
|
|
10392
|
+
type: "string"
|
|
10393
|
+
}
|
|
10394
|
+
},
|
|
10200
10395
|
required: ["acs_user_id"],
|
|
10201
10396
|
type: "object"
|
|
10202
10397
|
}
|
|
@@ -10227,7 +10422,8 @@ var openapi_default = {
|
|
|
10227
10422
|
summary: "/acs/users/suspend",
|
|
10228
10423
|
tags: ["/acs"],
|
|
10229
10424
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10230
|
-
"x-fern-sdk-method-name": "suspend"
|
|
10425
|
+
"x-fern-sdk-method-name": "suspend",
|
|
10426
|
+
"x-title": "Suspend an ACS User"
|
|
10231
10427
|
}
|
|
10232
10428
|
},
|
|
10233
10429
|
"/acs/users/unmanaged/get": {
|
|
@@ -10253,20 +10449,46 @@ var openapi_default = {
|
|
|
10253
10449
|
acs_user: {
|
|
10254
10450
|
properties: {
|
|
10255
10451
|
access_schedule: {
|
|
10256
|
-
|
|
10452
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10453
|
+
properties: {
|
|
10454
|
+
ends_at: { format: "date-time", type: "string" },
|
|
10455
|
+
starts_at: { format: "date-time", type: "string" }
|
|
10456
|
+
},
|
|
10457
|
+
required: ["starts_at", "ends_at"],
|
|
10458
|
+
type: "object"
|
|
10459
|
+
},
|
|
10460
|
+
acs_system_id: {
|
|
10461
|
+
description: "ID of the access control system that contains the `acs_user`.",
|
|
10462
|
+
format: "uuid",
|
|
10463
|
+
type: "string"
|
|
10464
|
+
},
|
|
10465
|
+
acs_user_id: {
|
|
10466
|
+
description: "ID of the `acs_user`.",
|
|
10467
|
+
format: "uuid",
|
|
10468
|
+
type: "string"
|
|
10469
|
+
},
|
|
10470
|
+
created_at: {
|
|
10471
|
+
description: "Date and time at which the `acs_user` was created.",
|
|
10472
|
+
format: "date-time",
|
|
10473
|
+
type: "string"
|
|
10474
|
+
},
|
|
10475
|
+
display_name: {
|
|
10476
|
+
description: "Display name for the `acs_user`.",
|
|
10477
|
+
type: "string"
|
|
10257
10478
|
},
|
|
10258
|
-
acs_system_id: { format: "uuid", type: "string" },
|
|
10259
|
-
acs_user_id: { format: "uuid", type: "string" },
|
|
10260
|
-
created_at: { format: "date-time", type: "string" },
|
|
10261
|
-
display_name: { type: "string" },
|
|
10262
10479
|
email: {
|
|
10263
10480
|
deprecated: true,
|
|
10264
10481
|
format: "email",
|
|
10265
10482
|
type: "string",
|
|
10266
10483
|
"x-deprecated": "use email_address."
|
|
10267
10484
|
},
|
|
10268
|
-
email_address: {
|
|
10485
|
+
email_address: {
|
|
10486
|
+
description: "Email address of the `acs_user`.",
|
|
10487
|
+
format: "email",
|
|
10488
|
+
type: "string"
|
|
10489
|
+
},
|
|
10269
10490
|
errors: {
|
|
10491
|
+
description: "Errors associated with the `acs_user`.",
|
|
10270
10492
|
items: {
|
|
10271
10493
|
description: "Error associated with the `acs_user`.",
|
|
10272
10494
|
oneOf: [
|
|
@@ -10397,6 +10619,7 @@ var openapi_default = {
|
|
|
10397
10619
|
type: "array"
|
|
10398
10620
|
},
|
|
10399
10621
|
external_type: {
|
|
10622
|
+
description: "Brand-specific terminology for the `acs_user` type.",
|
|
10400
10623
|
enum: [
|
|
10401
10624
|
"pti_user",
|
|
10402
10625
|
"brivo_user",
|
|
@@ -10406,33 +10629,54 @@ var openapi_default = {
|
|
|
10406
10629
|
],
|
|
10407
10630
|
type: "string"
|
|
10408
10631
|
},
|
|
10409
|
-
external_type_display_name: {
|
|
10410
|
-
|
|
10632
|
+
external_type_display_name: {
|
|
10633
|
+
description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
|
|
10634
|
+
type: "string"
|
|
10635
|
+
},
|
|
10636
|
+
full_name: {
|
|
10637
|
+
description: "Full name of the `acs_user`.",
|
|
10638
|
+
type: "string"
|
|
10639
|
+
},
|
|
10411
10640
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
10412
10641
|
is_latest_desired_state_synced_with_provider: {
|
|
10413
|
-
type: "boolean"
|
|
10642
|
+
type: "boolean",
|
|
10643
|
+
"x-undocumented": "Only used internally."
|
|
10414
10644
|
},
|
|
10415
10645
|
is_managed: { enum: [false], type: "boolean" },
|
|
10416
|
-
is_suspended: {
|
|
10646
|
+
is_suspended: {
|
|
10647
|
+
description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
10648
|
+
type: "boolean"
|
|
10649
|
+
},
|
|
10417
10650
|
latest_desired_state_synced_with_provider_at: {
|
|
10418
10651
|
format: "date-time",
|
|
10652
|
+
type: "string",
|
|
10653
|
+
"x-undocumented": "Only used internally."
|
|
10654
|
+
},
|
|
10655
|
+
phone_number: {
|
|
10656
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10419
10657
|
type: "string"
|
|
10420
10658
|
},
|
|
10421
|
-
phone_number: { type: "string" },
|
|
10422
10659
|
user_identity_email_address: {
|
|
10660
|
+
description: "Email address of the user identity associated with the `acs_user`.",
|
|
10423
10661
|
nullable: true,
|
|
10424
10662
|
type: "string"
|
|
10425
10663
|
},
|
|
10426
10664
|
user_identity_full_name: {
|
|
10665
|
+
description: "Full name of the user identity associated with the `acs_user`.",
|
|
10427
10666
|
nullable: true,
|
|
10428
10667
|
type: "string"
|
|
10429
10668
|
},
|
|
10430
|
-
user_identity_id: {
|
|
10669
|
+
user_identity_id: {
|
|
10670
|
+
description: "ID of the user identity associated with the `acs_user`.",
|
|
10671
|
+
type: "string"
|
|
10672
|
+
},
|
|
10431
10673
|
user_identity_phone_number: {
|
|
10674
|
+
description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10432
10675
|
nullable: true,
|
|
10433
10676
|
type: "string"
|
|
10434
10677
|
},
|
|
10435
10678
|
warnings: {
|
|
10679
|
+
description: "Warnings associated with the `acs_user`.",
|
|
10436
10680
|
items: {
|
|
10437
10681
|
description: "Warning associated with the `acs_user`.",
|
|
10438
10682
|
oneOf: [
|
|
@@ -10480,7 +10724,11 @@ var openapi_default = {
|
|
|
10480
10724
|
},
|
|
10481
10725
|
type: "array"
|
|
10482
10726
|
},
|
|
10483
|
-
workspace_id: {
|
|
10727
|
+
workspace_id: {
|
|
10728
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
|
|
10729
|
+
format: "uuid",
|
|
10730
|
+
type: "string"
|
|
10731
|
+
}
|
|
10484
10732
|
},
|
|
10485
10733
|
required: [
|
|
10486
10734
|
"acs_user_id",
|
|
@@ -10549,20 +10797,49 @@ var openapi_default = {
|
|
|
10549
10797
|
items: {
|
|
10550
10798
|
properties: {
|
|
10551
10799
|
access_schedule: {
|
|
10552
|
-
|
|
10800
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
10801
|
+
properties: {
|
|
10802
|
+
ends_at: { format: "date-time", type: "string" },
|
|
10803
|
+
starts_at: {
|
|
10804
|
+
format: "date-time",
|
|
10805
|
+
type: "string"
|
|
10806
|
+
}
|
|
10807
|
+
},
|
|
10808
|
+
required: ["starts_at", "ends_at"],
|
|
10809
|
+
type: "object"
|
|
10810
|
+
},
|
|
10811
|
+
acs_system_id: {
|
|
10812
|
+
description: "ID of the access control system that contains the `acs_user`.",
|
|
10813
|
+
format: "uuid",
|
|
10814
|
+
type: "string"
|
|
10815
|
+
},
|
|
10816
|
+
acs_user_id: {
|
|
10817
|
+
description: "ID of the `acs_user`.",
|
|
10818
|
+
format: "uuid",
|
|
10819
|
+
type: "string"
|
|
10820
|
+
},
|
|
10821
|
+
created_at: {
|
|
10822
|
+
description: "Date and time at which the `acs_user` was created.",
|
|
10823
|
+
format: "date-time",
|
|
10824
|
+
type: "string"
|
|
10825
|
+
},
|
|
10826
|
+
display_name: {
|
|
10827
|
+
description: "Display name for the `acs_user`.",
|
|
10828
|
+
type: "string"
|
|
10553
10829
|
},
|
|
10554
|
-
acs_system_id: { format: "uuid", type: "string" },
|
|
10555
|
-
acs_user_id: { format: "uuid", type: "string" },
|
|
10556
|
-
created_at: { format: "date-time", type: "string" },
|
|
10557
|
-
display_name: { type: "string" },
|
|
10558
10830
|
email: {
|
|
10559
10831
|
deprecated: true,
|
|
10560
10832
|
format: "email",
|
|
10561
10833
|
type: "string",
|
|
10562
10834
|
"x-deprecated": "use email_address."
|
|
10563
10835
|
},
|
|
10564
|
-
email_address: {
|
|
10836
|
+
email_address: {
|
|
10837
|
+
description: "Email address of the `acs_user`.",
|
|
10838
|
+
format: "email",
|
|
10839
|
+
type: "string"
|
|
10840
|
+
},
|
|
10565
10841
|
errors: {
|
|
10842
|
+
description: "Errors associated with the `acs_user`.",
|
|
10566
10843
|
items: {
|
|
10567
10844
|
description: "Error associated with the `acs_user`.",
|
|
10568
10845
|
oneOf: [
|
|
@@ -10693,6 +10970,7 @@ var openapi_default = {
|
|
|
10693
10970
|
type: "array"
|
|
10694
10971
|
},
|
|
10695
10972
|
external_type: {
|
|
10973
|
+
description: "Brand-specific terminology for the `acs_user` type.",
|
|
10696
10974
|
enum: [
|
|
10697
10975
|
"pti_user",
|
|
10698
10976
|
"brivo_user",
|
|
@@ -10702,33 +10980,54 @@ var openapi_default = {
|
|
|
10702
10980
|
],
|
|
10703
10981
|
type: "string"
|
|
10704
10982
|
},
|
|
10705
|
-
external_type_display_name: {
|
|
10706
|
-
|
|
10983
|
+
external_type_display_name: {
|
|
10984
|
+
description: "Display name that corresponds to the brand-specific terminology for the `acs_user` type.",
|
|
10985
|
+
type: "string"
|
|
10986
|
+
},
|
|
10987
|
+
full_name: {
|
|
10988
|
+
description: "Full name of the `acs_user`.",
|
|
10989
|
+
type: "string"
|
|
10990
|
+
},
|
|
10707
10991
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
10708
10992
|
is_latest_desired_state_synced_with_provider: {
|
|
10709
|
-
type: "boolean"
|
|
10993
|
+
type: "boolean",
|
|
10994
|
+
"x-undocumented": "Only used internally."
|
|
10710
10995
|
},
|
|
10711
10996
|
is_managed: { enum: [false], type: "boolean" },
|
|
10712
|
-
is_suspended: {
|
|
10997
|
+
is_suspended: {
|
|
10998
|
+
description: "Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).",
|
|
10999
|
+
type: "boolean"
|
|
11000
|
+
},
|
|
10713
11001
|
latest_desired_state_synced_with_provider_at: {
|
|
10714
11002
|
format: "date-time",
|
|
11003
|
+
type: "string",
|
|
11004
|
+
"x-undocumented": "Only used internally."
|
|
11005
|
+
},
|
|
11006
|
+
phone_number: {
|
|
11007
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10715
11008
|
type: "string"
|
|
10716
11009
|
},
|
|
10717
|
-
phone_number: { type: "string" },
|
|
10718
11010
|
user_identity_email_address: {
|
|
11011
|
+
description: "Email address of the user identity associated with the `acs_user`.",
|
|
10719
11012
|
nullable: true,
|
|
10720
11013
|
type: "string"
|
|
10721
11014
|
},
|
|
10722
11015
|
user_identity_full_name: {
|
|
11016
|
+
description: "Full name of the user identity associated with the `acs_user`.",
|
|
10723
11017
|
nullable: true,
|
|
10724
11018
|
type: "string"
|
|
10725
11019
|
},
|
|
10726
|
-
user_identity_id: {
|
|
11020
|
+
user_identity_id: {
|
|
11021
|
+
description: "ID of the user identity associated with the `acs_user`.",
|
|
11022
|
+
type: "string"
|
|
11023
|
+
},
|
|
10727
11024
|
user_identity_phone_number: {
|
|
11025
|
+
description: "Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
10728
11026
|
nullable: true,
|
|
10729
11027
|
type: "string"
|
|
10730
11028
|
},
|
|
10731
11029
|
warnings: {
|
|
11030
|
+
description: "Warnings associated with the `acs_user`.",
|
|
10732
11031
|
items: {
|
|
10733
11032
|
description: "Warning associated with the `acs_user`.",
|
|
10734
11033
|
oneOf: [
|
|
@@ -10776,7 +11075,11 @@ var openapi_default = {
|
|
|
10776
11075
|
},
|
|
10777
11076
|
type: "array"
|
|
10778
11077
|
},
|
|
10779
|
-
workspace_id: {
|
|
11078
|
+
workspace_id: {
|
|
11079
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.",
|
|
11080
|
+
format: "uuid",
|
|
11081
|
+
type: "string"
|
|
11082
|
+
}
|
|
10780
11083
|
},
|
|
10781
11084
|
required: [
|
|
10782
11085
|
"acs_user_id",
|
|
@@ -10820,12 +11123,19 @@ var openapi_default = {
|
|
|
10820
11123
|
},
|
|
10821
11124
|
"/acs/users/unsuspend": {
|
|
10822
11125
|
post: {
|
|
11126
|
+
description: "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.",
|
|
10823
11127
|
operationId: "acsUsersUnsuspendPost",
|
|
10824
11128
|
requestBody: {
|
|
10825
11129
|
content: {
|
|
10826
11130
|
"application/json": {
|
|
10827
11131
|
schema: {
|
|
10828
|
-
properties: {
|
|
11132
|
+
properties: {
|
|
11133
|
+
acs_user_id: {
|
|
11134
|
+
description: "ID of the desired `acs_user`.",
|
|
11135
|
+
format: "uuid",
|
|
11136
|
+
type: "string"
|
|
11137
|
+
}
|
|
11138
|
+
},
|
|
10829
11139
|
required: ["acs_user_id"],
|
|
10830
11140
|
type: "object"
|
|
10831
11141
|
}
|
|
@@ -10856,11 +11166,13 @@ var openapi_default = {
|
|
|
10856
11166
|
summary: "/acs/users/unsuspend",
|
|
10857
11167
|
tags: ["/acs"],
|
|
10858
11168
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10859
|
-
"x-fern-sdk-method-name": "unsuspend"
|
|
11169
|
+
"x-fern-sdk-method-name": "unsuspend",
|
|
11170
|
+
"x-title": "Unsuspend an ACS User"
|
|
10860
11171
|
}
|
|
10861
11172
|
},
|
|
10862
11173
|
"/acs/users/update": {
|
|
10863
11174
|
patch: {
|
|
11175
|
+
description: "Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10864
11176
|
operationId: "acsUsersUpdatePatch",
|
|
10865
11177
|
requestBody: {
|
|
10866
11178
|
content: {
|
|
@@ -10868,6 +11180,7 @@ var openapi_default = {
|
|
|
10868
11180
|
schema: {
|
|
10869
11181
|
properties: {
|
|
10870
11182
|
access_schedule: {
|
|
11183
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
|
|
10871
11184
|
nullable: true,
|
|
10872
11185
|
properties: {
|
|
10873
11186
|
ends_at: { format: "date-time", type: "string" },
|
|
@@ -10876,17 +11189,31 @@ var openapi_default = {
|
|
|
10876
11189
|
required: ["starts_at", "ends_at"],
|
|
10877
11190
|
type: "object"
|
|
10878
11191
|
},
|
|
10879
|
-
acs_user_id: {
|
|
11192
|
+
acs_user_id: {
|
|
11193
|
+
description: "ID of the `acs_user`.",
|
|
11194
|
+
format: "uuid",
|
|
11195
|
+
type: "string"
|
|
11196
|
+
},
|
|
10880
11197
|
email: {
|
|
10881
11198
|
deprecated: true,
|
|
10882
11199
|
format: "email",
|
|
10883
11200
|
type: "string",
|
|
10884
11201
|
"x-deprecated": "use email_address."
|
|
10885
11202
|
},
|
|
10886
|
-
email_address: {
|
|
10887
|
-
|
|
11203
|
+
email_address: {
|
|
11204
|
+
description: "Email address of the `acs_user`.",
|
|
11205
|
+
format: "email",
|
|
11206
|
+
type: "string"
|
|
11207
|
+
},
|
|
11208
|
+
full_name: {
|
|
11209
|
+
description: "Full name of the `acs_user`.",
|
|
11210
|
+
type: "string"
|
|
11211
|
+
},
|
|
10888
11212
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
10889
|
-
phone_number: {
|
|
11213
|
+
phone_number: {
|
|
11214
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
11215
|
+
type: "string"
|
|
11216
|
+
}
|
|
10890
11217
|
},
|
|
10891
11218
|
required: ["acs_user_id"],
|
|
10892
11219
|
type: "object"
|
|
@@ -10917,9 +11244,11 @@ var openapi_default = {
|
|
|
10917
11244
|
],
|
|
10918
11245
|
summary: "/acs/users/update",
|
|
10919
11246
|
tags: ["/acs"],
|
|
10920
|
-
"x-fern-ignore": true
|
|
11247
|
+
"x-fern-ignore": true,
|
|
11248
|
+
"x-title": "Update an ACS User"
|
|
10921
11249
|
},
|
|
10922
11250
|
post: {
|
|
11251
|
+
description: "Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10923
11252
|
operationId: "acsUsersUpdatePost",
|
|
10924
11253
|
requestBody: {
|
|
10925
11254
|
content: {
|
|
@@ -10927,6 +11256,7 @@ var openapi_default = {
|
|
|
10927
11256
|
schema: {
|
|
10928
11257
|
properties: {
|
|
10929
11258
|
access_schedule: {
|
|
11259
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems.",
|
|
10930
11260
|
nullable: true,
|
|
10931
11261
|
properties: {
|
|
10932
11262
|
ends_at: { format: "date-time", type: "string" },
|
|
@@ -10935,17 +11265,31 @@ var openapi_default = {
|
|
|
10935
11265
|
required: ["starts_at", "ends_at"],
|
|
10936
11266
|
type: "object"
|
|
10937
11267
|
},
|
|
10938
|
-
acs_user_id: {
|
|
11268
|
+
acs_user_id: {
|
|
11269
|
+
description: "ID of the `acs_user`.",
|
|
11270
|
+
format: "uuid",
|
|
11271
|
+
type: "string"
|
|
11272
|
+
},
|
|
10939
11273
|
email: {
|
|
10940
11274
|
deprecated: true,
|
|
10941
11275
|
format: "email",
|
|
10942
11276
|
type: "string",
|
|
10943
11277
|
"x-deprecated": "use email_address."
|
|
10944
11278
|
},
|
|
10945
|
-
email_address: {
|
|
10946
|
-
|
|
11279
|
+
email_address: {
|
|
11280
|
+
description: "Email address of the `acs_user`.",
|
|
11281
|
+
format: "email",
|
|
11282
|
+
type: "string"
|
|
11283
|
+
},
|
|
11284
|
+
full_name: {
|
|
11285
|
+
description: "Full name of the `acs_user`.",
|
|
11286
|
+
type: "string"
|
|
11287
|
+
},
|
|
10947
11288
|
hid_acs_system_id: { format: "uuid", type: "string" },
|
|
10948
|
-
phone_number: {
|
|
11289
|
+
phone_number: {
|
|
11290
|
+
description: "Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).",
|
|
11291
|
+
type: "string"
|
|
11292
|
+
}
|
|
10949
11293
|
},
|
|
10950
11294
|
required: ["acs_user_id"],
|
|
10951
11295
|
type: "object"
|
|
@@ -10977,7 +11321,8 @@ var openapi_default = {
|
|
|
10977
11321
|
summary: "/acs/users/update",
|
|
10978
11322
|
tags: ["/acs"],
|
|
10979
11323
|
"x-fern-sdk-group-name": ["acs", "users"],
|
|
10980
|
-
"x-fern-sdk-method-name": "update"
|
|
11324
|
+
"x-fern-sdk-method-name": "update",
|
|
11325
|
+
"x-title": "Update an ACS User"
|
|
10981
11326
|
}
|
|
10982
11327
|
},
|
|
10983
11328
|
"/action_attempts/get": {
|