@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
|
@@ -1964,7 +1964,7 @@ export default {
|
|
|
1964
1964
|
},
|
|
1965
1965
|
is_managed: { enum: [true], type: 'boolean' },
|
|
1966
1966
|
is_multi_phone_sync_credential: {
|
|
1967
|
-
description: '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
|
|
1967
|
+
description: '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).',
|
|
1968
1968
|
type: 'boolean',
|
|
1969
1969
|
},
|
|
1970
1970
|
is_one_time_use: {
|
|
@@ -1992,6 +1992,11 @@ export default {
|
|
|
1992
1992
|
description: '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.',
|
|
1993
1993
|
type: 'string',
|
|
1994
1994
|
},
|
|
1995
|
+
user_identity_id: {
|
|
1996
|
+
description: '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.',
|
|
1997
|
+
format: 'uuid',
|
|
1998
|
+
type: 'string',
|
|
1999
|
+
},
|
|
1995
2000
|
visionline_metadata: {
|
|
1996
2001
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
1997
2002
|
properties: {
|
|
@@ -3856,7 +3861,7 @@ export default {
|
|
|
3856
3861
|
type: 'string',
|
|
3857
3862
|
},
|
|
3858
3863
|
card_holder: {
|
|
3859
|
-
description: '
|
|
3864
|
+
description: 'Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3860
3865
|
type: 'string',
|
|
3861
3866
|
},
|
|
3862
3867
|
card_id: {
|
|
@@ -4054,7 +4059,7 @@ export default {
|
|
|
4054
4059
|
},
|
|
4055
4060
|
is_managed: { enum: [true], type: 'boolean' },
|
|
4056
4061
|
is_multi_phone_sync_credential: {
|
|
4057
|
-
description: '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
|
|
4062
|
+
description: '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).',
|
|
4058
4063
|
type: 'boolean',
|
|
4059
4064
|
},
|
|
4060
4065
|
is_one_time_use: {
|
|
@@ -4082,6 +4087,11 @@ export default {
|
|
|
4082
4087
|
description: '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.',
|
|
4083
4088
|
type: 'string',
|
|
4084
4089
|
},
|
|
4090
|
+
user_identity_id: {
|
|
4091
|
+
description: '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.',
|
|
4092
|
+
format: 'uuid',
|
|
4093
|
+
type: 'string',
|
|
4094
|
+
},
|
|
4085
4095
|
visionline_metadata: {
|
|
4086
4096
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4087
4097
|
properties: {
|
|
@@ -4437,7 +4447,7 @@ export default {
|
|
|
4437
4447
|
},
|
|
4438
4448
|
is_managed: { enum: [false], type: 'boolean' },
|
|
4439
4449
|
is_multi_phone_sync_credential: {
|
|
4440
|
-
description: '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
|
|
4450
|
+
description: '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).',
|
|
4441
4451
|
type: 'boolean',
|
|
4442
4452
|
},
|
|
4443
4453
|
is_one_time_use: {
|
|
@@ -4465,6 +4475,11 @@ export default {
|
|
|
4465
4475
|
description: '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.',
|
|
4466
4476
|
type: 'string',
|
|
4467
4477
|
},
|
|
4478
|
+
user_identity_id: {
|
|
4479
|
+
description: '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.',
|
|
4480
|
+
format: 'uuid',
|
|
4481
|
+
type: 'string',
|
|
4482
|
+
},
|
|
4468
4483
|
visionline_metadata: {
|
|
4469
4484
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4470
4485
|
properties: {
|
|
@@ -4998,7 +5013,7 @@ export default {
|
|
|
4998
5013
|
},
|
|
4999
5014
|
is_managed: { enum: [true], type: 'boolean' },
|
|
5000
5015
|
is_multi_phone_sync_credential: {
|
|
5001
|
-
description: '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
|
|
5016
|
+
description: '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).',
|
|
5002
5017
|
type: 'boolean',
|
|
5003
5018
|
},
|
|
5004
5019
|
is_one_time_use: {
|
|
@@ -5026,6 +5041,11 @@ export default {
|
|
|
5026
5041
|
description: '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.',
|
|
5027
5042
|
type: 'string',
|
|
5028
5043
|
},
|
|
5044
|
+
user_identity_id: {
|
|
5045
|
+
description: '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.',
|
|
5046
|
+
format: 'uuid',
|
|
5047
|
+
type: 'string',
|
|
5048
|
+
},
|
|
5029
5049
|
visionline_metadata: {
|
|
5030
5050
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
5031
5051
|
properties: {
|
|
@@ -5379,7 +5399,7 @@ export default {
|
|
|
5379
5399
|
},
|
|
5380
5400
|
is_managed: { enum: [false], type: 'boolean' },
|
|
5381
5401
|
is_multi_phone_sync_credential: {
|
|
5382
|
-
description: '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
|
|
5402
|
+
description: '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).',
|
|
5383
5403
|
type: 'boolean',
|
|
5384
5404
|
},
|
|
5385
5405
|
is_one_time_use: {
|
|
@@ -5407,6 +5427,11 @@ export default {
|
|
|
5407
5427
|
description: '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.',
|
|
5408
5428
|
type: 'string',
|
|
5409
5429
|
},
|
|
5430
|
+
user_identity_id: {
|
|
5431
|
+
description: '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.',
|
|
5432
|
+
format: 'uuid',
|
|
5433
|
+
type: 'string',
|
|
5434
|
+
},
|
|
5410
5435
|
visionline_metadata: {
|
|
5411
5436
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
5412
5437
|
properties: {
|
|
@@ -11302,7 +11327,7 @@ export default {
|
|
|
11302
11327
|
},
|
|
11303
11328
|
enrollment_automation: {
|
|
11304
11329
|
deprecated: true,
|
|
11305
|
-
description: 'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
11330
|
+
description: '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/).',
|
|
11306
11331
|
properties: {
|
|
11307
11332
|
created_at: {
|
|
11308
11333
|
description: 'Date and time at which the enrollment automation was created.',
|
|
@@ -11320,7 +11345,7 @@ export default {
|
|
|
11320
11345
|
type: 'string',
|
|
11321
11346
|
},
|
|
11322
11347
|
user_identity_id: {
|
|
11323
|
-
description: 'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
11348
|
+
description: '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).',
|
|
11324
11349
|
format: 'uuid',
|
|
11325
11350
|
type: 'string',
|
|
11326
11351
|
},
|
|
@@ -16847,7 +16872,7 @@ export default {
|
|
|
16847
16872
|
},
|
|
16848
16873
|
is_managed: { enum: [true], type: 'boolean' },
|
|
16849
16874
|
is_multi_phone_sync_credential: {
|
|
16850
|
-
description: '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
|
|
16875
|
+
description: '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).',
|
|
16851
16876
|
type: 'boolean',
|
|
16852
16877
|
},
|
|
16853
16878
|
is_one_time_use: {
|
|
@@ -16875,6 +16900,11 @@ export default {
|
|
|
16875
16900
|
description: '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.',
|
|
16876
16901
|
type: 'string',
|
|
16877
16902
|
},
|
|
16903
|
+
user_identity_id: {
|
|
16904
|
+
description: '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.',
|
|
16905
|
+
format: 'uuid',
|
|
16906
|
+
type: 'string',
|
|
16907
|
+
},
|
|
16878
16908
|
visionline_metadata: {
|
|
16879
16909
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
16880
16910
|
properties: {
|
|
@@ -19082,7 +19112,7 @@ export default {
|
|
|
19082
19112
|
},
|
|
19083
19113
|
is_managed: { enum: [false], type: 'boolean' },
|
|
19084
19114
|
is_multi_phone_sync_credential: {
|
|
19085
|
-
description: '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
|
|
19115
|
+
description: '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).',
|
|
19086
19116
|
type: 'boolean',
|
|
19087
19117
|
},
|
|
19088
19118
|
is_one_time_use: {
|
|
@@ -19110,6 +19140,11 @@ export default {
|
|
|
19110
19140
|
description: '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.',
|
|
19111
19141
|
type: 'string',
|
|
19112
19142
|
},
|
|
19143
|
+
user_identity_id: {
|
|
19144
|
+
description: '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.',
|
|
19145
|
+
format: 'uuid',
|
|
19146
|
+
type: 'string',
|
|
19147
|
+
},
|
|
19113
19148
|
visionline_metadata: {
|
|
19114
19149
|
description: 'Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
19115
19150
|
properties: {
|
|
@@ -21185,21 +21220,49 @@ export default {
|
|
|
21185
21220
|
type: 'string',
|
|
21186
21221
|
},
|
|
21187
21222
|
errors: {
|
|
21188
|
-
description: 'Array of errors associated with the user identity. Each error object within the array contains
|
|
21223
|
+
description: '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.',
|
|
21189
21224
|
items: {
|
|
21190
|
-
|
|
21191
|
-
|
|
21192
|
-
|
|
21193
|
-
|
|
21194
|
-
|
|
21195
|
-
|
|
21196
|
-
|
|
21197
|
-
|
|
21198
|
-
|
|
21225
|
+
description: 'Errors associated with the user identity.',
|
|
21226
|
+
discriminator: { propertyName: 'error_code' },
|
|
21227
|
+
oneOf: [
|
|
21228
|
+
{
|
|
21229
|
+
description: 'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
21230
|
+
properties: {
|
|
21231
|
+
acs_system_id: {
|
|
21232
|
+
description: 'ID of the access system that the user identity is associated with.',
|
|
21233
|
+
format: 'uuid',
|
|
21234
|
+
type: 'string',
|
|
21235
|
+
},
|
|
21236
|
+
acs_user_id: {
|
|
21237
|
+
description: 'ID of the access system user that has an issue.',
|
|
21238
|
+
format: 'uuid',
|
|
21239
|
+
type: 'string',
|
|
21240
|
+
},
|
|
21241
|
+
created_at: {
|
|
21242
|
+
description: 'Date and time at which Seam created the error.',
|
|
21243
|
+
format: 'date-time',
|
|
21244
|
+
type: 'string',
|
|
21245
|
+
},
|
|
21246
|
+
error_code: {
|
|
21247
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
21248
|
+
enum: ['issue_with_acs_user'],
|
|
21249
|
+
type: 'string',
|
|
21250
|
+
},
|
|
21251
|
+
message: {
|
|
21252
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
21253
|
+
type: 'string',
|
|
21254
|
+
},
|
|
21255
|
+
},
|
|
21256
|
+
required: [
|
|
21257
|
+
'created_at',
|
|
21258
|
+
'message',
|
|
21259
|
+
'error_code',
|
|
21260
|
+
'acs_user_id',
|
|
21261
|
+
'acs_system_id',
|
|
21262
|
+
],
|
|
21263
|
+
type: 'object',
|
|
21199
21264
|
},
|
|
21200
|
-
|
|
21201
|
-
required: ['created_at', 'message'],
|
|
21202
|
-
type: 'object',
|
|
21265
|
+
],
|
|
21203
21266
|
},
|
|
21204
21267
|
type: 'array',
|
|
21205
21268
|
},
|
|
@@ -26090,7 +26153,7 @@ export default {
|
|
|
26090
26153
|
},
|
|
26091
26154
|
is_multi_phone_sync_credential: {
|
|
26092
26155
|
default: false,
|
|
26093
|
-
description: 'Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
26156
|
+
description: '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).',
|
|
26094
26157
|
type: 'boolean',
|
|
26095
26158
|
},
|
|
26096
26159
|
salto_space_metadata: {
|
|
@@ -47827,7 +47890,7 @@ export default {
|
|
|
47827
47890
|
},
|
|
47828
47891
|
'/user_identities/add_acs_user': {
|
|
47829
47892
|
post: {
|
|
47830
|
-
description: '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
|
|
47893
|
+
description: '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).',
|
|
47831
47894
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
47832
47895
|
requestBody: {
|
|
47833
47896
|
content: {
|
|
@@ -47880,7 +47943,7 @@ export default {
|
|
|
47880
47943
|
'x-title': 'Add an ACS User to a User Identity',
|
|
47881
47944
|
},
|
|
47882
47945
|
put: {
|
|
47883
|
-
description: '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
|
|
47946
|
+
description: '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).',
|
|
47884
47947
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
47885
47948
|
requestBody: {
|
|
47886
47949
|
content: {
|
|
@@ -47935,7 +47998,7 @@ export default {
|
|
|
47935
47998
|
},
|
|
47936
47999
|
'/user_identities/create': {
|
|
47937
48000
|
post: {
|
|
47938
|
-
description: 'Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48001
|
+
description: '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).',
|
|
47939
48002
|
operationId: 'userIdentitiesCreatePost',
|
|
47940
48003
|
requestBody: {
|
|
47941
48004
|
content: {
|
|
@@ -48013,7 +48076,7 @@ export default {
|
|
|
48013
48076
|
},
|
|
48014
48077
|
'/user_identities/delete': {
|
|
48015
48078
|
delete: {
|
|
48016
|
-
description: 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48079
|
+
description: '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).',
|
|
48017
48080
|
operationId: 'userIdentitiesDeleteDelete',
|
|
48018
48081
|
parameters: [
|
|
48019
48082
|
{
|
|
@@ -48056,7 +48119,7 @@ export default {
|
|
|
48056
48119
|
'x-title': 'Delete a User Identity',
|
|
48057
48120
|
},
|
|
48058
48121
|
post: {
|
|
48059
|
-
description: 'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48122
|
+
description: '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).',
|
|
48060
48123
|
operationId: 'userIdentitiesDeletePost',
|
|
48061
48124
|
requestBody: {
|
|
48062
48125
|
content: {
|
|
@@ -48106,7 +48169,7 @@ export default {
|
|
|
48106
48169
|
},
|
|
48107
48170
|
'/user_identities/enrollment_automations/delete': {
|
|
48108
48171
|
delete: {
|
|
48109
|
-
description: 'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48172
|
+
description: '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).',
|
|
48110
48173
|
operationId: 'userIdentitiesEnrollmentAutomationsDeleteDelete',
|
|
48111
48174
|
parameters: [
|
|
48112
48175
|
{
|
|
@@ -48150,7 +48213,7 @@ export default {
|
|
|
48150
48213
|
'x-title': 'Delete an Enrollment Automation',
|
|
48151
48214
|
},
|
|
48152
48215
|
post: {
|
|
48153
|
-
description: 'Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48216
|
+
description: '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).',
|
|
48154
48217
|
operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
|
|
48155
48218
|
requestBody: {
|
|
48156
48219
|
content: {
|
|
@@ -48201,7 +48264,7 @@ export default {
|
|
|
48201
48264
|
},
|
|
48202
48265
|
'/user_identities/enrollment_automations/get': {
|
|
48203
48266
|
get: {
|
|
48204
|
-
description: 'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48267
|
+
description: 'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).',
|
|
48205
48268
|
operationId: 'userIdentitiesEnrollmentAutomationsGetGet',
|
|
48206
48269
|
parameters: [
|
|
48207
48270
|
{
|
|
@@ -48252,7 +48315,7 @@ export default {
|
|
|
48252
48315
|
'x-title': 'Get an Enrollment Automation',
|
|
48253
48316
|
},
|
|
48254
48317
|
post: {
|
|
48255
|
-
description: 'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48318
|
+
description: 'Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).',
|
|
48256
48319
|
operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
|
|
48257
48320
|
requestBody: {
|
|
48258
48321
|
content: {
|
|
@@ -48310,7 +48373,7 @@ export default {
|
|
|
48310
48373
|
},
|
|
48311
48374
|
'/user_identities/enrollment_automations/launch': {
|
|
48312
48375
|
post: {
|
|
48313
|
-
description: 'Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48376
|
+
description: '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).',
|
|
48314
48377
|
operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
|
|
48315
48378
|
requestBody: {
|
|
48316
48379
|
content: {
|
|
@@ -48389,7 +48452,7 @@ export default {
|
|
|
48389
48452
|
},
|
|
48390
48453
|
'/user_identities/enrollment_automations/list': {
|
|
48391
48454
|
get: {
|
|
48392
|
-
description: 'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48455
|
+
description: '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).',
|
|
48393
48456
|
operationId: 'userIdentitiesEnrollmentAutomationsListGet',
|
|
48394
48457
|
parameters: [
|
|
48395
48458
|
{
|
|
@@ -48443,7 +48506,7 @@ export default {
|
|
|
48443
48506
|
'x-title': 'List Enrollment Automations',
|
|
48444
48507
|
},
|
|
48445
48508
|
post: {
|
|
48446
|
-
description: 'Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48509
|
+
description: '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).',
|
|
48447
48510
|
operationId: 'userIdentitiesEnrollmentAutomationsListPost',
|
|
48448
48511
|
requestBody: {
|
|
48449
48512
|
content: {
|
|
@@ -48504,7 +48567,7 @@ export default {
|
|
|
48504
48567
|
},
|
|
48505
48568
|
'/user_identities/generate_instant_key': {
|
|
48506
48569
|
post: {
|
|
48507
|
-
description: 'Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48570
|
+
description: '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).',
|
|
48508
48571
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
48509
48572
|
requestBody: {
|
|
48510
48573
|
content: {
|
|
@@ -48564,7 +48627,7 @@ export default {
|
|
|
48564
48627
|
},
|
|
48565
48628
|
'/user_identities/get': {
|
|
48566
48629
|
get: {
|
|
48567
|
-
description: 'Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48630
|
+
description: '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).',
|
|
48568
48631
|
operationId: 'userIdentitiesGetGet',
|
|
48569
48632
|
responses: {
|
|
48570
48633
|
200: {
|
|
@@ -48601,7 +48664,7 @@ export default {
|
|
|
48601
48664
|
'x-title': 'Get a User Identity',
|
|
48602
48665
|
},
|
|
48603
48666
|
post: {
|
|
48604
|
-
description: 'Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48667
|
+
description: '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).',
|
|
48605
48668
|
operationId: 'userIdentitiesGetPost',
|
|
48606
48669
|
requestBody: {
|
|
48607
48670
|
content: {
|
|
@@ -48666,7 +48729,7 @@ export default {
|
|
|
48666
48729
|
},
|
|
48667
48730
|
'/user_identities/grant_access_to_device': {
|
|
48668
48731
|
post: {
|
|
48669
|
-
description: 'Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48732
|
+
description: '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/).',
|
|
48670
48733
|
operationId: 'userIdentitiesGrantAccessToDevicePost',
|
|
48671
48734
|
requestBody: {
|
|
48672
48735
|
content: {
|
|
@@ -48719,7 +48782,7 @@ export default {
|
|
|
48719
48782
|
'x-title': 'Grant a User Identity Access to a Device',
|
|
48720
48783
|
},
|
|
48721
48784
|
put: {
|
|
48722
|
-
description: 'Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48785
|
+
description: '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/).',
|
|
48723
48786
|
operationId: 'userIdentitiesGrantAccessToDevicePut',
|
|
48724
48787
|
requestBody: {
|
|
48725
48788
|
content: {
|
|
@@ -48774,7 +48837,7 @@ export default {
|
|
|
48774
48837
|
},
|
|
48775
48838
|
'/user_identities/list': {
|
|
48776
48839
|
get: {
|
|
48777
|
-
description: 'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48840
|
+
description: '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).',
|
|
48778
48841
|
operationId: 'userIdentitiesListGet',
|
|
48779
48842
|
parameters: [
|
|
48780
48843
|
{
|
|
@@ -48832,7 +48895,7 @@ export default {
|
|
|
48832
48895
|
'x-title': 'List User Identities',
|
|
48833
48896
|
},
|
|
48834
48897
|
post: {
|
|
48835
|
-
description: 'Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
48898
|
+
description: '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).',
|
|
48836
48899
|
operationId: 'userIdentitiesListPost',
|
|
48837
48900
|
requestBody: {
|
|
48838
48901
|
content: {
|
|
@@ -48893,7 +48956,7 @@ export default {
|
|
|
48893
48956
|
},
|
|
48894
48957
|
'/user_identities/list_accessible_devices': {
|
|
48895
48958
|
get: {
|
|
48896
|
-
description: '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
|
|
48959
|
+
description: '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).',
|
|
48897
48960
|
operationId: 'userIdentitiesListAccessibleDevicesGet',
|
|
48898
48961
|
parameters: [
|
|
48899
48962
|
{
|
|
@@ -48949,7 +49012,7 @@ export default {
|
|
|
48949
49012
|
'x-title': 'List Accessible Devices for a User Identity',
|
|
48950
49013
|
},
|
|
48951
49014
|
post: {
|
|
48952
|
-
description: '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
|
|
49015
|
+
description: '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).',
|
|
48953
49016
|
operationId: 'userIdentitiesListAccessibleDevicesPost',
|
|
48954
49017
|
requestBody: {
|
|
48955
49018
|
content: {
|
|
@@ -49012,7 +49075,7 @@ export default {
|
|
|
49012
49075
|
},
|
|
49013
49076
|
'/user_identities/list_acs_systems': {
|
|
49014
49077
|
get: {
|
|
49015
|
-
description: '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
|
|
49078
|
+
description: '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).',
|
|
49016
49079
|
operationId: 'userIdentitiesListAcsSystemsGet',
|
|
49017
49080
|
parameters: [
|
|
49018
49081
|
{
|
|
@@ -49063,7 +49126,7 @@ export default {
|
|
|
49063
49126
|
'x-title': 'List ACS Systems Associated with a User Identity',
|
|
49064
49127
|
},
|
|
49065
49128
|
post: {
|
|
49066
|
-
description: '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
|
|
49129
|
+
description: '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).',
|
|
49067
49130
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
49068
49131
|
requestBody: {
|
|
49069
49132
|
content: {
|
|
@@ -49121,7 +49184,7 @@ export default {
|
|
|
49121
49184
|
},
|
|
49122
49185
|
'/user_identities/list_acs_users': {
|
|
49123
49186
|
get: {
|
|
49124
|
-
description: '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
|
|
49187
|
+
description: '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).',
|
|
49125
49188
|
operationId: 'userIdentitiesListAcsUsersGet',
|
|
49126
49189
|
parameters: [
|
|
49127
49190
|
{
|
|
@@ -49171,7 +49234,7 @@ export default {
|
|
|
49171
49234
|
'x-title': 'List ACS Users Associated with a User Identity',
|
|
49172
49235
|
},
|
|
49173
49236
|
post: {
|
|
49174
|
-
description: '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
|
|
49237
|
+
description: '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).',
|
|
49175
49238
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
49176
49239
|
requestBody: {
|
|
49177
49240
|
content: {
|
|
@@ -49228,7 +49291,7 @@ export default {
|
|
|
49228
49291
|
},
|
|
49229
49292
|
'/user_identities/remove_acs_user': {
|
|
49230
49293
|
delete: {
|
|
49231
|
-
description: '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
|
|
49294
|
+
description: '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).',
|
|
49232
49295
|
operationId: 'userIdentitiesRemoveAcsUserDelete',
|
|
49233
49296
|
parameters: [
|
|
49234
49297
|
{
|
|
@@ -49281,7 +49344,7 @@ export default {
|
|
|
49281
49344
|
'x-title': 'Remove an ACS User from a User Identity',
|
|
49282
49345
|
},
|
|
49283
49346
|
post: {
|
|
49284
|
-
description: '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
|
|
49347
|
+
description: '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).',
|
|
49285
49348
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
49286
49349
|
requestBody: {
|
|
49287
49350
|
content: {
|
|
@@ -49336,7 +49399,7 @@ export default {
|
|
|
49336
49399
|
},
|
|
49337
49400
|
'/user_identities/revoke_access_to_device': {
|
|
49338
49401
|
delete: {
|
|
49339
|
-
description: '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
|
|
49402
|
+
description: '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).',
|
|
49340
49403
|
operationId: 'userIdentitiesRevokeAccessToDeviceDelete',
|
|
49341
49404
|
parameters: [
|
|
49342
49405
|
{
|
|
@@ -49389,7 +49452,7 @@ export default {
|
|
|
49389
49452
|
'x-title': 'Revoke Access to a Device from a User Identity',
|
|
49390
49453
|
},
|
|
49391
49454
|
post: {
|
|
49392
|
-
description: '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
|
|
49455
|
+
description: '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).',
|
|
49393
49456
|
operationId: 'userIdentitiesRevokeAccessToDevicePost',
|
|
49394
49457
|
requestBody: {
|
|
49395
49458
|
content: {
|
|
@@ -49444,7 +49507,7 @@ export default {
|
|
|
49444
49507
|
},
|
|
49445
49508
|
'/user_identities/update': {
|
|
49446
49509
|
patch: {
|
|
49447
|
-
description: 'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
49510
|
+
description: '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).',
|
|
49448
49511
|
operationId: 'userIdentitiesUpdatePatch',
|
|
49449
49512
|
requestBody: {
|
|
49450
49513
|
content: {
|
|
@@ -49515,7 +49578,7 @@ export default {
|
|
|
49515
49578
|
'x-title': 'Update a User Identity',
|
|
49516
49579
|
},
|
|
49517
49580
|
post: {
|
|
49518
|
-
description: 'Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
49581
|
+
description: '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).',
|
|
49519
49582
|
operationId: 'userIdentitiesUpdatePost',
|
|
49520
49583
|
requestBody: {
|
|
49521
49584
|
content: {
|