@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
|
@@ -735,6 +735,8 @@ export default {
|
|
|
735
735
|
acs_user: {
|
|
736
736
|
properties: {
|
|
737
737
|
access_schedule: {
|
|
738
|
+
description:
|
|
739
|
+
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
738
740
|
properties: {
|
|
739
741
|
ends_at: { format: 'date-time', type: 'string' },
|
|
740
742
|
starts_at: { format: 'date-time', type: 'string' },
|
|
@@ -742,18 +744,39 @@ export default {
|
|
|
742
744
|
required: ['starts_at', 'ends_at'],
|
|
743
745
|
type: 'object',
|
|
744
746
|
},
|
|
745
|
-
acs_system_id: {
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
747
|
+
acs_system_id: {
|
|
748
|
+
description:
|
|
749
|
+
'ID of the access control system that contains the `acs_user`.',
|
|
750
|
+
format: 'uuid',
|
|
751
|
+
type: 'string',
|
|
752
|
+
},
|
|
753
|
+
acs_user_id: {
|
|
754
|
+
description: 'ID of the `acs_user`.',
|
|
755
|
+
format: 'uuid',
|
|
756
|
+
type: 'string',
|
|
757
|
+
},
|
|
758
|
+
created_at: {
|
|
759
|
+
description: 'Date and time at which the `acs_user` was created.',
|
|
760
|
+
format: 'date-time',
|
|
761
|
+
type: 'string',
|
|
762
|
+
},
|
|
763
|
+
display_name: {
|
|
764
|
+
description: 'Display name for the `acs_user`.',
|
|
765
|
+
type: 'string',
|
|
766
|
+
},
|
|
749
767
|
email: {
|
|
750
768
|
deprecated: true,
|
|
751
769
|
format: 'email',
|
|
752
770
|
type: 'string',
|
|
753
771
|
'x-deprecated': 'use email_address.',
|
|
754
772
|
},
|
|
755
|
-
email_address: {
|
|
773
|
+
email_address: {
|
|
774
|
+
description: 'Email address of the `acs_user`.',
|
|
775
|
+
format: 'email',
|
|
776
|
+
type: 'string',
|
|
777
|
+
},
|
|
756
778
|
errors: {
|
|
779
|
+
description: 'Errors associated with the `acs_user`.',
|
|
757
780
|
items: {
|
|
758
781
|
description: 'Error associated with the `acs_user`.',
|
|
759
782
|
oneOf: [
|
|
@@ -877,6 +900,7 @@ export default {
|
|
|
877
900
|
type: 'array',
|
|
878
901
|
},
|
|
879
902
|
external_type: {
|
|
903
|
+
description: 'Brand-specific terminology for the `acs_user` type.',
|
|
880
904
|
enum: [
|
|
881
905
|
'pti_user',
|
|
882
906
|
'brivo_user',
|
|
@@ -886,22 +910,61 @@ export default {
|
|
|
886
910
|
],
|
|
887
911
|
type: 'string',
|
|
888
912
|
},
|
|
889
|
-
external_type_display_name: {
|
|
890
|
-
|
|
913
|
+
external_type_display_name: {
|
|
914
|
+
description:
|
|
915
|
+
'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
|
|
916
|
+
type: 'string',
|
|
917
|
+
},
|
|
918
|
+
full_name: {
|
|
919
|
+
description: 'Full name of the `acs_user`.',
|
|
920
|
+
type: 'string',
|
|
921
|
+
},
|
|
891
922
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
892
|
-
is_latest_desired_state_synced_with_provider: {
|
|
923
|
+
is_latest_desired_state_synced_with_provider: {
|
|
924
|
+
type: 'boolean',
|
|
925
|
+
'x-undocumented': 'Only used internally.',
|
|
926
|
+
},
|
|
893
927
|
is_managed: { enum: [true], type: 'boolean' },
|
|
894
|
-
is_suspended: {
|
|
928
|
+
is_suspended: {
|
|
929
|
+
description:
|
|
930
|
+
'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
931
|
+
type: 'boolean',
|
|
932
|
+
},
|
|
895
933
|
latest_desired_state_synced_with_provider_at: {
|
|
896
934
|
format: 'date-time',
|
|
897
935
|
type: 'string',
|
|
936
|
+
'x-undocumented': 'Only used internally.',
|
|
937
|
+
},
|
|
938
|
+
phone_number: {
|
|
939
|
+
description:
|
|
940
|
+
'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
941
|
+
type: 'string',
|
|
942
|
+
},
|
|
943
|
+
user_identity_email_address: {
|
|
944
|
+
description:
|
|
945
|
+
'Email address of the user identity associated with the `acs_user`.',
|
|
946
|
+
nullable: true,
|
|
947
|
+
type: 'string',
|
|
948
|
+
},
|
|
949
|
+
user_identity_full_name: {
|
|
950
|
+
description:
|
|
951
|
+
'Full name of the user identity associated with the `acs_user`.',
|
|
952
|
+
nullable: true,
|
|
953
|
+
type: 'string',
|
|
954
|
+
},
|
|
955
|
+
user_identity_id: {
|
|
956
|
+
description:
|
|
957
|
+
'ID of the user identity associated with the `acs_user`.',
|
|
958
|
+
type: 'string',
|
|
959
|
+
},
|
|
960
|
+
user_identity_phone_number: {
|
|
961
|
+
description:
|
|
962
|
+
'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
963
|
+
nullable: true,
|
|
964
|
+
type: 'string',
|
|
898
965
|
},
|
|
899
|
-
phone_number: { type: 'string' },
|
|
900
|
-
user_identity_email_address: { nullable: true, type: 'string' },
|
|
901
|
-
user_identity_full_name: { nullable: true, type: 'string' },
|
|
902
|
-
user_identity_id: { type: 'string' },
|
|
903
|
-
user_identity_phone_number: { nullable: true, type: 'string' },
|
|
904
966
|
warnings: {
|
|
967
|
+
description: 'Warnings associated with the `acs_user`.',
|
|
905
968
|
items: {
|
|
906
969
|
description: 'Warning associated with the `acs_user`.',
|
|
907
970
|
oneOf: [
|
|
@@ -934,7 +997,12 @@ export default {
|
|
|
934
997
|
},
|
|
935
998
|
type: 'array',
|
|
936
999
|
},
|
|
937
|
-
workspace_id: {
|
|
1000
|
+
workspace_id: {
|
|
1001
|
+
description:
|
|
1002
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
|
|
1003
|
+
format: 'uuid',
|
|
1004
|
+
type: 'string',
|
|
1005
|
+
},
|
|
938
1006
|
},
|
|
939
1007
|
required: [
|
|
940
1008
|
'acs_user_id',
|
|
@@ -7533,14 +7601,24 @@ export default {
|
|
|
7533
7601
|
},
|
|
7534
7602
|
'/acs/users/add_to_access_group': {
|
|
7535
7603
|
post: {
|
|
7604
|
+
description:
|
|
7605
|
+
'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).',
|
|
7536
7606
|
operationId: 'acsUsersAddToAccessGroupPost',
|
|
7537
7607
|
requestBody: {
|
|
7538
7608
|
content: {
|
|
7539
7609
|
'application/json': {
|
|
7540
7610
|
schema: {
|
|
7541
7611
|
properties: {
|
|
7542
|
-
acs_access_group_id: {
|
|
7543
|
-
|
|
7612
|
+
acs_access_group_id: {
|
|
7613
|
+
description: 'ID of the desired access group.',
|
|
7614
|
+
format: 'uuid',
|
|
7615
|
+
type: 'string',
|
|
7616
|
+
},
|
|
7617
|
+
acs_user_id: {
|
|
7618
|
+
description: 'ID of the desired `acs_user`.',
|
|
7619
|
+
format: 'uuid',
|
|
7620
|
+
type: 'string',
|
|
7621
|
+
},
|
|
7544
7622
|
},
|
|
7545
7623
|
required: ['acs_user_id', 'acs_access_group_id'],
|
|
7546
7624
|
type: 'object',
|
|
@@ -7573,16 +7651,27 @@ export default {
|
|
|
7573
7651
|
tags: ['/acs'],
|
|
7574
7652
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7575
7653
|
'x-fern-sdk-method-name': 'add_to_access_group',
|
|
7654
|
+
'x-title': 'Add an ACS User to an Access Group',
|
|
7576
7655
|
},
|
|
7577
7656
|
put: {
|
|
7657
|
+
description:
|
|
7658
|
+
'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).',
|
|
7578
7659
|
operationId: 'acsUsersAddToAccessGroupPut',
|
|
7579
7660
|
requestBody: {
|
|
7580
7661
|
content: {
|
|
7581
7662
|
'application/json': {
|
|
7582
7663
|
schema: {
|
|
7583
7664
|
properties: {
|
|
7584
|
-
acs_access_group_id: {
|
|
7585
|
-
|
|
7665
|
+
acs_access_group_id: {
|
|
7666
|
+
description: 'ID of the desired access group.',
|
|
7667
|
+
format: 'uuid',
|
|
7668
|
+
type: 'string',
|
|
7669
|
+
},
|
|
7670
|
+
acs_user_id: {
|
|
7671
|
+
description: 'ID of the desired `acs_user`.',
|
|
7672
|
+
format: 'uuid',
|
|
7673
|
+
type: 'string',
|
|
7674
|
+
},
|
|
7586
7675
|
},
|
|
7587
7676
|
required: ['acs_user_id', 'acs_access_group_id'],
|
|
7588
7677
|
type: 'object',
|
|
@@ -7614,10 +7703,13 @@ export default {
|
|
|
7614
7703
|
summary: '/acs/users/add_to_access_group',
|
|
7615
7704
|
tags: ['/acs'],
|
|
7616
7705
|
'x-fern-ignore': true,
|
|
7706
|
+
'x-title': 'Add an ACS User to an Access Group',
|
|
7617
7707
|
},
|
|
7618
7708
|
},
|
|
7619
7709
|
'/acs/users/create': {
|
|
7620
7710
|
post: {
|
|
7711
|
+
description:
|
|
7712
|
+
'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7621
7713
|
operationId: 'acsUsersCreatePost',
|
|
7622
7714
|
requestBody: {
|
|
7623
7715
|
content: {
|
|
@@ -7625,6 +7717,8 @@ export default {
|
|
|
7625
7717
|
schema: {
|
|
7626
7718
|
properties: {
|
|
7627
7719
|
access_schedule: {
|
|
7720
|
+
description:
|
|
7721
|
+
"`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.",
|
|
7628
7722
|
properties: {
|
|
7629
7723
|
ends_at: { format: 'date-time', type: 'string' },
|
|
7630
7724
|
starts_at: { format: 'date-time', type: 'string' },
|
|
@@ -7634,20 +7728,43 @@ export default {
|
|
|
7634
7728
|
},
|
|
7635
7729
|
acs_access_group_ids: {
|
|
7636
7730
|
default: [],
|
|
7731
|
+
description:
|
|
7732
|
+
'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.',
|
|
7637
7733
|
items: { format: 'uuid', type: 'string' },
|
|
7638
7734
|
type: 'array',
|
|
7639
7735
|
},
|
|
7640
|
-
acs_system_id: {
|
|
7736
|
+
acs_system_id: {
|
|
7737
|
+
description:
|
|
7738
|
+
'ID of the `acs_system` to which to add the new `acs_user`.',
|
|
7739
|
+
format: 'uuid',
|
|
7740
|
+
type: 'string',
|
|
7741
|
+
},
|
|
7641
7742
|
email: {
|
|
7642
7743
|
deprecated: true,
|
|
7643
7744
|
format: 'email',
|
|
7644
7745
|
type: 'string',
|
|
7645
7746
|
'x-deprecated': 'use email_address.',
|
|
7646
7747
|
},
|
|
7647
|
-
email_address: {
|
|
7648
|
-
|
|
7649
|
-
|
|
7650
|
-
|
|
7748
|
+
email_address: {
|
|
7749
|
+
description: 'Email address of the `acs_user`.',
|
|
7750
|
+
format: 'email',
|
|
7751
|
+
type: 'string',
|
|
7752
|
+
},
|
|
7753
|
+
full_name: {
|
|
7754
|
+
description: 'Full name of the `acs_user`.',
|
|
7755
|
+
type: 'string',
|
|
7756
|
+
},
|
|
7757
|
+
phone_number: {
|
|
7758
|
+
description:
|
|
7759
|
+
'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
7760
|
+
type: 'string',
|
|
7761
|
+
},
|
|
7762
|
+
user_identity_id: {
|
|
7763
|
+
description:
|
|
7764
|
+
'ID of the user identity with which to associate the new `acs_user`.',
|
|
7765
|
+
format: 'uuid',
|
|
7766
|
+
type: 'string',
|
|
7767
|
+
},
|
|
7651
7768
|
},
|
|
7652
7769
|
required: ['acs_system_id'],
|
|
7653
7770
|
type: 'object',
|
|
@@ -7684,16 +7801,26 @@ export default {
|
|
|
7684
7801
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7685
7802
|
'x-fern-sdk-method-name': 'create',
|
|
7686
7803
|
'x-fern-sdk-return-value': 'acs_user',
|
|
7804
|
+
'x-response-key': 'acs_user',
|
|
7805
|
+
'x-title': 'Create an ACS User',
|
|
7687
7806
|
},
|
|
7688
7807
|
},
|
|
7689
7808
|
'/acs/users/delete': {
|
|
7690
7809
|
post: {
|
|
7810
|
+
description:
|
|
7811
|
+
"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).",
|
|
7691
7812
|
operationId: 'acsUsersDeletePost',
|
|
7692
7813
|
requestBody: {
|
|
7693
7814
|
content: {
|
|
7694
7815
|
'application/json': {
|
|
7695
7816
|
schema: {
|
|
7696
|
-
properties: {
|
|
7817
|
+
properties: {
|
|
7818
|
+
acs_user_id: {
|
|
7819
|
+
description: 'ID of the desired `acs_user`.',
|
|
7820
|
+
format: 'uuid',
|
|
7821
|
+
type: 'string',
|
|
7822
|
+
},
|
|
7823
|
+
},
|
|
7697
7824
|
required: ['acs_user_id'],
|
|
7698
7825
|
type: 'object',
|
|
7699
7826
|
},
|
|
@@ -7725,16 +7852,25 @@ export default {
|
|
|
7725
7852
|
tags: ['/acs'],
|
|
7726
7853
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7727
7854
|
'x-fern-sdk-method-name': 'delete',
|
|
7855
|
+
'x-title': 'Delete an ACS User',
|
|
7728
7856
|
},
|
|
7729
7857
|
},
|
|
7730
7858
|
'/acs/users/get': {
|
|
7731
7859
|
post: {
|
|
7860
|
+
description:
|
|
7861
|
+
'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7732
7862
|
operationId: 'acsUsersGetPost',
|
|
7733
7863
|
requestBody: {
|
|
7734
7864
|
content: {
|
|
7735
7865
|
'application/json': {
|
|
7736
7866
|
schema: {
|
|
7737
|
-
properties: {
|
|
7867
|
+
properties: {
|
|
7868
|
+
acs_user_id: {
|
|
7869
|
+
description: 'ID of the desired `acs_user`.',
|
|
7870
|
+
format: 'uuid',
|
|
7871
|
+
type: 'string',
|
|
7872
|
+
},
|
|
7873
|
+
},
|
|
7738
7874
|
required: ['acs_user_id'],
|
|
7739
7875
|
type: 'object',
|
|
7740
7876
|
},
|
|
@@ -7770,22 +7906,44 @@ export default {
|
|
|
7770
7906
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7771
7907
|
'x-fern-sdk-method-name': 'get',
|
|
7772
7908
|
'x-fern-sdk-return-value': 'acs_user',
|
|
7909
|
+
'x-response-key': 'acs_user',
|
|
7910
|
+
'x-title': 'Get an ACS User',
|
|
7773
7911
|
},
|
|
7774
7912
|
},
|
|
7775
7913
|
'/acs/users/list': {
|
|
7776
7914
|
post: {
|
|
7915
|
+
description:
|
|
7916
|
+
'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
7777
7917
|
operationId: 'acsUsersListPost',
|
|
7778
7918
|
requestBody: {
|
|
7779
7919
|
content: {
|
|
7780
7920
|
'application/json': {
|
|
7781
7921
|
schema: {
|
|
7782
7922
|
properties: {
|
|
7783
|
-
acs_system_id: {
|
|
7923
|
+
acs_system_id: {
|
|
7924
|
+
description:
|
|
7925
|
+
'ID of the `acs_system` for which you want to retrieve all `acs_user`s.',
|
|
7926
|
+
format: 'uuid',
|
|
7927
|
+
type: 'string',
|
|
7928
|
+
},
|
|
7784
7929
|
created_before: { format: 'date-time', type: 'string' },
|
|
7785
7930
|
limit: { default: 500, format: 'float', type: 'number' },
|
|
7786
|
-
user_identity_email_address: {
|
|
7787
|
-
|
|
7788
|
-
|
|
7931
|
+
user_identity_email_address: {
|
|
7932
|
+
description:
|
|
7933
|
+
'Email address of the user identity for which you want to retrieve all `acs_user`s.',
|
|
7934
|
+
type: 'string',
|
|
7935
|
+
},
|
|
7936
|
+
user_identity_id: {
|
|
7937
|
+
description:
|
|
7938
|
+
'ID of the user identity for which you want to retrieve all `acs_user`s.',
|
|
7939
|
+
format: 'uuid',
|
|
7940
|
+
type: 'string',
|
|
7941
|
+
},
|
|
7942
|
+
user_identity_phone_number: {
|
|
7943
|
+
description:
|
|
7944
|
+
'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`).',
|
|
7945
|
+
type: 'string',
|
|
7946
|
+
},
|
|
7789
7947
|
},
|
|
7790
7948
|
type: 'object',
|
|
7791
7949
|
},
|
|
@@ -7825,16 +7983,26 @@ export default {
|
|
|
7825
7983
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7826
7984
|
'x-fern-sdk-method-name': 'list',
|
|
7827
7985
|
'x-fern-sdk-return-value': 'acs_users',
|
|
7986
|
+
'x-response-key': 'acs_users',
|
|
7987
|
+
'x-title': 'List ACS Users',
|
|
7828
7988
|
},
|
|
7829
7989
|
},
|
|
7830
7990
|
'/acs/users/list_accessible_entrances': {
|
|
7831
7991
|
post: {
|
|
7992
|
+
description:
|
|
7993
|
+
'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.',
|
|
7832
7994
|
operationId: 'acsUsersListAccessibleEntrancesPost',
|
|
7833
7995
|
requestBody: {
|
|
7834
7996
|
content: {
|
|
7835
7997
|
'application/json': {
|
|
7836
7998
|
schema: {
|
|
7837
|
-
properties: {
|
|
7999
|
+
properties: {
|
|
8000
|
+
acs_user_id: {
|
|
8001
|
+
description: 'ID of the desired `acs_user`.',
|
|
8002
|
+
format: 'uuid',
|
|
8003
|
+
type: 'string',
|
|
8004
|
+
},
|
|
8005
|
+
},
|
|
7838
8006
|
required: ['acs_user_id'],
|
|
7839
8007
|
type: 'object',
|
|
7840
8008
|
},
|
|
@@ -7874,18 +8042,30 @@ export default {
|
|
|
7874
8042
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7875
8043
|
'x-fern-sdk-method-name': 'list_accessible_entrances',
|
|
7876
8044
|
'x-fern-sdk-return-value': 'acs_entrances',
|
|
8045
|
+
'x-response-key': 'acs_entrances',
|
|
8046
|
+
'x-title': 'List ACS User-Accessible Entrances',
|
|
7877
8047
|
},
|
|
7878
8048
|
},
|
|
7879
8049
|
'/acs/users/remove_from_access_group': {
|
|
7880
8050
|
post: {
|
|
8051
|
+
description:
|
|
8052
|
+
'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).',
|
|
7881
8053
|
operationId: 'acsUsersRemoveFromAccessGroupPost',
|
|
7882
8054
|
requestBody: {
|
|
7883
8055
|
content: {
|
|
7884
8056
|
'application/json': {
|
|
7885
8057
|
schema: {
|
|
7886
8058
|
properties: {
|
|
7887
|
-
acs_access_group_id: {
|
|
7888
|
-
|
|
8059
|
+
acs_access_group_id: {
|
|
8060
|
+
description: 'ID of the desired access group.',
|
|
8061
|
+
format: 'uuid',
|
|
8062
|
+
type: 'string',
|
|
8063
|
+
},
|
|
8064
|
+
acs_user_id: {
|
|
8065
|
+
description: 'ID of the desired `acs_user`.',
|
|
8066
|
+
format: 'uuid',
|
|
8067
|
+
type: 'string',
|
|
8068
|
+
},
|
|
7889
8069
|
},
|
|
7890
8070
|
required: ['acs_user_id', 'acs_access_group_id'],
|
|
7891
8071
|
type: 'object',
|
|
@@ -7918,16 +8098,25 @@ export default {
|
|
|
7918
8098
|
tags: ['/acs'],
|
|
7919
8099
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7920
8100
|
'x-fern-sdk-method-name': 'remove_from_access_group',
|
|
8101
|
+
'x-title': 'Remove an ACS User from an Access Group',
|
|
7921
8102
|
},
|
|
7922
8103
|
},
|
|
7923
8104
|
'/acs/users/revoke_access_to_all_entrances': {
|
|
7924
8105
|
post: {
|
|
8106
|
+
description:
|
|
8107
|
+
'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).',
|
|
7925
8108
|
operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
|
|
7926
8109
|
requestBody: {
|
|
7927
8110
|
content: {
|
|
7928
8111
|
'application/json': {
|
|
7929
8112
|
schema: {
|
|
7930
|
-
properties: {
|
|
8113
|
+
properties: {
|
|
8114
|
+
acs_user_id: {
|
|
8115
|
+
description: 'ID of the desired `acs_user`.',
|
|
8116
|
+
format: 'uuid',
|
|
8117
|
+
type: 'string',
|
|
8118
|
+
},
|
|
8119
|
+
},
|
|
7931
8120
|
required: ['acs_user_id'],
|
|
7932
8121
|
type: 'object',
|
|
7933
8122
|
},
|
|
@@ -7959,16 +8148,25 @@ export default {
|
|
|
7959
8148
|
tags: ['/acs'],
|
|
7960
8149
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
7961
8150
|
'x-fern-sdk-method-name': 'revoke_access_to_all_entrances',
|
|
8151
|
+
'x-title': 'Revoke ACS User Access to All Entrances',
|
|
7962
8152
|
},
|
|
7963
8153
|
},
|
|
7964
8154
|
'/acs/users/suspend': {
|
|
7965
8155
|
post: {
|
|
8156
|
+
description:
|
|
8157
|
+
"[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.",
|
|
7966
8158
|
operationId: 'acsUsersSuspendPost',
|
|
7967
8159
|
requestBody: {
|
|
7968
8160
|
content: {
|
|
7969
8161
|
'application/json': {
|
|
7970
8162
|
schema: {
|
|
7971
|
-
properties: {
|
|
8163
|
+
properties: {
|
|
8164
|
+
acs_user_id: {
|
|
8165
|
+
description: 'ID of the desired `acs_user`.',
|
|
8166
|
+
format: 'uuid',
|
|
8167
|
+
type: 'string',
|
|
8168
|
+
},
|
|
8169
|
+
},
|
|
7972
8170
|
required: ['acs_user_id'],
|
|
7973
8171
|
type: 'object',
|
|
7974
8172
|
},
|
|
@@ -8000,6 +8198,7 @@ export default {
|
|
|
8000
8198
|
tags: ['/acs'],
|
|
8001
8199
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
8002
8200
|
'x-fern-sdk-method-name': 'suspend',
|
|
8201
|
+
'x-title': 'Suspend an ACS User',
|
|
8003
8202
|
},
|
|
8004
8203
|
},
|
|
8005
8204
|
'/acs/users/unmanaged/get': {
|
|
@@ -8025,20 +8224,49 @@ export default {
|
|
|
8025
8224
|
acs_user: {
|
|
8026
8225
|
properties: {
|
|
8027
8226
|
access_schedule: {
|
|
8028
|
-
|
|
8227
|
+
description:
|
|
8228
|
+
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
8229
|
+
properties: {
|
|
8230
|
+
ends_at: { format: 'date-time', type: 'string' },
|
|
8231
|
+
starts_at: { format: 'date-time', type: 'string' },
|
|
8232
|
+
},
|
|
8233
|
+
required: ['starts_at', 'ends_at'],
|
|
8234
|
+
type: 'object',
|
|
8235
|
+
},
|
|
8236
|
+
acs_system_id: {
|
|
8237
|
+
description:
|
|
8238
|
+
'ID of the access control system that contains the `acs_user`.',
|
|
8239
|
+
format: 'uuid',
|
|
8240
|
+
type: 'string',
|
|
8241
|
+
},
|
|
8242
|
+
acs_user_id: {
|
|
8243
|
+
description: 'ID of the `acs_user`.',
|
|
8244
|
+
format: 'uuid',
|
|
8245
|
+
type: 'string',
|
|
8246
|
+
},
|
|
8247
|
+
created_at: {
|
|
8248
|
+
description:
|
|
8249
|
+
'Date and time at which the `acs_user` was created.',
|
|
8250
|
+
format: 'date-time',
|
|
8251
|
+
type: 'string',
|
|
8252
|
+
},
|
|
8253
|
+
display_name: {
|
|
8254
|
+
description: 'Display name for the `acs_user`.',
|
|
8255
|
+
type: 'string',
|
|
8029
8256
|
},
|
|
8030
|
-
acs_system_id: { format: 'uuid', type: 'string' },
|
|
8031
|
-
acs_user_id: { format: 'uuid', type: 'string' },
|
|
8032
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
8033
|
-
display_name: { type: 'string' },
|
|
8034
8257
|
email: {
|
|
8035
8258
|
deprecated: true,
|
|
8036
8259
|
format: 'email',
|
|
8037
8260
|
type: 'string',
|
|
8038
8261
|
'x-deprecated': 'use email_address.',
|
|
8039
8262
|
},
|
|
8040
|
-
email_address: {
|
|
8263
|
+
email_address: {
|
|
8264
|
+
description: 'Email address of the `acs_user`.',
|
|
8265
|
+
format: 'email',
|
|
8266
|
+
type: 'string',
|
|
8267
|
+
},
|
|
8041
8268
|
errors: {
|
|
8269
|
+
description: 'Errors associated with the `acs_user`.',
|
|
8042
8270
|
items: {
|
|
8043
8271
|
description:
|
|
8044
8272
|
'Error associated with the `acs_user`.',
|
|
@@ -8185,6 +8413,8 @@ export default {
|
|
|
8185
8413
|
type: 'array',
|
|
8186
8414
|
},
|
|
8187
8415
|
external_type: {
|
|
8416
|
+
description:
|
|
8417
|
+
'Brand-specific terminology for the `acs_user` type.',
|
|
8188
8418
|
enum: [
|
|
8189
8419
|
'pti_user',
|
|
8190
8420
|
'brivo_user',
|
|
@@ -8194,33 +8424,62 @@ export default {
|
|
|
8194
8424
|
],
|
|
8195
8425
|
type: 'string',
|
|
8196
8426
|
},
|
|
8197
|
-
external_type_display_name: {
|
|
8198
|
-
|
|
8427
|
+
external_type_display_name: {
|
|
8428
|
+
description:
|
|
8429
|
+
'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
|
|
8430
|
+
type: 'string',
|
|
8431
|
+
},
|
|
8432
|
+
full_name: {
|
|
8433
|
+
description: 'Full name of the `acs_user`.',
|
|
8434
|
+
type: 'string',
|
|
8435
|
+
},
|
|
8199
8436
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8200
8437
|
is_latest_desired_state_synced_with_provider: {
|
|
8201
8438
|
type: 'boolean',
|
|
8439
|
+
'x-undocumented': 'Only used internally.',
|
|
8202
8440
|
},
|
|
8203
8441
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8204
|
-
is_suspended: {
|
|
8442
|
+
is_suspended: {
|
|
8443
|
+
description:
|
|
8444
|
+
'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
8445
|
+
type: 'boolean',
|
|
8446
|
+
},
|
|
8205
8447
|
latest_desired_state_synced_with_provider_at: {
|
|
8206
8448
|
format: 'date-time',
|
|
8207
8449
|
type: 'string',
|
|
8450
|
+
'x-undocumented': 'Only used internally.',
|
|
8451
|
+
},
|
|
8452
|
+
phone_number: {
|
|
8453
|
+
description:
|
|
8454
|
+
'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8455
|
+
type: 'string',
|
|
8208
8456
|
},
|
|
8209
|
-
phone_number: { type: 'string' },
|
|
8210
8457
|
user_identity_email_address: {
|
|
8458
|
+
description:
|
|
8459
|
+
'Email address of the user identity associated with the `acs_user`.',
|
|
8211
8460
|
nullable: true,
|
|
8212
8461
|
type: 'string',
|
|
8213
8462
|
},
|
|
8214
8463
|
user_identity_full_name: {
|
|
8464
|
+
description:
|
|
8465
|
+
'Full name of the user identity associated with the `acs_user`.',
|
|
8215
8466
|
nullable: true,
|
|
8216
8467
|
type: 'string',
|
|
8217
8468
|
},
|
|
8218
|
-
user_identity_id: {
|
|
8469
|
+
user_identity_id: {
|
|
8470
|
+
description:
|
|
8471
|
+
'ID of the user identity associated with the `acs_user`.',
|
|
8472
|
+
type: 'string',
|
|
8473
|
+
},
|
|
8219
8474
|
user_identity_phone_number: {
|
|
8475
|
+
description:
|
|
8476
|
+
'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8220
8477
|
nullable: true,
|
|
8221
8478
|
type: 'string',
|
|
8222
8479
|
},
|
|
8223
8480
|
warnings: {
|
|
8481
|
+
description:
|
|
8482
|
+
'Warnings associated with the `acs_user`.',
|
|
8224
8483
|
items: {
|
|
8225
8484
|
description:
|
|
8226
8485
|
'Warning associated with the `acs_user`.',
|
|
@@ -8271,7 +8530,12 @@ export default {
|
|
|
8271
8530
|
},
|
|
8272
8531
|
type: 'array',
|
|
8273
8532
|
},
|
|
8274
|
-
workspace_id: {
|
|
8533
|
+
workspace_id: {
|
|
8534
|
+
description:
|
|
8535
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
|
|
8536
|
+
format: 'uuid',
|
|
8537
|
+
type: 'string',
|
|
8538
|
+
},
|
|
8275
8539
|
},
|
|
8276
8540
|
required: [
|
|
8277
8541
|
'acs_user_id',
|
|
@@ -8340,20 +8604,53 @@ export default {
|
|
|
8340
8604
|
items: {
|
|
8341
8605
|
properties: {
|
|
8342
8606
|
access_schedule: {
|
|
8343
|
-
|
|
8607
|
+
description:
|
|
8608
|
+
"`starts_at` and `ends_at` timestamps for the `acs_user`'s access.",
|
|
8609
|
+
properties: {
|
|
8610
|
+
ends_at: { format: 'date-time', type: 'string' },
|
|
8611
|
+
starts_at: {
|
|
8612
|
+
format: 'date-time',
|
|
8613
|
+
type: 'string',
|
|
8614
|
+
},
|
|
8615
|
+
},
|
|
8616
|
+
required: ['starts_at', 'ends_at'],
|
|
8617
|
+
type: 'object',
|
|
8618
|
+
},
|
|
8619
|
+
acs_system_id: {
|
|
8620
|
+
description:
|
|
8621
|
+
'ID of the access control system that contains the `acs_user`.',
|
|
8622
|
+
format: 'uuid',
|
|
8623
|
+
type: 'string',
|
|
8624
|
+
},
|
|
8625
|
+
acs_user_id: {
|
|
8626
|
+
description: 'ID of the `acs_user`.',
|
|
8627
|
+
format: 'uuid',
|
|
8628
|
+
type: 'string',
|
|
8629
|
+
},
|
|
8630
|
+
created_at: {
|
|
8631
|
+
description:
|
|
8632
|
+
'Date and time at which the `acs_user` was created.',
|
|
8633
|
+
format: 'date-time',
|
|
8634
|
+
type: 'string',
|
|
8635
|
+
},
|
|
8636
|
+
display_name: {
|
|
8637
|
+
description: 'Display name for the `acs_user`.',
|
|
8638
|
+
type: 'string',
|
|
8344
8639
|
},
|
|
8345
|
-
acs_system_id: { format: 'uuid', type: 'string' },
|
|
8346
|
-
acs_user_id: { format: 'uuid', type: 'string' },
|
|
8347
|
-
created_at: { format: 'date-time', type: 'string' },
|
|
8348
|
-
display_name: { type: 'string' },
|
|
8349
8640
|
email: {
|
|
8350
8641
|
deprecated: true,
|
|
8351
8642
|
format: 'email',
|
|
8352
8643
|
type: 'string',
|
|
8353
8644
|
'x-deprecated': 'use email_address.',
|
|
8354
8645
|
},
|
|
8355
|
-
email_address: {
|
|
8646
|
+
email_address: {
|
|
8647
|
+
description: 'Email address of the `acs_user`.',
|
|
8648
|
+
format: 'email',
|
|
8649
|
+
type: 'string',
|
|
8650
|
+
},
|
|
8356
8651
|
errors: {
|
|
8652
|
+
description:
|
|
8653
|
+
'Errors associated with the `acs_user`.',
|
|
8357
8654
|
items: {
|
|
8358
8655
|
description:
|
|
8359
8656
|
'Error associated with the `acs_user`.',
|
|
@@ -8500,6 +8797,8 @@ export default {
|
|
|
8500
8797
|
type: 'array',
|
|
8501
8798
|
},
|
|
8502
8799
|
external_type: {
|
|
8800
|
+
description:
|
|
8801
|
+
'Brand-specific terminology for the `acs_user` type.',
|
|
8503
8802
|
enum: [
|
|
8504
8803
|
'pti_user',
|
|
8505
8804
|
'brivo_user',
|
|
@@ -8509,33 +8808,62 @@ export default {
|
|
|
8509
8808
|
],
|
|
8510
8809
|
type: 'string',
|
|
8511
8810
|
},
|
|
8512
|
-
external_type_display_name: {
|
|
8513
|
-
|
|
8811
|
+
external_type_display_name: {
|
|
8812
|
+
description:
|
|
8813
|
+
'Display name that corresponds to the brand-specific terminology for the `acs_user` type.',
|
|
8814
|
+
type: 'string',
|
|
8815
|
+
},
|
|
8816
|
+
full_name: {
|
|
8817
|
+
description: 'Full name of the `acs_user`.',
|
|
8818
|
+
type: 'string',
|
|
8819
|
+
},
|
|
8514
8820
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8515
8821
|
is_latest_desired_state_synced_with_provider: {
|
|
8516
8822
|
type: 'boolean',
|
|
8823
|
+
'x-undocumented': 'Only used internally.',
|
|
8517
8824
|
},
|
|
8518
8825
|
is_managed: { enum: [false], type: 'boolean' },
|
|
8519
|
-
is_suspended: {
|
|
8826
|
+
is_suspended: {
|
|
8827
|
+
description:
|
|
8828
|
+
'Indicates whether the `acs_user` is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users).',
|
|
8829
|
+
type: 'boolean',
|
|
8830
|
+
},
|
|
8520
8831
|
latest_desired_state_synced_with_provider_at: {
|
|
8521
8832
|
format: 'date-time',
|
|
8522
8833
|
type: 'string',
|
|
8834
|
+
'x-undocumented': 'Only used internally.',
|
|
8835
|
+
},
|
|
8836
|
+
phone_number: {
|
|
8837
|
+
description:
|
|
8838
|
+
'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8839
|
+
type: 'string',
|
|
8523
8840
|
},
|
|
8524
|
-
phone_number: { type: 'string' },
|
|
8525
8841
|
user_identity_email_address: {
|
|
8842
|
+
description:
|
|
8843
|
+
'Email address of the user identity associated with the `acs_user`.',
|
|
8526
8844
|
nullable: true,
|
|
8527
8845
|
type: 'string',
|
|
8528
8846
|
},
|
|
8529
8847
|
user_identity_full_name: {
|
|
8848
|
+
description:
|
|
8849
|
+
'Full name of the user identity associated with the `acs_user`.',
|
|
8530
8850
|
nullable: true,
|
|
8531
8851
|
type: 'string',
|
|
8532
8852
|
},
|
|
8533
|
-
user_identity_id: {
|
|
8853
|
+
user_identity_id: {
|
|
8854
|
+
description:
|
|
8855
|
+
'ID of the user identity associated with the `acs_user`.',
|
|
8856
|
+
type: 'string',
|
|
8857
|
+
},
|
|
8534
8858
|
user_identity_phone_number: {
|
|
8859
|
+
description:
|
|
8860
|
+
'Phone number of the user identity associated with the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
8535
8861
|
nullable: true,
|
|
8536
8862
|
type: 'string',
|
|
8537
8863
|
},
|
|
8538
8864
|
warnings: {
|
|
8865
|
+
description:
|
|
8866
|
+
'Warnings associated with the `acs_user`.',
|
|
8539
8867
|
items: {
|
|
8540
8868
|
description:
|
|
8541
8869
|
'Warning associated with the `acs_user`.',
|
|
@@ -8586,7 +8914,12 @@ export default {
|
|
|
8586
8914
|
},
|
|
8587
8915
|
type: 'array',
|
|
8588
8916
|
},
|
|
8589
|
-
workspace_id: {
|
|
8917
|
+
workspace_id: {
|
|
8918
|
+
description:
|
|
8919
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_user`.',
|
|
8920
|
+
format: 'uuid',
|
|
8921
|
+
type: 'string',
|
|
8922
|
+
},
|
|
8590
8923
|
},
|
|
8591
8924
|
required: [
|
|
8592
8925
|
'acs_user_id',
|
|
@@ -8630,12 +8963,20 @@ export default {
|
|
|
8630
8963
|
},
|
|
8631
8964
|
'/acs/users/unsuspend': {
|
|
8632
8965
|
post: {
|
|
8966
|
+
description:
|
|
8967
|
+
'[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.',
|
|
8633
8968
|
operationId: 'acsUsersUnsuspendPost',
|
|
8634
8969
|
requestBody: {
|
|
8635
8970
|
content: {
|
|
8636
8971
|
'application/json': {
|
|
8637
8972
|
schema: {
|
|
8638
|
-
properties: {
|
|
8973
|
+
properties: {
|
|
8974
|
+
acs_user_id: {
|
|
8975
|
+
description: 'ID of the desired `acs_user`.',
|
|
8976
|
+
format: 'uuid',
|
|
8977
|
+
type: 'string',
|
|
8978
|
+
},
|
|
8979
|
+
},
|
|
8639
8980
|
required: ['acs_user_id'],
|
|
8640
8981
|
type: 'object',
|
|
8641
8982
|
},
|
|
@@ -8667,10 +9008,13 @@ export default {
|
|
|
8667
9008
|
tags: ['/acs'],
|
|
8668
9009
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
8669
9010
|
'x-fern-sdk-method-name': 'unsuspend',
|
|
9011
|
+
'x-title': 'Unsuspend an ACS User',
|
|
8670
9012
|
},
|
|
8671
9013
|
},
|
|
8672
9014
|
'/acs/users/update': {
|
|
8673
9015
|
patch: {
|
|
9016
|
+
description:
|
|
9017
|
+
'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
8674
9018
|
operationId: 'acsUsersUpdatePatch',
|
|
8675
9019
|
requestBody: {
|
|
8676
9020
|
content: {
|
|
@@ -8678,6 +9022,8 @@ export default {
|
|
|
8678
9022
|
schema: {
|
|
8679
9023
|
properties: {
|
|
8680
9024
|
access_schedule: {
|
|
9025
|
+
description:
|
|
9026
|
+
"`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.",
|
|
8681
9027
|
nullable: true,
|
|
8682
9028
|
properties: {
|
|
8683
9029
|
ends_at: { format: 'date-time', type: 'string' },
|
|
@@ -8686,17 +9032,32 @@ export default {
|
|
|
8686
9032
|
required: ['starts_at', 'ends_at'],
|
|
8687
9033
|
type: 'object',
|
|
8688
9034
|
},
|
|
8689
|
-
acs_user_id: {
|
|
9035
|
+
acs_user_id: {
|
|
9036
|
+
description: 'ID of the `acs_user`.',
|
|
9037
|
+
format: 'uuid',
|
|
9038
|
+
type: 'string',
|
|
9039
|
+
},
|
|
8690
9040
|
email: {
|
|
8691
9041
|
deprecated: true,
|
|
8692
9042
|
format: 'email',
|
|
8693
9043
|
type: 'string',
|
|
8694
9044
|
'x-deprecated': 'use email_address.',
|
|
8695
9045
|
},
|
|
8696
|
-
email_address: {
|
|
8697
|
-
|
|
9046
|
+
email_address: {
|
|
9047
|
+
description: 'Email address of the `acs_user`.',
|
|
9048
|
+
format: 'email',
|
|
9049
|
+
type: 'string',
|
|
9050
|
+
},
|
|
9051
|
+
full_name: {
|
|
9052
|
+
description: 'Full name of the `acs_user`.',
|
|
9053
|
+
type: 'string',
|
|
9054
|
+
},
|
|
8698
9055
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8699
|
-
phone_number: {
|
|
9056
|
+
phone_number: {
|
|
9057
|
+
description:
|
|
9058
|
+
'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
9059
|
+
type: 'string',
|
|
9060
|
+
},
|
|
8700
9061
|
},
|
|
8701
9062
|
required: ['acs_user_id'],
|
|
8702
9063
|
type: 'object',
|
|
@@ -8728,8 +9089,11 @@ export default {
|
|
|
8728
9089
|
summary: '/acs/users/update',
|
|
8729
9090
|
tags: ['/acs'],
|
|
8730
9091
|
'x-fern-ignore': true,
|
|
9092
|
+
'x-title': 'Update an ACS User',
|
|
8731
9093
|
},
|
|
8732
9094
|
post: {
|
|
9095
|
+
description:
|
|
9096
|
+
'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
8733
9097
|
operationId: 'acsUsersUpdatePost',
|
|
8734
9098
|
requestBody: {
|
|
8735
9099
|
content: {
|
|
@@ -8737,6 +9101,8 @@ export default {
|
|
|
8737
9101
|
schema: {
|
|
8738
9102
|
properties: {
|
|
8739
9103
|
access_schedule: {
|
|
9104
|
+
description:
|
|
9105
|
+
"`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.",
|
|
8740
9106
|
nullable: true,
|
|
8741
9107
|
properties: {
|
|
8742
9108
|
ends_at: { format: 'date-time', type: 'string' },
|
|
@@ -8745,17 +9111,32 @@ export default {
|
|
|
8745
9111
|
required: ['starts_at', 'ends_at'],
|
|
8746
9112
|
type: 'object',
|
|
8747
9113
|
},
|
|
8748
|
-
acs_user_id: {
|
|
9114
|
+
acs_user_id: {
|
|
9115
|
+
description: 'ID of the `acs_user`.',
|
|
9116
|
+
format: 'uuid',
|
|
9117
|
+
type: 'string',
|
|
9118
|
+
},
|
|
8749
9119
|
email: {
|
|
8750
9120
|
deprecated: true,
|
|
8751
9121
|
format: 'email',
|
|
8752
9122
|
type: 'string',
|
|
8753
9123
|
'x-deprecated': 'use email_address.',
|
|
8754
9124
|
},
|
|
8755
|
-
email_address: {
|
|
8756
|
-
|
|
9125
|
+
email_address: {
|
|
9126
|
+
description: 'Email address of the `acs_user`.',
|
|
9127
|
+
format: 'email',
|
|
9128
|
+
type: 'string',
|
|
9129
|
+
},
|
|
9130
|
+
full_name: {
|
|
9131
|
+
description: 'Full name of the `acs_user`.',
|
|
9132
|
+
type: 'string',
|
|
9133
|
+
},
|
|
8757
9134
|
hid_acs_system_id: { format: 'uuid', type: 'string' },
|
|
8758
|
-
phone_number: {
|
|
9135
|
+
phone_number: {
|
|
9136
|
+
description:
|
|
9137
|
+
'Phone number of the `acs_user` in E.164 format (for example, `+15555550100`).',
|
|
9138
|
+
type: 'string',
|
|
9139
|
+
},
|
|
8759
9140
|
},
|
|
8760
9141
|
required: ['acs_user_id'],
|
|
8761
9142
|
type: 'object',
|
|
@@ -8788,6 +9169,7 @@ export default {
|
|
|
8788
9169
|
tags: ['/acs'],
|
|
8789
9170
|
'x-fern-sdk-group-name': ['acs', 'users'],
|
|
8790
9171
|
'x-fern-sdk-method-name': 'update',
|
|
9172
|
+
'x-title': 'Update an ACS User',
|
|
8791
9173
|
},
|
|
8792
9174
|
},
|
|
8793
9175
|
'/action_attempts/get': {
|