@seamapi/types 1.430.0 → 1.432.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 +142 -60
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +519 -166
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js +2 -2
- package/lib/seam/connect/models/acs/acs-credential-provisioning-automation.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-credential.d.ts +6 -0
- package/lib/seam/connect/models/acs/acs-credential.js +7 -2
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +24 -0
- package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +10 -0
- package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +14 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +12 -0
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +57 -4
- package/lib/seam/connect/models/user-identities/user-identity.js +27 -3
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +69 -12
- package/lib/seam/connect/openapi.js +118 -55
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +401 -151
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-credential.ts +9 -2
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +37 -3
- package/src/lib/seam/connect/openapi.ts +130 -55
- package/src/lib/seam/connect/route-types.ts +401 -151
|
@@ -2256,7 +2256,7 @@ export default {
|
|
|
2256
2256
|
is_managed: { enum: [true], type: 'boolean' },
|
|
2257
2257
|
is_multi_phone_sync_credential: {
|
|
2258
2258
|
description:
|
|
2259
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
2259
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
2260
2260
|
type: 'boolean',
|
|
2261
2261
|
},
|
|
2262
2262
|
is_one_time_use: {
|
|
@@ -2289,6 +2289,12 @@ export default {
|
|
|
2289
2289
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
2290
2290
|
type: 'string',
|
|
2291
2291
|
},
|
|
2292
|
+
user_identity_id: {
|
|
2293
|
+
description:
|
|
2294
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
2295
|
+
format: 'uuid',
|
|
2296
|
+
type: 'string',
|
|
2297
|
+
},
|
|
2292
2298
|
visionline_metadata: {
|
|
2293
2299
|
description:
|
|
2294
2300
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -4398,7 +4404,7 @@ export default {
|
|
|
4398
4404
|
},
|
|
4399
4405
|
card_holder: {
|
|
4400
4406
|
description:
|
|
4401
|
-
'
|
|
4407
|
+
'Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4402
4408
|
type: 'string',
|
|
4403
4409
|
},
|
|
4404
4410
|
card_id: {
|
|
@@ -4630,7 +4636,7 @@ export default {
|
|
|
4630
4636
|
is_managed: { enum: [true], type: 'boolean' },
|
|
4631
4637
|
is_multi_phone_sync_credential: {
|
|
4632
4638
|
description:
|
|
4633
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
4639
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
4634
4640
|
type: 'boolean',
|
|
4635
4641
|
},
|
|
4636
4642
|
is_one_time_use: {
|
|
@@ -4663,6 +4669,12 @@ export default {
|
|
|
4663
4669
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
4664
4670
|
type: 'string',
|
|
4665
4671
|
},
|
|
4672
|
+
user_identity_id: {
|
|
4673
|
+
description:
|
|
4674
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
4675
|
+
format: 'uuid',
|
|
4676
|
+
type: 'string',
|
|
4677
|
+
},
|
|
4666
4678
|
visionline_metadata: {
|
|
4667
4679
|
description:
|
|
4668
4680
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -5078,7 +5090,7 @@ export default {
|
|
|
5078
5090
|
is_managed: { enum: [false], type: 'boolean' },
|
|
5079
5091
|
is_multi_phone_sync_credential: {
|
|
5080
5092
|
description:
|
|
5081
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
5093
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
5082
5094
|
type: 'boolean',
|
|
5083
5095
|
},
|
|
5084
5096
|
is_one_time_use: {
|
|
@@ -5111,6 +5123,12 @@ export default {
|
|
|
5111
5123
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
5112
5124
|
type: 'string',
|
|
5113
5125
|
},
|
|
5126
|
+
user_identity_id: {
|
|
5127
|
+
description:
|
|
5128
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
5129
|
+
format: 'uuid',
|
|
5130
|
+
type: 'string',
|
|
5131
|
+
},
|
|
5114
5132
|
visionline_metadata: {
|
|
5115
5133
|
description:
|
|
5116
5134
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -5725,7 +5743,7 @@ export default {
|
|
|
5725
5743
|
is_managed: { enum: [true], type: 'boolean' },
|
|
5726
5744
|
is_multi_phone_sync_credential: {
|
|
5727
5745
|
description:
|
|
5728
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
5746
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
5729
5747
|
type: 'boolean',
|
|
5730
5748
|
},
|
|
5731
5749
|
is_one_time_use: {
|
|
@@ -5758,6 +5776,12 @@ export default {
|
|
|
5758
5776
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
5759
5777
|
type: 'string',
|
|
5760
5778
|
},
|
|
5779
|
+
user_identity_id: {
|
|
5780
|
+
description:
|
|
5781
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
5782
|
+
format: 'uuid',
|
|
5783
|
+
type: 'string',
|
|
5784
|
+
},
|
|
5761
5785
|
visionline_metadata: {
|
|
5762
5786
|
description:
|
|
5763
5787
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -6170,7 +6194,7 @@ export default {
|
|
|
6170
6194
|
is_managed: { enum: [false], type: 'boolean' },
|
|
6171
6195
|
is_multi_phone_sync_credential: {
|
|
6172
6196
|
description:
|
|
6173
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
6197
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
6174
6198
|
type: 'boolean',
|
|
6175
6199
|
},
|
|
6176
6200
|
is_one_time_use: {
|
|
@@ -6203,6 +6227,12 @@ export default {
|
|
|
6203
6227
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
6204
6228
|
type: 'string',
|
|
6205
6229
|
},
|
|
6230
|
+
user_identity_id: {
|
|
6231
|
+
description:
|
|
6232
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
6233
|
+
format: 'uuid',
|
|
6234
|
+
type: 'string',
|
|
6235
|
+
},
|
|
6206
6236
|
visionline_metadata: {
|
|
6207
6237
|
description:
|
|
6208
6238
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -12754,7 +12784,7 @@ export default {
|
|
|
12754
12784
|
enrollment_automation: {
|
|
12755
12785
|
deprecated: true,
|
|
12756
12786
|
description:
|
|
12757
|
-
'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
12787
|
+
'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access/).',
|
|
12758
12788
|
properties: {
|
|
12759
12789
|
created_at: {
|
|
12760
12790
|
description:
|
|
@@ -12775,7 +12805,7 @@ export default {
|
|
|
12775
12805
|
},
|
|
12776
12806
|
user_identity_id: {
|
|
12777
12807
|
description:
|
|
12778
|
-
'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
12808
|
+
'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
12779
12809
|
format: 'uuid',
|
|
12780
12810
|
type: 'string',
|
|
12781
12811
|
},
|
|
@@ -18692,7 +18722,7 @@ export default {
|
|
|
18692
18722
|
is_managed: { enum: [true], type: 'boolean' },
|
|
18693
18723
|
is_multi_phone_sync_credential: {
|
|
18694
18724
|
description:
|
|
18695
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
18725
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
18696
18726
|
type: 'boolean',
|
|
18697
18727
|
},
|
|
18698
18728
|
is_one_time_use: {
|
|
@@ -18725,6 +18755,12 @@ export default {
|
|
|
18725
18755
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
18726
18756
|
type: 'string',
|
|
18727
18757
|
},
|
|
18758
|
+
user_identity_id: {
|
|
18759
|
+
description:
|
|
18760
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
18761
|
+
format: 'uuid',
|
|
18762
|
+
type: 'string',
|
|
18763
|
+
},
|
|
18728
18764
|
visionline_metadata: {
|
|
18729
18765
|
description:
|
|
18730
18766
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -21260,7 +21296,7 @@ export default {
|
|
|
21260
21296
|
is_managed: { enum: [false], type: 'boolean' },
|
|
21261
21297
|
is_multi_phone_sync_credential: {
|
|
21262
21298
|
description:
|
|
21263
|
-
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
21299
|
+
'Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
21264
21300
|
type: 'boolean',
|
|
21265
21301
|
},
|
|
21266
21302
|
is_one_time_use: {
|
|
@@ -21293,6 +21329,12 @@ export default {
|
|
|
21293
21329
|
'Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
21294
21330
|
type: 'string',
|
|
21295
21331
|
},
|
|
21332
|
+
user_identity_id: {
|
|
21333
|
+
description:
|
|
21334
|
+
'ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.',
|
|
21335
|
+
format: 'uuid',
|
|
21336
|
+
type: 'string',
|
|
21337
|
+
},
|
|
21296
21338
|
visionline_metadata: {
|
|
21297
21339
|
description:
|
|
21298
21340
|
'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
@@ -23654,22 +23696,55 @@ export default {
|
|
|
23654
23696
|
},
|
|
23655
23697
|
errors: {
|
|
23656
23698
|
description:
|
|
23657
|
-
'Array of errors associated with the user identity. Each error object within the array contains
|
|
23699
|
+
'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
|
|
23658
23700
|
items: {
|
|
23659
|
-
|
|
23660
|
-
|
|
23661
|
-
|
|
23662
|
-
|
|
23663
|
-
type: 'string',
|
|
23664
|
-
},
|
|
23665
|
-
message: {
|
|
23701
|
+
description: 'Errors associated with the user identity.',
|
|
23702
|
+
discriminator: { propertyName: 'error_code' },
|
|
23703
|
+
oneOf: [
|
|
23704
|
+
{
|
|
23666
23705
|
description:
|
|
23667
|
-
'
|
|
23668
|
-
|
|
23706
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
23707
|
+
properties: {
|
|
23708
|
+
acs_system_id: {
|
|
23709
|
+
description:
|
|
23710
|
+
'ID of the access system that the user identity is associated with.',
|
|
23711
|
+
format: 'uuid',
|
|
23712
|
+
type: 'string',
|
|
23713
|
+
},
|
|
23714
|
+
acs_user_id: {
|
|
23715
|
+
description:
|
|
23716
|
+
'ID of the access system user that has an issue.',
|
|
23717
|
+
format: 'uuid',
|
|
23718
|
+
type: 'string',
|
|
23719
|
+
},
|
|
23720
|
+
created_at: {
|
|
23721
|
+
description:
|
|
23722
|
+
'Date and time at which Seam created the error.',
|
|
23723
|
+
format: 'date-time',
|
|
23724
|
+
type: 'string',
|
|
23725
|
+
},
|
|
23726
|
+
error_code: {
|
|
23727
|
+
description:
|
|
23728
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
23729
|
+
enum: ['issue_with_acs_user'],
|
|
23730
|
+
type: 'string',
|
|
23731
|
+
},
|
|
23732
|
+
message: {
|
|
23733
|
+
description:
|
|
23734
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
23735
|
+
type: 'string',
|
|
23736
|
+
},
|
|
23737
|
+
},
|
|
23738
|
+
required: [
|
|
23739
|
+
'created_at',
|
|
23740
|
+
'message',
|
|
23741
|
+
'error_code',
|
|
23742
|
+
'acs_user_id',
|
|
23743
|
+
'acs_system_id',
|
|
23744
|
+
],
|
|
23745
|
+
type: 'object',
|
|
23669
23746
|
},
|
|
23670
|
-
|
|
23671
|
-
required: ['created_at', 'message'],
|
|
23672
|
-
type: 'object',
|
|
23747
|
+
],
|
|
23673
23748
|
},
|
|
23674
23749
|
type: 'array',
|
|
23675
23750
|
},
|
|
@@ -28863,7 +28938,7 @@ export default {
|
|
|
28863
28938
|
is_multi_phone_sync_credential: {
|
|
28864
28939
|
default: false,
|
|
28865
28940
|
description:
|
|
28866
|
-
'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
28941
|
+
'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).',
|
|
28867
28942
|
type: 'boolean',
|
|
28868
28943
|
},
|
|
28869
28944
|
salto_space_metadata: {
|
|
@@ -51771,7 +51846,7 @@ export default {
|
|
|
51771
51846
|
'/user_identities/add_acs_user': {
|
|
51772
51847
|
post: {
|
|
51773
51848
|
description:
|
|
51774
|
-
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
51849
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
51775
51850
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
51776
51851
|
requestBody: {
|
|
51777
51852
|
content: {
|
|
@@ -51827,7 +51902,7 @@ export default {
|
|
|
51827
51902
|
},
|
|
51828
51903
|
put: {
|
|
51829
51904
|
description:
|
|
51830
|
-
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
51905
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
51831
51906
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
51832
51907
|
requestBody: {
|
|
51833
51908
|
content: {
|
|
@@ -51885,7 +51960,7 @@ export default {
|
|
|
51885
51960
|
'/user_identities/create': {
|
|
51886
51961
|
post: {
|
|
51887
51962
|
description:
|
|
51888
|
-
'Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
51963
|
+
'Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
51889
51964
|
operationId: 'userIdentitiesCreatePost',
|
|
51890
51965
|
requestBody: {
|
|
51891
51966
|
content: {
|
|
@@ -51968,7 +52043,7 @@ export default {
|
|
|
51968
52043
|
'/user_identities/delete': {
|
|
51969
52044
|
delete: {
|
|
51970
52045
|
description:
|
|
51971
|
-
'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52046
|
+
'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
|
|
51972
52047
|
operationId: 'userIdentitiesDeleteDelete',
|
|
51973
52048
|
parameters: [
|
|
51974
52049
|
{
|
|
@@ -52012,7 +52087,7 @@ export default {
|
|
|
52012
52087
|
},
|
|
52013
52088
|
post: {
|
|
52014
52089
|
description:
|
|
52015
|
-
'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52090
|
+
'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials), [acs users](https://docs.seam.co/latest/api/access-control-systems/users) and [client sessions](https://docs.seam.co/latest/api/client_sessions).',
|
|
52016
52091
|
operationId: 'userIdentitiesDeletePost',
|
|
52017
52092
|
requestBody: {
|
|
52018
52093
|
content: {
|
|
@@ -52064,7 +52139,7 @@ export default {
|
|
|
52064
52139
|
'/user_identities/enrollment_automations/delete': {
|
|
52065
52140
|
delete: {
|
|
52066
52141
|
description:
|
|
52067
|
-
'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52142
|
+
'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).',
|
|
52068
52143
|
operationId: 'userIdentitiesEnrollmentAutomationsDeleteDelete',
|
|
52069
52144
|
parameters: [
|
|
52070
52145
|
{
|
|
@@ -52111,7 +52186,7 @@ export default {
|
|
|
52111
52186
|
},
|
|
52112
52187
|
post: {
|
|
52113
52188
|
description:
|
|
52114
|
-
'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52189
|
+
'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).',
|
|
52115
52190
|
operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
|
|
52116
52191
|
requestBody: {
|
|
52117
52192
|
content: {
|
|
@@ -52165,7 +52240,7 @@ export default {
|
|
|
52165
52240
|
'/user_identities/enrollment_automations/get': {
|
|
52166
52241
|
get: {
|
|
52167
52242
|
description:
|
|
52168
|
-
'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52243
|
+
'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).',
|
|
52169
52244
|
operationId: 'userIdentitiesEnrollmentAutomationsGetGet',
|
|
52170
52245
|
parameters: [
|
|
52171
52246
|
{
|
|
@@ -52219,7 +52294,7 @@ export default {
|
|
|
52219
52294
|
},
|
|
52220
52295
|
post: {
|
|
52221
52296
|
description:
|
|
52222
|
-
'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52297
|
+
'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).',
|
|
52223
52298
|
operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
|
|
52224
52299
|
requestBody: {
|
|
52225
52300
|
content: {
|
|
@@ -52280,7 +52355,7 @@ export default {
|
|
|
52280
52355
|
'/user_identities/enrollment_automations/launch': {
|
|
52281
52356
|
post: {
|
|
52282
52357
|
description:
|
|
52283
|
-
'Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52358
|
+
'Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system).',
|
|
52284
52359
|
operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
|
|
52285
52360
|
requestBody: {
|
|
52286
52361
|
content: {
|
|
@@ -52366,7 +52441,7 @@ export default {
|
|
|
52366
52441
|
'/user_identities/enrollment_automations/list': {
|
|
52367
52442
|
get: {
|
|
52368
52443
|
description:
|
|
52369
|
-
'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52444
|
+
'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52370
52445
|
operationId: 'userIdentitiesEnrollmentAutomationsListGet',
|
|
52371
52446
|
parameters: [
|
|
52372
52447
|
{
|
|
@@ -52423,7 +52498,7 @@ export default {
|
|
|
52423
52498
|
},
|
|
52424
52499
|
post: {
|
|
52425
52500
|
description:
|
|
52426
|
-
'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52501
|
+
'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52427
52502
|
operationId: 'userIdentitiesEnrollmentAutomationsListPost',
|
|
52428
52503
|
requestBody: {
|
|
52429
52504
|
content: {
|
|
@@ -52487,7 +52562,7 @@ export default {
|
|
|
52487
52562
|
'/user_identities/generate_instant_key': {
|
|
52488
52563
|
post: {
|
|
52489
52564
|
description:
|
|
52490
|
-
'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52565
|
+
'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52491
52566
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
52492
52567
|
requestBody: {
|
|
52493
52568
|
content: {
|
|
@@ -52550,7 +52625,7 @@ export default {
|
|
|
52550
52625
|
'/user_identities/get': {
|
|
52551
52626
|
get: {
|
|
52552
52627
|
description:
|
|
52553
|
-
'Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52628
|
+
'Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52554
52629
|
operationId: 'userIdentitiesGetGet',
|
|
52555
52630
|
responses: {
|
|
52556
52631
|
200: {
|
|
@@ -52588,7 +52663,7 @@ export default {
|
|
|
52588
52663
|
},
|
|
52589
52664
|
post: {
|
|
52590
52665
|
description:
|
|
52591
|
-
'Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52666
|
+
'Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52592
52667
|
operationId: 'userIdentitiesGetPost',
|
|
52593
52668
|
requestBody: {
|
|
52594
52669
|
content: {
|
|
@@ -52655,7 +52730,7 @@ export default {
|
|
|
52655
52730
|
'/user_identities/grant_access_to_device': {
|
|
52656
52731
|
post: {
|
|
52657
52732
|
description:
|
|
52658
|
-
'Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52733
|
+
'Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).',
|
|
52659
52734
|
operationId: 'userIdentitiesGrantAccessToDevicePost',
|
|
52660
52735
|
requestBody: {
|
|
52661
52736
|
content: {
|
|
@@ -52711,7 +52786,7 @@ export default {
|
|
|
52711
52786
|
},
|
|
52712
52787
|
put: {
|
|
52713
52788
|
description:
|
|
52714
|
-
'Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52789
|
+
'Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/).',
|
|
52715
52790
|
operationId: 'userIdentitiesGrantAccessToDevicePut',
|
|
52716
52791
|
requestBody: {
|
|
52717
52792
|
content: {
|
|
@@ -52769,7 +52844,7 @@ export default {
|
|
|
52769
52844
|
'/user_identities/list': {
|
|
52770
52845
|
get: {
|
|
52771
52846
|
description:
|
|
52772
|
-
'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52847
|
+
'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52773
52848
|
operationId: 'userIdentitiesListGet',
|
|
52774
52849
|
parameters: [
|
|
52775
52850
|
{
|
|
@@ -52830,7 +52905,7 @@ export default {
|
|
|
52830
52905
|
},
|
|
52831
52906
|
post: {
|
|
52832
52907
|
description:
|
|
52833
|
-
'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52908
|
+
'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52834
52909
|
operationId: 'userIdentitiesListPost',
|
|
52835
52910
|
requestBody: {
|
|
52836
52911
|
content: {
|
|
@@ -52894,7 +52969,7 @@ export default {
|
|
|
52894
52969
|
'/user_identities/list_accessible_devices': {
|
|
52895
52970
|
get: {
|
|
52896
52971
|
description:
|
|
52897
|
-
'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
52972
|
+
'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52898
52973
|
operationId: 'userIdentitiesListAccessibleDevicesGet',
|
|
52899
52974
|
parameters: [
|
|
52900
52975
|
{
|
|
@@ -52952,7 +53027,7 @@ export default {
|
|
|
52952
53027
|
},
|
|
52953
53028
|
post: {
|
|
52954
53029
|
description:
|
|
52955
|
-
'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53030
|
+
'Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
52956
53031
|
operationId: 'userIdentitiesListAccessibleDevicesPost',
|
|
52957
53032
|
requestBody: {
|
|
52958
53033
|
content: {
|
|
@@ -53017,7 +53092,7 @@ export default {
|
|
|
53017
53092
|
'/user_identities/list_acs_systems': {
|
|
53018
53093
|
get: {
|
|
53019
53094
|
description:
|
|
53020
|
-
'Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53095
|
+
'Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53021
53096
|
operationId: 'userIdentitiesListAcsSystemsGet',
|
|
53022
53097
|
parameters: [
|
|
53023
53098
|
{
|
|
@@ -53070,7 +53145,7 @@ export default {
|
|
|
53070
53145
|
},
|
|
53071
53146
|
post: {
|
|
53072
53147
|
description:
|
|
53073
|
-
'Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53148
|
+
'Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53074
53149
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
53075
53150
|
requestBody: {
|
|
53076
53151
|
content: {
|
|
@@ -53130,7 +53205,7 @@ export default {
|
|
|
53130
53205
|
'/user_identities/list_acs_users': {
|
|
53131
53206
|
get: {
|
|
53132
53207
|
description:
|
|
53133
|
-
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53208
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53134
53209
|
operationId: 'userIdentitiesListAcsUsersGet',
|
|
53135
53210
|
parameters: [
|
|
53136
53211
|
{
|
|
@@ -53182,7 +53257,7 @@ export default {
|
|
|
53182
53257
|
},
|
|
53183
53258
|
post: {
|
|
53184
53259
|
description:
|
|
53185
|
-
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53260
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53186
53261
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
53187
53262
|
requestBody: {
|
|
53188
53263
|
content: {
|
|
@@ -53241,7 +53316,7 @@ export default {
|
|
|
53241
53316
|
'/user_identities/remove_acs_user': {
|
|
53242
53317
|
delete: {
|
|
53243
53318
|
description:
|
|
53244
|
-
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53319
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53245
53320
|
operationId: 'userIdentitiesRemoveAcsUserDelete',
|
|
53246
53321
|
parameters: [
|
|
53247
53322
|
{
|
|
@@ -53297,7 +53372,7 @@ export default {
|
|
|
53297
53372
|
},
|
|
53298
53373
|
post: {
|
|
53299
53374
|
description:
|
|
53300
|
-
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53375
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53301
53376
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
53302
53377
|
requestBody: {
|
|
53303
53378
|
content: {
|
|
@@ -53355,7 +53430,7 @@ export default {
|
|
|
53355
53430
|
'/user_identities/revoke_access_to_device': {
|
|
53356
53431
|
delete: {
|
|
53357
53432
|
description:
|
|
53358
|
-
'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53433
|
+
'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53359
53434
|
operationId: 'userIdentitiesRevokeAccessToDeviceDelete',
|
|
53360
53435
|
parameters: [
|
|
53361
53436
|
{
|
|
@@ -53411,7 +53486,7 @@ export default {
|
|
|
53411
53486
|
},
|
|
53412
53487
|
post: {
|
|
53413
53488
|
description:
|
|
53414
|
-
'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53489
|
+
'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53415
53490
|
operationId: 'userIdentitiesRevokeAccessToDevicePost',
|
|
53416
53491
|
requestBody: {
|
|
53417
53492
|
content: {
|
|
@@ -53469,7 +53544,7 @@ export default {
|
|
|
53469
53544
|
'/user_identities/update': {
|
|
53470
53545
|
patch: {
|
|
53471
53546
|
description:
|
|
53472
|
-
'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53547
|
+
'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53473
53548
|
operationId: 'userIdentitiesUpdatePatch',
|
|
53474
53549
|
requestBody: {
|
|
53475
53550
|
content: {
|
|
@@ -53543,7 +53618,7 @@ export default {
|
|
|
53543
53618
|
},
|
|
53544
53619
|
post: {
|
|
53545
53620
|
description:
|
|
53546
|
-
'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53621
|
+
'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
53547
53622
|
operationId: 'userIdentitiesUpdatePost',
|
|
53548
53623
|
requestBody: {
|
|
53549
53624
|
content: {
|