@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
|
@@ -686,6 +686,7 @@ export default {
|
|
|
686
686
|
acs_user: {
|
|
687
687
|
properties: {
|
|
688
688
|
access_schedule: {
|
|
689
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
689
690
|
properties: {
|
|
690
691
|
ends_at: { format: 'date-time', type: 'string' },
|
|
691
692
|
starts_at: { format: 'date-time', type: 'string' },
|
|
@@ -693,18 +694,38 @@ export default {
|
|
|
693
694
|
required: ['starts_at', 'ends_at'],
|
|
694
695
|
type: 'object',
|
|
695
696
|
},
|
|
696
|
-
acs_system_id: {
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
697
|
+
acs_system_id: {
|
|
698
|
+
description: 'ID of the access control system that contains the `acs_user`.',
|
|
699
|
+
format: 'uuid',
|
|
700
|
+
type: 'string',
|
|
701
|
+
},
|
|
702
|
+
acs_user_id: {
|
|
703
|
+
description: 'ID of the `acs_user`.',
|
|
704
|
+
format: 'uuid',
|
|
705
|
+
type: 'string',
|
|
706
|
+
},
|
|
707
|
+
created_at: {
|
|
708
|
+
description: 'Date and time at which the `acs_user` was created.',
|
|
709
|
+
format: 'date-time',
|
|
710
|
+
type: 'string',
|
|
711
|
+
},
|
|
712
|
+
display_name: {
|
|
713
|
+
description: 'Display name for the `acs_user`.',
|
|
714
|
+
type: 'string',
|
|
715
|
+
},
|
|
700
716
|
email: {
|
|
701
717
|
deprecated: true,
|
|
702
718
|
format: 'email',
|
|
703
719
|
type: 'string',
|
|
704
720
|
'x-deprecated': 'use email_address.',
|
|
705
721
|
},
|
|
706
|
-
email_address: {
|
|
722
|
+
email_address: {
|
|
723
|
+
description: 'Email address of the `acs_user`.',
|
|
724
|
+
format: 'email',
|
|
725
|
+
type: 'string',
|
|
726
|
+
},
|
|
707
727
|
errors: {
|
|
728
|
+
description: 'Errors associated with the `acs_user`.',
|
|
708
729
|
items: {
|
|
709
730
|
description: 'Error associated with the `acs_user`.',
|
|
710
731
|
oneOf: [
|
|
@@ -813,6 +834,7 @@ export default {
|
|
|
813
834
|
type: 'array',
|
|
814
835
|
},
|
|
815
836
|
external_type: {
|
|
837
|
+
description: 'Brand-specific terminology for the `acs_user` type.',
|
|
816
838
|
enum: [
|
|
817
839
|
'pti_user',
|
|
818
840
|
'brivo_user',
|
|
@@ -822,22 +844,54 @@ export default {
|
|
|
822
844
|
],
|
|
823
845
|
type: 'string',
|
|
824
846
|
},
|
|
825
|
-
external_type_display_name: {
|
|
826
|
-
|
|
847
|
+
external_type_display_name: {
|
|
848
|
+
description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
|
|
849
|
+
type: 'string',
|
|
850
|
+
},
|
|
851
|
+
full_name: {
|
|
852
|
+
description: 'Full name of the `acs_user`.',
|
|
853
|
+
type: 'string',
|
|
854
|
+
},
|
|
827
855
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
828
|
-
is_latest_desired_state_synced_with_provider: {
|
|
856
|
+
is_latest_desired_state_synced_with_provider: {
|
|
857
|
+
type: 'boolean',
|
|
858
|
+
'x-undocumented': 'Only used internally.',
|
|
859
|
+
},
|
|
829
860
|
is_managed: { enum: [true], type: 'boolean' },
|
|
830
|
-
is_suspended: {
|
|
861
|
+
is_suspended: {
|
|
862
|
+
description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
863
|
+
type: 'boolean',
|
|
864
|
+
},
|
|
831
865
|
latest_desired_state_synced_with_provider_at: {
|
|
832
866
|
format: 'date-time',
|
|
833
867
|
type: 'string',
|
|
868
|
+
'x-undocumented': 'Only used internally.',
|
|
869
|
+
},
|
|
870
|
+
phone_number: {
|
|
871
|
+
description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
872
|
+
type: 'string',
|
|
873
|
+
},
|
|
874
|
+
user_identity_email_address: {
|
|
875
|
+
description: 'Email address of the user identity associated with the `acs_user`.',
|
|
876
|
+
nullable: true,
|
|
877
|
+
type: 'string',
|
|
878
|
+
},
|
|
879
|
+
user_identity_full_name: {
|
|
880
|
+
description: 'Full name of the user identity associated with the `acs_user`.',
|
|
881
|
+
nullable: true,
|
|
882
|
+
type: 'string',
|
|
883
|
+
},
|
|
884
|
+
user_identity_id: {
|
|
885
|
+
description: 'ID of the user identity associated with the `acs_user`.',
|
|
886
|
+
type: 'string',
|
|
887
|
+
},
|
|
888
|
+
user_identity_phone_number: {
|
|
889
|
+
description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
890
|
+
nullable: true,
|
|
891
|
+
type: 'string',
|
|
834
892
|
},
|
|
835
|
-
phone_number: { type: 'string' },
|
|
836
|
-
user_identity_email_address: { nullable: true, type: 'string' },
|
|
837
|
-
user_identity_full_name: { nullable: true, type: 'string' },
|
|
838
|
-
user_identity_id: { type: 'string' },
|
|
839
|
-
user_identity_phone_number: { nullable: true, type: 'string' },
|
|
840
893
|
warnings: {
|
|
894
|
+
description: 'Warnings associated with the `acs_user`.',
|
|
841
895
|
items: {
|
|
842
896
|
description: 'Warning associated with the `acs_user`.',
|
|
843
897
|
oneOf: [
|
|
@@ -868,7 +922,11 @@ export default {
|
|
|
868
922
|
},
|
|
869
923
|
type: 'array',
|
|
870
924
|
},
|
|
871
|
-
workspace_id: {
|
|
925
|
+
workspace_id: {
|
|
926
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
|
|
927
|
+
format: 'uuid',
|
|
928
|
+
type: 'string',
|
|
929
|
+
},
|
|
872
930
|
},
|
|
873
931
|
required: [
|
|
874
932
|
'acs_user_id',
|
|
@@ -7397,14 +7455,23 @@ export default {
|
|
|
7397
7455
|
},
|
|
7398
7456
|
'/acs/users/add_to_access_group': {
|
|
7399
7457
|
post: {
|
|
7458
|
+
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).',
|
|
7400
7459
|
operationId: 'acsUsersAddToAccessGroupPost',
|
|
7401
7460
|
requestBody: {
|
|
7402
7461
|
content: {
|
|
7403
7462
|
'application/json': {
|
|
7404
7463
|
schema: {
|
|
7405
7464
|
properties: {
|
|
7406
|
-
acs_access_group_id: {
|
|
7407
|
-
|
|
7465
|
+
acs_access_group_id: {
|
|
7466
|
+
description: 'ID of the desired access group.',
|
|
7467
|
+
format: 'uuid',
|
|
7468
|
+
type: 'string',
|
|
7469
|
+
},
|
|
7470
|
+
acs_user_id: {
|
|
7471
|
+
description: 'ID of the desired `acs_user`.',
|
|
7472
|
+
format: 'uuid',
|
|
7473
|
+
type: 'string',
|
|
7474
|
+
},
|
|
7408
7475
|
},
|
|
7409
7476
|
required: ['acs_user_id', 'acs_access_group_id'],
|
|
7410
7477
|
type: 'object',
|
|
@@ -7437,16 +7504,26 @@ export default {
|
|
|
7437
7504
|
tags: ['/acs'],
|
|
7438
7505
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7439
7506
|
'x-fern-sdk-method-name': 'add_to_access_group',
|
|
7507
|
+
'x-title': 'Add an ACS User to an Access Group',
|
|
7440
7508
|
},
|
|
7441
7509
|
put: {
|
|
7510
|
+
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).',
|
|
7442
7511
|
operationId: 'acsUsersAddToAccessGroupPut',
|
|
7443
7512
|
requestBody: {
|
|
7444
7513
|
content: {
|
|
7445
7514
|
'application/json': {
|
|
7446
7515
|
schema: {
|
|
7447
7516
|
properties: {
|
|
7448
|
-
acs_access_group_id: {
|
|
7449
|
-
|
|
7517
|
+
acs_access_group_id: {
|
|
7518
|
+
description: 'ID of the desired access group.',
|
|
7519
|
+
format: 'uuid',
|
|
7520
|
+
type: 'string',
|
|
7521
|
+
},
|
|
7522
|
+
acs_user_id: {
|
|
7523
|
+
description: 'ID of the desired `acs_user`.',
|
|
7524
|
+
format: 'uuid',
|
|
7525
|
+
type: 'string',
|
|
7526
|
+
},
|
|
7450
7527
|
},
|
|
7451
7528
|
required: ['acs_user_id', 'acs_access_group_id'],
|
|
7452
7529
|
type: 'object',
|
|
@@ -7478,10 +7555,12 @@ export default {
|
|
|
7478
7555
|
summary: '/acs/users/add_to_access_group',
|
|
7479
7556
|
tags: ['/acs'],
|
|
7480
7557
|
'x-fern-ignore': true,
|
|
7558
|
+
'x-title': 'Add an ACS User to an Access Group',
|
|
7481
7559
|
},
|
|
7482
7560
|
},
|
|
7483
7561
|
'/acs/users/create': {
|
|
7484
7562
|
post: {
|
|
7563
|
+
description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7485
7564
|
operationId: 'acsUsersCreatePost',
|
|
7486
7565
|
requestBody: {
|
|
7487
7566
|
content: {
|
|
@@ -7489,6 +7568,7 @@ export default {
|
|
|
7489
7568
|
schema: {
|
|
7490
7569
|
properties: {
|
|
7491
7570
|
access_schedule: {
|
|
7571
|
+
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.",
|
|
7492
7572
|
properties: {
|
|
7493
7573
|
ends_at: { format: 'date-time', type: 'string' },
|
|
7494
7574
|
starts_at: { format: 'date-time', type: 'string' },
|
|
@@ -7498,20 +7578,39 @@ export default {
|
|
|
7498
7578
|
},
|
|
7499
7579
|
acs_access_group_ids: {
|
|
7500
7580
|
default: [],
|
|
7581
|
+
description: 'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.',
|
|
7501
7582
|
items: { format: 'uuid', type: 'string' },
|
|
7502
7583
|
type: 'array',
|
|
7503
7584
|
},
|
|
7504
|
-
acs_system_id: {
|
|
7585
|
+
acs_system_id: {
|
|
7586
|
+
description: 'ID of the `acs_system` to which to add the new `acs_user`.',
|
|
7587
|
+
format: 'uuid',
|
|
7588
|
+
type: 'string',
|
|
7589
|
+
},
|
|
7505
7590
|
email: {
|
|
7506
7591
|
deprecated: true,
|
|
7507
7592
|
format: 'email',
|
|
7508
7593
|
type: 'string',
|
|
7509
7594
|
'x-deprecated': 'use email_address.',
|
|
7510
7595
|
},
|
|
7511
|
-
email_address: {
|
|
7512
|
-
|
|
7513
|
-
|
|
7514
|
-
|
|
7596
|
+
email_address: {
|
|
7597
|
+
description: 'Email address of the `acs_user`.',
|
|
7598
|
+
format: 'email',
|
|
7599
|
+
type: 'string',
|
|
7600
|
+
},
|
|
7601
|
+
full_name: {
|
|
7602
|
+
description: 'Full name of the `acs_user`.',
|
|
7603
|
+
type: 'string',
|
|
7604
|
+
},
|
|
7605
|
+
phone_number: {
|
|
7606
|
+
description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
7607
|
+
type: 'string',
|
|
7608
|
+
},
|
|
7609
|
+
user_identity_id: {
|
|
7610
|
+
description: 'ID of the user identity with which to associate the new `acs_user`.',
|
|
7611
|
+
format: 'uuid',
|
|
7612
|
+
type: 'string',
|
|
7613
|
+
},
|
|
7515
7614
|
},
|
|
7516
7615
|
required: ['acs_system_id'],
|
|
7517
7616
|
type: 'object',
|
|
@@ -7548,16 +7647,25 @@ export default {
|
|
|
7548
7647
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7549
7648
|
'x-fern-sdk-method-name': 'create',
|
|
7550
7649
|
'x-fern-sdk-return-value': 'acs_user',
|
|
7650
|
+
'x-response-key': 'acs_user',
|
|
7651
|
+
'x-title': 'Create an ACS User',
|
|
7551
7652
|
},
|
|
7552
7653
|
},
|
|
7553
7654
|
'/acs/users/delete': {
|
|
7554
7655
|
post: {
|
|
7656
|
+
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).",
|
|
7555
7657
|
operationId: 'acsUsersDeletePost',
|
|
7556
7658
|
requestBody: {
|
|
7557
7659
|
content: {
|
|
7558
7660
|
'application/json': {
|
|
7559
7661
|
schema: {
|
|
7560
|
-
properties: {
|
|
7662
|
+
properties: {
|
|
7663
|
+
acs_user_id: {
|
|
7664
|
+
description: 'ID of the desired `acs_user`.',
|
|
7665
|
+
format: 'uuid',
|
|
7666
|
+
type: 'string',
|
|
7667
|
+
},
|
|
7668
|
+
},
|
|
7561
7669
|
required: ['acs_user_id'],
|
|
7562
7670
|
type: 'object',
|
|
7563
7671
|
},
|
|
@@ -7589,16 +7697,24 @@ export default {
|
|
|
7589
7697
|
tags: ['/acs'],
|
|
7590
7698
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7591
7699
|
'x-fern-sdk-method-name': 'delete',
|
|
7700
|
+
'x-title': 'Delete an ACS User',
|
|
7592
7701
|
},
|
|
7593
7702
|
},
|
|
7594
7703
|
'/acs/users/get': {
|
|
7595
7704
|
post: {
|
|
7705
|
+
description: 'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7596
7706
|
operationId: 'acsUsersGetPost',
|
|
7597
7707
|
requestBody: {
|
|
7598
7708
|
content: {
|
|
7599
7709
|
'application/json': {
|
|
7600
7710
|
schema: {
|
|
7601
|
-
properties: {
|
|
7711
|
+
properties: {
|
|
7712
|
+
acs_user_id: {
|
|
7713
|
+
description: 'ID of the desired `acs_user`.',
|
|
7714
|
+
format: 'uuid',
|
|
7715
|
+
type: 'string',
|
|
7716
|
+
},
|
|
7717
|
+
},
|
|
7602
7718
|
required: ['acs_user_id'],
|
|
7603
7719
|
type: 'object',
|
|
7604
7720
|
},
|
|
@@ -7634,22 +7750,39 @@ export default {
|
|
|
7634
7750
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7635
7751
|
'x-fern-sdk-method-name': 'get',
|
|
7636
7752
|
'x-fern-sdk-return-value': 'acs_user',
|
|
7753
|
+
'x-response-key': 'acs_user',
|
|
7754
|
+
'x-title': 'Get an ACS User',
|
|
7637
7755
|
},
|
|
7638
7756
|
},
|
|
7639
7757
|
'/acs/users/list': {
|
|
7640
7758
|
post: {
|
|
7759
|
+
description: 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7641
7760
|
operationId: 'acsUsersListPost',
|
|
7642
7761
|
requestBody: {
|
|
7643
7762
|
content: {
|
|
7644
7763
|
'application/json': {
|
|
7645
7764
|
schema: {
|
|
7646
7765
|
properties: {
|
|
7647
|
-
acs_system_id: {
|
|
7766
|
+
acs_system_id: {
|
|
7767
|
+
description: 'ID of the `acs_system` for which you want to retrieve all `acs_user`s.',
|
|
7768
|
+
format: 'uuid',
|
|
7769
|
+
type: 'string',
|
|
7770
|
+
},
|
|
7648
7771
|
created_before: { format: 'date-time', type: 'string' },
|
|
7649
7772
|
limit: { default: 500, format: 'float', type: 'number' },
|
|
7650
|
-
user_identity_email_address: {
|
|
7651
|
-
|
|
7652
|
-
|
|
7773
|
+
user_identity_email_address: {
|
|
7774
|
+
description: 'Email address of the user identity for which you want to retrieve all `acs_user`s.',
|
|
7775
|
+
type: 'string',
|
|
7776
|
+
},
|
|
7777
|
+
user_identity_id: {
|
|
7778
|
+
description: 'ID of the user identity for which you want to retrieve all `acs_user`s.',
|
|
7779
|
+
format: 'uuid',
|
|
7780
|
+
type: 'string',
|
|
7781
|
+
},
|
|
7782
|
+
user_identity_phone_number: {
|
|
7783
|
+
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`).',
|
|
7784
|
+
type: 'string',
|
|
7785
|
+
},
|
|
7653
7786
|
},
|
|
7654
7787
|
type: 'object',
|
|
7655
7788
|
},
|
|
@@ -7689,16 +7822,25 @@ export default {
|
|
|
7689
7822
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7690
7823
|
'x-fern-sdk-method-name': 'list',
|
|
7691
7824
|
'x-fern-sdk-return-value': 'acs_users',
|
|
7825
|
+
'x-response-key': 'acs_users',
|
|
7826
|
+
'x-title': 'List ACS Users',
|
|
7692
7827
|
},
|
|
7693
7828
|
},
|
|
7694
7829
|
'/acs/users/list_accessible_entrances': {
|
|
7695
7830
|
post: {
|
|
7831
|
+
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.',
|
|
7696
7832
|
operationId: 'acsUsersListAccessibleEntrancesPost',
|
|
7697
7833
|
requestBody: {
|
|
7698
7834
|
content: {
|
|
7699
7835
|
'application/json': {
|
|
7700
7836
|
schema: {
|
|
7701
|
-
properties: {
|
|
7837
|
+
properties: {
|
|
7838
|
+
acs_user_id: {
|
|
7839
|
+
description: 'ID of the desired `acs_user`.',
|
|
7840
|
+
format: 'uuid',
|
|
7841
|
+
type: 'string',
|
|
7842
|
+
},
|
|
7843
|
+
},
|
|
7702
7844
|
required: ['acs_user_id'],
|
|
7703
7845
|
type: 'object',
|
|
7704
7846
|
},
|
|
@@ -7738,18 +7880,29 @@ export default {
|
|
|
7738
7880
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7739
7881
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
7740
7882
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
7883
|
+
'x-response-key': 'acs_entrances',
|
|
7884
|
+
'x-title': 'List ACS User-Accessible Entrances',
|
|
7741
7885
|
},
|
|
7742
7886
|
},
|
|
7743
7887
|
'/acs/users/remove_from_access_group': {
|
|
7744
7888
|
post: {
|
|
7889
|
+
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).',
|
|
7745
7890
|
operationId: 'acsUsersRemoveFromAccessGroupPost',
|
|
7746
7891
|
requestBody: {
|
|
7747
7892
|
content: {
|
|
7748
7893
|
'application/json': {
|
|
7749
7894
|
schema: {
|
|
7750
7895
|
properties: {
|
|
7751
|
-
acs_access_group_id: {
|
|
7752
|
-
|
|
7896
|
+
acs_access_group_id: {
|
|
7897
|
+
description: 'ID of the desired access group.',
|
|
7898
|
+
format: 'uuid',
|
|
7899
|
+
type: 'string',
|
|
7900
|
+
},
|
|
7901
|
+
acs_user_id: {
|
|
7902
|
+
description: 'ID of the desired `acs_user`.',
|
|
7903
|
+
format: 'uuid',
|
|
7904
|
+
type: 'string',
|
|
7905
|
+
},
|
|
7753
7906
|
},
|
|
7754
7907
|
required: ['acs_user_id', 'acs_access_group_id'],
|
|
7755
7908
|
type: 'object',
|
|
@@ -7782,16 +7935,24 @@ export default {
|
|
|
7782
7935
|
tags: ['/acs'],
|
|
7783
7936
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7784
7937
|
'x-fern-sdk-method-name': 'remove_from_access_group',
|
|
7938
|
+
'x-title': 'Remove an ACS User from an Access Group',
|
|
7785
7939
|
},
|
|
7786
7940
|
},
|
|
7787
7941
|
'/acs/users/revoke_access_to_all_entrances': {
|
|
7788
7942
|
post: {
|
|
7943
|
+
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).',
|
|
7789
7944
|
operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
|
|
7790
7945
|
requestBody: {
|
|
7791
7946
|
content: {
|
|
7792
7947
|
'application/json': {
|
|
7793
7948
|
schema: {
|
|
7794
|
-
properties: {
|
|
7949
|
+
properties: {
|
|
7950
|
+
acs_user_id: {
|
|
7951
|
+
description: 'ID of the desired `acs_user`.',
|
|
7952
|
+
format: 'uuid',
|
|
7953
|
+
type: 'string',
|
|
7954
|
+
},
|
|
7955
|
+
},
|
|
7795
7956
|
required: ['acs_user_id'],
|
|
7796
7957
|
type: 'object',
|
|
7797
7958
|
},
|
|
@@ -7823,16 +7984,24 @@ export default {
|
|
|
7823
7984
|
tags: ['/acs'],
|
|
7824
7985
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7825
7986
|
'x-fern-sdk-method-name': 'revoke_access_to_all_entrances',
|
|
7987
|
+
'x-title': 'Revoke ACS User Access to All Entrances',
|
|
7826
7988
|
},
|
|
7827
7989
|
},
|
|
7828
7990
|
'/acs/users/suspend': {
|
|
7829
7991
|
post: {
|
|
7992
|
+
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.",
|
|
7830
7993
|
operationId: 'acsUsersSuspendPost',
|
|
7831
7994
|
requestBody: {
|
|
7832
7995
|
content: {
|
|
7833
7996
|
'application/json': {
|
|
7834
7997
|
schema: {
|
|
7835
|
-
properties: {
|
|
7998
|
+
properties: {
|
|
7999
|
+
acs_user_id: {
|
|
8000
|
+
description: 'ID of the desired `acs_user`.',
|
|
8001
|
+
format: 'uuid',
|
|
8002
|
+
type: 'string',
|
|
8003
|
+
},
|
|
8004
|
+
},
|
|
7836
8005
|
required: ['acs_user_id'],
|
|
7837
8006
|
type: 'object',
|
|
7838
8007
|
},
|
|
@@ -7864,6 +8033,7 @@ export default {
|
|
|
7864
8033
|
tags: ['/acs'],
|
|
7865
8034
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7866
8035
|
'x-fern-sdk-method-name': 'suspend',
|
|
8036
|
+
'x-title': 'Suspend an ACS User',
|
|
7867
8037
|
},
|
|
7868
8038
|
},
|
|
7869
8039
|
'/acs/users/unmanaged/get': {
|
|
@@ -7889,20 +8059,46 @@ export default {
|
|
|
7889
8059
|
acs_user: {
|
|
7890
8060
|
properties: {
|
|
7891
8061
|
access_schedule: {
|
|
7892
|
-
|
|
8062
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
8063
|
+
properties: {
|
|
8064
|
+
ends_at: { format: 'date-time', type: 'string' },
|
|
8065
|
+
starts_at: { format: 'date-time', type: 'string' },
|
|
8066
|
+
},
|
|
8067
|
+
required: ['starts_at', 'ends_at'],
|
|
8068
|
+
type: 'object',
|
|
8069
|
+
},
|
|
8070
|
+
acs_system_id: {
|
|
8071
|
+
description: 'ID of the access control system that contains the `acs_user`.',
|
|
8072
|
+
format: 'uuid',
|
|
8073
|
+
type: 'string',
|
|
8074
|
+
},
|
|
8075
|
+
acs_user_id: {
|
|
8076
|
+
description: 'ID of the `acs_user`.',
|
|
8077
|
+
format: 'uuid',
|
|
8078
|
+
type: 'string',
|
|
8079
|
+
},
|
|
8080
|
+
created_at: {
|
|
8081
|
+
description: 'Date and time at which the `acs_user` was created.',
|
|
8082
|
+
format: 'date-time',
|
|
8083
|
+
type: 'string',
|
|
8084
|
+
},
|
|
8085
|
+
display_name: {
|
|
8086
|
+
description: 'Display name for the `acs_user`.',
|
|
8087
|
+
type: 'string',
|
|
7893
8088
|
},
|
|
7894
|
-
acs_system_id: { format: 'uuid', type: 'string' },
|
|
7895
|
-
acs_user_id: { format: 'uuid', type: 'string' },
|
|
7896
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
7897
|
-
display_name: { type: 'string' },
|
|
7898
8089
|
email: {
|
|
7899
8090
|
deprecated: true,
|
|
7900
8091
|
format: 'email',
|
|
7901
8092
|
type: 'string',
|
|
7902
8093
|
'x-deprecated': 'use email_address.',
|
|
7903
8094
|
},
|
|
7904
|
-
email_address: {
|
|
8095
|
+
email_address: {
|
|
8096
|
+
description: 'Email address of the `acs_user`.',
|
|
8097
|
+
format: 'email',
|
|
8098
|
+
type: 'string',
|
|
8099
|
+
},
|
|
7905
8100
|
errors: {
|
|
8101
|
+
description: 'Errors associated with the `acs_user`.',
|
|
7906
8102
|
items: {
|
|
7907
8103
|
description: 'Error associated with the `acs_user`.',
|
|
7908
8104
|
oneOf: [
|
|
@@ -8033,6 +8229,7 @@ export default {
|
|
|
8033
8229
|
type: 'array',
|
|
8034
8230
|
},
|
|
8035
8231
|
external_type: {
|
|
8232
|
+
description: 'Brand-specific terminology for the `acs_user` type.',
|
|
8036
8233
|
enum: [
|
|
8037
8234
|
'pti_user',
|
|
8038
8235
|
'brivo_user',
|
|
@@ -8042,33 +8239,54 @@ export default {
|
|
|
8042
8239
|
],
|
|
8043
8240
|
type: 'string',
|
|
8044
8241
|
},
|
|
8045
|
-
external_type_display_name: {
|
|
8046
|
-
|
|
8242
|
+
external_type_display_name: {
|
|
8243
|
+
description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
|
|
8244
|
+
type: 'string',
|
|
8245
|
+
},
|
|
8246
|
+
full_name: {
|
|
8247
|
+
description: 'Full name of the `acs_user`.',
|
|
8248
|
+
type: 'string',
|
|
8249
|
+
},
|
|
8047
8250
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8048
8251
|
is_latest_desired_state_synced_with_provider: {
|
|
8049
8252
|
type: 'boolean',
|
|
8253
|
+
'x-undocumented': 'Only used internally.',
|
|
8050
8254
|
},
|
|
8051
8255
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8052
|
-
is_suspended: {
|
|
8256
|
+
is_suspended: {
|
|
8257
|
+
description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
8258
|
+
type: 'boolean',
|
|
8259
|
+
},
|
|
8053
8260
|
latest_desired_state_synced_with_provider_at: {
|
|
8054
8261
|
format: 'date-time',
|
|
8055
8262
|
type: 'string',
|
|
8263
|
+
'x-undocumented': 'Only used internally.',
|
|
8264
|
+
},
|
|
8265
|
+
phone_number: {
|
|
8266
|
+
description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8267
|
+
type: 'string',
|
|
8056
8268
|
},
|
|
8057
|
-
phone_number: { type: 'string' },
|
|
8058
8269
|
user_identity_email_address: {
|
|
8270
|
+
description: 'Email address of the user identity associated with the `acs_user`.',
|
|
8059
8271
|
nullable: true,
|
|
8060
8272
|
type: 'string',
|
|
8061
8273
|
},
|
|
8062
8274
|
user_identity_full_name: {
|
|
8275
|
+
description: 'Full name of the user identity associated with the `acs_user`.',
|
|
8063
8276
|
nullable: true,
|
|
8064
8277
|
type: 'string',
|
|
8065
8278
|
},
|
|
8066
|
-
user_identity_id: {
|
|
8279
|
+
user_identity_id: {
|
|
8280
|
+
description: 'ID of the user identity associated with the `acs_user`.',
|
|
8281
|
+
type: 'string',
|
|
8282
|
+
},
|
|
8067
8283
|
user_identity_phone_number: {
|
|
8284
|
+
description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8068
8285
|
nullable: true,
|
|
8069
8286
|
type: 'string',
|
|
8070
8287
|
},
|
|
8071
8288
|
warnings: {
|
|
8289
|
+
description: 'Warnings associated with the `acs_user`.',
|
|
8072
8290
|
items: {
|
|
8073
8291
|
description: 'Warning associated with the `acs_user`.',
|
|
8074
8292
|
oneOf: [
|
|
@@ -8116,7 +8334,11 @@ export default {
|
|
|
8116
8334
|
},
|
|
8117
8335
|
type: 'array',
|
|
8118
8336
|
},
|
|
8119
|
-
workspace_id: {
|
|
8337
|
+
workspace_id: {
|
|
8338
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
|
|
8339
|
+
format: 'uuid',
|
|
8340
|
+
type: 'string',
|
|
8341
|
+
},
|
|
8120
8342
|
},
|
|
8121
8343
|
required: [
|
|
8122
8344
|
'acs_user_id',
|
|
@@ -8185,20 +8407,49 @@ export default {
|
|
|
8185
8407
|
items: {
|
|
8186
8408
|
properties: {
|
|
8187
8409
|
access_schedule: {
|
|
8188
|
-
|
|
8410
|
+
description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
8411
|
+
properties: {
|
|
8412
|
+
ends_at: { format: 'date-time', type: 'string' },
|
|
8413
|
+
starts_at: {
|
|
8414
|
+
format: 'date-time',
|
|
8415
|
+
type: 'string',
|
|
8416
|
+
},
|
|
8417
|
+
},
|
|
8418
|
+
required: ['starts_at', 'ends_at'],
|
|
8419
|
+
type: 'object',
|
|
8420
|
+
},
|
|
8421
|
+
acs_system_id: {
|
|
8422
|
+
description: 'ID of the access control system that contains the `acs_user`.',
|
|
8423
|
+
format: 'uuid',
|
|
8424
|
+
type: 'string',
|
|
8425
|
+
},
|
|
8426
|
+
acs_user_id: {
|
|
8427
|
+
description: 'ID of the `acs_user`.',
|
|
8428
|
+
format: 'uuid',
|
|
8429
|
+
type: 'string',
|
|
8430
|
+
},
|
|
8431
|
+
created_at: {
|
|
8432
|
+
description: 'Date and time at which the `acs_user` was created.',
|
|
8433
|
+
format: 'date-time',
|
|
8434
|
+
type: 'string',
|
|
8435
|
+
},
|
|
8436
|
+
display_name: {
|
|
8437
|
+
description: 'Display name for the `acs_user`.',
|
|
8438
|
+
type: 'string',
|
|
8189
8439
|
},
|
|
8190
|
-
acs_system_id: { format: 'uuid', type: 'string' },
|
|
8191
|
-
acs_user_id: { format: 'uuid', type: 'string' },
|
|
8192
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
8193
|
-
display_name: { type: 'string' },
|
|
8194
8440
|
email: {
|
|
8195
8441
|
deprecated: true,
|
|
8196
8442
|
format: 'email',
|
|
8197
8443
|
type: 'string',
|
|
8198
8444
|
'x-deprecated': 'use email_address.',
|
|
8199
8445
|
},
|
|
8200
|
-
email_address: {
|
|
8446
|
+
email_address: {
|
|
8447
|
+
description: 'Email address of the `acs_user`.',
|
|
8448
|
+
format: 'email',
|
|
8449
|
+
type: 'string',
|
|
8450
|
+
},
|
|
8201
8451
|
errors: {
|
|
8452
|
+
description: 'Errors associated with the `acs_user`.',
|
|
8202
8453
|
items: {
|
|
8203
8454
|
description: 'Error associated with the `acs_user`.',
|
|
8204
8455
|
oneOf: [
|
|
@@ -8329,6 +8580,7 @@ export default {
|
|
|
8329
8580
|
type: 'array',
|
|
8330
8581
|
},
|
|
8331
8582
|
external_type: {
|
|
8583
|
+
description: 'Brand-specific terminology for the `acs_user` type.',
|
|
8332
8584
|
enum: [
|
|
8333
8585
|
'pti_user',
|
|
8334
8586
|
'brivo_user',
|
|
@@ -8338,33 +8590,54 @@ export default {
|
|
|
8338
8590
|
],
|
|
8339
8591
|
type: 'string',
|
|
8340
8592
|
},
|
|
8341
|
-
external_type_display_name: {
|
|
8342
|
-
|
|
8593
|
+
external_type_display_name: {
|
|
8594
|
+
description: 'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
|
|
8595
|
+
type: 'string',
|
|
8596
|
+
},
|
|
8597
|
+
full_name: {
|
|
8598
|
+
description: 'Full name of the `acs_user`.',
|
|
8599
|
+
type: 'string',
|
|
8600
|
+
},
|
|
8343
8601
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8344
8602
|
is_latest_desired_state_synced_with_provider: {
|
|
8345
8603
|
type: 'boolean',
|
|
8604
|
+
'x-undocumented': 'Only used internally.',
|
|
8346
8605
|
},
|
|
8347
8606
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8348
|
-
is_suspended: {
|
|
8607
|
+
is_suspended: {
|
|
8608
|
+
description: 'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
8609
|
+
type: 'boolean',
|
|
8610
|
+
},
|
|
8349
8611
|
latest_desired_state_synced_with_provider_at: {
|
|
8350
8612
|
format: 'date-time',
|
|
8351
8613
|
type: 'string',
|
|
8614
|
+
'x-undocumented': 'Only used internally.',
|
|
8615
|
+
},
|
|
8616
|
+
phone_number: {
|
|
8617
|
+
description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8618
|
+
type: 'string',
|
|
8352
8619
|
},
|
|
8353
|
-
phone_number: { type: 'string' },
|
|
8354
8620
|
user_identity_email_address: {
|
|
8621
|
+
description: 'Email address of the user identity associated with the `acs_user`.',
|
|
8355
8622
|
nullable: true,
|
|
8356
8623
|
type: 'string',
|
|
8357
8624
|
},
|
|
8358
8625
|
user_identity_full_name: {
|
|
8626
|
+
description: 'Full name of the user identity associated with the `acs_user`.',
|
|
8359
8627
|
nullable: true,
|
|
8360
8628
|
type: 'string',
|
|
8361
8629
|
},
|
|
8362
|
-
user_identity_id: {
|
|
8630
|
+
user_identity_id: {
|
|
8631
|
+
description: 'ID of the user identity associated with the `acs_user`.',
|
|
8632
|
+
type: 'string',
|
|
8633
|
+
},
|
|
8363
8634
|
user_identity_phone_number: {
|
|
8635
|
+
description: 'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8364
8636
|
nullable: true,
|
|
8365
8637
|
type: 'string',
|
|
8366
8638
|
},
|
|
8367
8639
|
warnings: {
|
|
8640
|
+
description: 'Warnings associated with the `acs_user`.',
|
|
8368
8641
|
items: {
|
|
8369
8642
|
description: 'Warning associated with the `acs_user`.',
|
|
8370
8643
|
oneOf: [
|
|
@@ -8412,7 +8685,11 @@ export default {
|
|
|
8412
8685
|
},
|
|
8413
8686
|
type: 'array',
|
|
8414
8687
|
},
|
|
8415
|
-
workspace_id: {
|
|
8688
|
+
workspace_id: {
|
|
8689
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
|
|
8690
|
+
format: 'uuid',
|
|
8691
|
+
type: 'string',
|
|
8692
|
+
},
|
|
8416
8693
|
},
|
|
8417
8694
|
required: [
|
|
8418
8695
|
'acs_user_id',
|
|
@@ -8456,12 +8733,19 @@ export default {
|
|
|
8456
8733
|
},
|
|
8457
8734
|
'/acs/users/unsuspend': {
|
|
8458
8735
|
post: {
|
|
8736
|
+
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.',
|
|
8459
8737
|
operationId: 'acsUsersUnsuspendPost',
|
|
8460
8738
|
requestBody: {
|
|
8461
8739
|
content: {
|
|
8462
8740
|
'application/json': {
|
|
8463
8741
|
schema: {
|
|
8464
|
-
properties: {
|
|
8742
|
+
properties: {
|
|
8743
|
+
acs_user_id: {
|
|
8744
|
+
description: 'ID of the desired `acs_user`.',
|
|
8745
|
+
format: 'uuid',
|
|
8746
|
+
type: 'string',
|
|
8747
|
+
},
|
|
8748
|
+
},
|
|
8465
8749
|
required: ['acs_user_id'],
|
|
8466
8750
|
type: 'object',
|
|
8467
8751
|
},
|
|
@@ -8493,10 +8777,12 @@ export default {
|
|
|
8493
8777
|
tags: ['/acs'],
|
|
8494
8778
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
8495
8779
|
'x-fern-sdk-method-name': 'unsuspend',
|
|
8780
|
+
'x-title': 'Unsuspend an ACS User',
|
|
8496
8781
|
},
|
|
8497
8782
|
},
|
|
8498
8783
|
'/acs/users/update': {
|
|
8499
8784
|
patch: {
|
|
8785
|
+
description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
8500
8786
|
operationId: 'acsUsersUpdatePatch',
|
|
8501
8787
|
requestBody: {
|
|
8502
8788
|
content: {
|
|
@@ -8504,6 +8790,7 @@ export default {
|
|
|
8504
8790
|
schema: {
|
|
8505
8791
|
properties: {
|
|
8506
8792
|
access_schedule: {
|
|
8793
|
+
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.",
|
|
8507
8794
|
nullable: true,
|
|
8508
8795
|
properties: {
|
|
8509
8796
|
ends_at: { format: 'date-time', type: 'string' },
|
|
@@ -8512,17 +8799,31 @@ export default {
|
|
|
8512
8799
|
required: ['starts_at', 'ends_at'],
|
|
8513
8800
|
type: 'object',
|
|
8514
8801
|
},
|
|
8515
|
-
acs_user_id: {
|
|
8802
|
+
acs_user_id: {
|
|
8803
|
+
description: 'ID of the `acs_user`.',
|
|
8804
|
+
format: 'uuid',
|
|
8805
|
+
type: 'string',
|
|
8806
|
+
},
|
|
8516
8807
|
email: {
|
|
8517
8808
|
deprecated: true,
|
|
8518
8809
|
format: 'email',
|
|
8519
8810
|
type: 'string',
|
|
8520
8811
|
'x-deprecated': 'use email_address.',
|
|
8521
8812
|
},
|
|
8522
|
-
email_address: {
|
|
8523
|
-
|
|
8813
|
+
email_address: {
|
|
8814
|
+
description: 'Email address of the `acs_user`.',
|
|
8815
|
+
format: 'email',
|
|
8816
|
+
type: 'string',
|
|
8817
|
+
},
|
|
8818
|
+
full_name: {
|
|
8819
|
+
description: 'Full name of the `acs_user`.',
|
|
8820
|
+
type: 'string',
|
|
8821
|
+
},
|
|
8524
8822
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8525
|
-
phone_number: {
|
|
8823
|
+
phone_number: {
|
|
8824
|
+
description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8825
|
+
type: 'string',
|
|
8826
|
+
},
|
|
8526
8827
|
},
|
|
8527
8828
|
required: ['acs_user_id'],
|
|
8528
8829
|
type: 'object',
|
|
@@ -8554,8 +8855,10 @@ export default {
|
|
|
8554
8855
|
summary: '/acs/users/update',
|
|
8555
8856
|
tags: ['/acs'],
|
|
8556
8857
|
'x-fern-ignore': true,
|
|
8858
|
+
'x-title': 'Update an ACS User',
|
|
8557
8859
|
},
|
|
8558
8860
|
post: {
|
|
8861
|
+
description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
8559
8862
|
operationId: 'acsUsersUpdatePost',
|
|
8560
8863
|
requestBody: {
|
|
8561
8864
|
content: {
|
|
@@ -8563,6 +8866,7 @@ export default {
|
|
|
8563
8866
|
schema: {
|
|
8564
8867
|
properties: {
|
|
8565
8868
|
access_schedule: {
|
|
8869
|
+
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.",
|
|
8566
8870
|
nullable: true,
|
|
8567
8871
|
properties: {
|
|
8568
8872
|
ends_at: { format: 'date-time', type: 'string' },
|
|
@@ -8571,17 +8875,31 @@ export default {
|
|
|
8571
8875
|
required: ['starts_at', 'ends_at'],
|
|
8572
8876
|
type: 'object',
|
|
8573
8877
|
},
|
|
8574
|
-
acs_user_id: {
|
|
8878
|
+
acs_user_id: {
|
|
8879
|
+
description: 'ID of the `acs_user`.',
|
|
8880
|
+
format: 'uuid',
|
|
8881
|
+
type: 'string',
|
|
8882
|
+
},
|
|
8575
8883
|
email: {
|
|
8576
8884
|
deprecated: true,
|
|
8577
8885
|
format: 'email',
|
|
8578
8886
|
type: 'string',
|
|
8579
8887
|
'x-deprecated': 'use email_address.',
|
|
8580
8888
|
},
|
|
8581
|
-
email_address: {
|
|
8582
|
-
|
|
8889
|
+
email_address: {
|
|
8890
|
+
description: 'Email address of the `acs_user`.',
|
|
8891
|
+
format: 'email',
|
|
8892
|
+
type: 'string',
|
|
8893
|
+
},
|
|
8894
|
+
full_name: {
|
|
8895
|
+
description: 'Full name of the `acs_user`.',
|
|
8896
|
+
type: 'string',
|
|
8897
|
+
},
|
|
8583
8898
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8584
|
-
phone_number: {
|
|
8899
|
+
phone_number: {
|
|
8900
|
+
description: 'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8901
|
+
type: 'string',
|
|
8902
|
+
},
|
|
8585
8903
|
},
|
|
8586
8904
|
required: ['acs_user_id'],
|
|
8587
8905
|
type: 'object',
|
|
@@ -8614,6 +8932,7 @@ export default {
|
|
|
8614
8932
|
tags: ['/acs'],
|
|
8615
8933
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
8616
8934
|
'x-fern-sdk-method-name': 'update',
|
|
8935
|
+
'x-title': 'Update an ACS User',
|
|
8617
8936
|
},
|
|
8618
8937
|
},
|
|
8619
8938
|
'/action_attempts/get': {
|