@seamapi/types 1.431.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 +104 -60
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +222 -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.js +2 -2
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- 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 +34 -12
- package/lib/seam/connect/openapi.js +83 -55
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +169 -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 +2 -2
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +37 -3
- package/src/lib/seam/connect/openapi.ts +88 -55
- package/src/lib/seam/connect/route-types.ts +169 -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: {
|
|
@@ -3861,7 +3861,7 @@ export default {
|
|
|
3861
3861
|
type: 'string',
|
|
3862
3862
|
},
|
|
3863
3863
|
card_holder: {
|
|
3864
|
-
description: '
|
|
3864
|
+
description: 'Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
3865
3865
|
type: 'string',
|
|
3866
3866
|
},
|
|
3867
3867
|
card_id: {
|
|
@@ -4059,7 +4059,7 @@ export default {
|
|
|
4059
4059
|
},
|
|
4060
4060
|
is_managed: { enum: [true], type: 'boolean' },
|
|
4061
4061
|
is_multi_phone_sync_credential: {
|
|
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
|
|
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).',
|
|
4063
4063
|
type: 'boolean',
|
|
4064
4064
|
},
|
|
4065
4065
|
is_one_time_use: {
|
|
@@ -4447,7 +4447,7 @@ export default {
|
|
|
4447
4447
|
},
|
|
4448
4448
|
is_managed: { enum: [false], type: 'boolean' },
|
|
4449
4449
|
is_multi_phone_sync_credential: {
|
|
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
|
|
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).',
|
|
4451
4451
|
type: 'boolean',
|
|
4452
4452
|
},
|
|
4453
4453
|
is_one_time_use: {
|
|
@@ -5013,7 +5013,7 @@ export default {
|
|
|
5013
5013
|
},
|
|
5014
5014
|
is_managed: { enum: [true], type: 'boolean' },
|
|
5015
5015
|
is_multi_phone_sync_credential: {
|
|
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
|
|
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).',
|
|
5017
5017
|
type: 'boolean',
|
|
5018
5018
|
},
|
|
5019
5019
|
is_one_time_use: {
|
|
@@ -5399,7 +5399,7 @@ export default {
|
|
|
5399
5399
|
},
|
|
5400
5400
|
is_managed: { enum: [false], type: 'boolean' },
|
|
5401
5401
|
is_multi_phone_sync_credential: {
|
|
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
|
|
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).',
|
|
5403
5403
|
type: 'boolean',
|
|
5404
5404
|
},
|
|
5405
5405
|
is_one_time_use: {
|
|
@@ -11327,7 +11327,7 @@ export default {
|
|
|
11327
11327
|
},
|
|
11328
11328
|
enrollment_automation: {
|
|
11329
11329
|
deprecated: true,
|
|
11330
|
-
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/).',
|
|
11331
11331
|
properties: {
|
|
11332
11332
|
created_at: {
|
|
11333
11333
|
description: 'Date and time at which the enrollment automation was created.',
|
|
@@ -11345,7 +11345,7 @@ export default {
|
|
|
11345
11345
|
type: 'string',
|
|
11346
11346
|
},
|
|
11347
11347
|
user_identity_id: {
|
|
11348
|
-
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).',
|
|
11349
11349
|
format: 'uuid',
|
|
11350
11350
|
type: 'string',
|
|
11351
11351
|
},
|
|
@@ -16872,7 +16872,7 @@ export default {
|
|
|
16872
16872
|
},
|
|
16873
16873
|
is_managed: { enum: [true], type: 'boolean' },
|
|
16874
16874
|
is_multi_phone_sync_credential: {
|
|
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
|
|
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).',
|
|
16876
16876
|
type: 'boolean',
|
|
16877
16877
|
},
|
|
16878
16878
|
is_one_time_use: {
|
|
@@ -19112,7 +19112,7 @@ export default {
|
|
|
19112
19112
|
},
|
|
19113
19113
|
is_managed: { enum: [false], type: 'boolean' },
|
|
19114
19114
|
is_multi_phone_sync_credential: {
|
|
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
|
|
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).',
|
|
19116
19116
|
type: 'boolean',
|
|
19117
19117
|
},
|
|
19118
19118
|
is_one_time_use: {
|
|
@@ -21220,21 +21220,49 @@ export default {
|
|
|
21220
21220
|
type: 'string',
|
|
21221
21221
|
},
|
|
21222
21222
|
errors: {
|
|
21223
|
-
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.',
|
|
21224
21224
|
items: {
|
|
21225
|
-
|
|
21226
|
-
|
|
21227
|
-
|
|
21228
|
-
|
|
21229
|
-
|
|
21230
|
-
|
|
21231
|
-
|
|
21232
|
-
|
|
21233
|
-
|
|
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',
|
|
21234
21264
|
},
|
|
21235
|
-
|
|
21236
|
-
required: ['created_at', 'message'],
|
|
21237
|
-
type: 'object',
|
|
21265
|
+
],
|
|
21238
21266
|
},
|
|
21239
21267
|
type: 'array',
|
|
21240
21268
|
},
|
|
@@ -26125,7 +26153,7 @@ export default {
|
|
|
26125
26153
|
},
|
|
26126
26154
|
is_multi_phone_sync_credential: {
|
|
26127
26155
|
default: false,
|
|
26128
|
-
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).',
|
|
26129
26157
|
type: 'boolean',
|
|
26130
26158
|
},
|
|
26131
26159
|
salto_space_metadata: {
|
|
@@ -47862,7 +47890,7 @@ export default {
|
|
|
47862
47890
|
},
|
|
47863
47891
|
'/user_identities/add_acs_user': {
|
|
47864
47892
|
post: {
|
|
47865
|
-
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).',
|
|
47866
47894
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
47867
47895
|
requestBody: {
|
|
47868
47896
|
content: {
|
|
@@ -47915,7 +47943,7 @@ export default {
|
|
|
47915
47943
|
'x-title': 'Add an ACS User to a User Identity',
|
|
47916
47944
|
},
|
|
47917
47945
|
put: {
|
|
47918
|
-
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).',
|
|
47919
47947
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
47920
47948
|
requestBody: {
|
|
47921
47949
|
content: {
|
|
@@ -47970,7 +47998,7 @@ export default {
|
|
|
47970
47998
|
},
|
|
47971
47999
|
'/user_identities/create': {
|
|
47972
48000
|
post: {
|
|
47973
|
-
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).',
|
|
47974
48002
|
operationId: 'userIdentitiesCreatePost',
|
|
47975
48003
|
requestBody: {
|
|
47976
48004
|
content: {
|
|
@@ -48048,7 +48076,7 @@ export default {
|
|
|
48048
48076
|
},
|
|
48049
48077
|
'/user_identities/delete': {
|
|
48050
48078
|
delete: {
|
|
48051
|
-
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).',
|
|
48052
48080
|
operationId: 'userIdentitiesDeleteDelete',
|
|
48053
48081
|
parameters: [
|
|
48054
48082
|
{
|
|
@@ -48091,7 +48119,7 @@ export default {
|
|
|
48091
48119
|
'x-title': 'Delete a User Identity',
|
|
48092
48120
|
},
|
|
48093
48121
|
post: {
|
|
48094
|
-
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).',
|
|
48095
48123
|
operationId: 'userIdentitiesDeletePost',
|
|
48096
48124
|
requestBody: {
|
|
48097
48125
|
content: {
|
|
@@ -48141,7 +48169,7 @@ export default {
|
|
|
48141
48169
|
},
|
|
48142
48170
|
'/user_identities/enrollment_automations/delete': {
|
|
48143
48171
|
delete: {
|
|
48144
|
-
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).',
|
|
48145
48173
|
operationId: 'userIdentitiesEnrollmentAutomationsDeleteDelete',
|
|
48146
48174
|
parameters: [
|
|
48147
48175
|
{
|
|
@@ -48185,7 +48213,7 @@ export default {
|
|
|
48185
48213
|
'x-title': 'Delete an Enrollment Automation',
|
|
48186
48214
|
},
|
|
48187
48215
|
post: {
|
|
48188
|
-
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).',
|
|
48189
48217
|
operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
|
|
48190
48218
|
requestBody: {
|
|
48191
48219
|
content: {
|
|
@@ -48236,7 +48264,7 @@ export default {
|
|
|
48236
48264
|
},
|
|
48237
48265
|
'/user_identities/enrollment_automations/get': {
|
|
48238
48266
|
get: {
|
|
48239
|
-
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/).',
|
|
48240
48268
|
operationId: 'userIdentitiesEnrollmentAutomationsGetGet',
|
|
48241
48269
|
parameters: [
|
|
48242
48270
|
{
|
|
@@ -48287,7 +48315,7 @@ export default {
|
|
|
48287
48315
|
'x-title': 'Get an Enrollment Automation',
|
|
48288
48316
|
},
|
|
48289
48317
|
post: {
|
|
48290
|
-
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/).',
|
|
48291
48319
|
operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
|
|
48292
48320
|
requestBody: {
|
|
48293
48321
|
content: {
|
|
@@ -48345,7 +48373,7 @@ export default {
|
|
|
48345
48373
|
},
|
|
48346
48374
|
'/user_identities/enrollment_automations/launch': {
|
|
48347
48375
|
post: {
|
|
48348
|
-
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).',
|
|
48349
48377
|
operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
|
|
48350
48378
|
requestBody: {
|
|
48351
48379
|
content: {
|
|
@@ -48424,7 +48452,7 @@ export default {
|
|
|
48424
48452
|
},
|
|
48425
48453
|
'/user_identities/enrollment_automations/list': {
|
|
48426
48454
|
get: {
|
|
48427
|
-
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).',
|
|
48428
48456
|
operationId: 'userIdentitiesEnrollmentAutomationsListGet',
|
|
48429
48457
|
parameters: [
|
|
48430
48458
|
{
|
|
@@ -48478,7 +48506,7 @@ export default {
|
|
|
48478
48506
|
'x-title': 'List Enrollment Automations',
|
|
48479
48507
|
},
|
|
48480
48508
|
post: {
|
|
48481
|
-
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).',
|
|
48482
48510
|
operationId: 'userIdentitiesEnrollmentAutomationsListPost',
|
|
48483
48511
|
requestBody: {
|
|
48484
48512
|
content: {
|
|
@@ -48539,7 +48567,7 @@ export default {
|
|
|
48539
48567
|
},
|
|
48540
48568
|
'/user_identities/generate_instant_key': {
|
|
48541
48569
|
post: {
|
|
48542
|
-
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).',
|
|
48543
48571
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
48544
48572
|
requestBody: {
|
|
48545
48573
|
content: {
|
|
@@ -48599,7 +48627,7 @@ export default {
|
|
|
48599
48627
|
},
|
|
48600
48628
|
'/user_identities/get': {
|
|
48601
48629
|
get: {
|
|
48602
|
-
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).',
|
|
48603
48631
|
operationId: 'userIdentitiesGetGet',
|
|
48604
48632
|
responses: {
|
|
48605
48633
|
200: {
|
|
@@ -48636,7 +48664,7 @@ export default {
|
|
|
48636
48664
|
'x-title': 'Get a User Identity',
|
|
48637
48665
|
},
|
|
48638
48666
|
post: {
|
|
48639
|
-
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).',
|
|
48640
48668
|
operationId: 'userIdentitiesGetPost',
|
|
48641
48669
|
requestBody: {
|
|
48642
48670
|
content: {
|
|
@@ -48701,7 +48729,7 @@ export default {
|
|
|
48701
48729
|
},
|
|
48702
48730
|
'/user_identities/grant_access_to_device': {
|
|
48703
48731
|
post: {
|
|
48704
|
-
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/).',
|
|
48705
48733
|
operationId: 'userIdentitiesGrantAccessToDevicePost',
|
|
48706
48734
|
requestBody: {
|
|
48707
48735
|
content: {
|
|
@@ -48754,7 +48782,7 @@ export default {
|
|
|
48754
48782
|
'x-title': 'Grant a User Identity Access to a Device',
|
|
48755
48783
|
},
|
|
48756
48784
|
put: {
|
|
48757
|
-
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/).',
|
|
48758
48786
|
operationId: 'userIdentitiesGrantAccessToDevicePut',
|
|
48759
48787
|
requestBody: {
|
|
48760
48788
|
content: {
|
|
@@ -48809,7 +48837,7 @@ export default {
|
|
|
48809
48837
|
},
|
|
48810
48838
|
'/user_identities/list': {
|
|
48811
48839
|
get: {
|
|
48812
|
-
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).',
|
|
48813
48841
|
operationId: 'userIdentitiesListGet',
|
|
48814
48842
|
parameters: [
|
|
48815
48843
|
{
|
|
@@ -48867,7 +48895,7 @@ export default {
|
|
|
48867
48895
|
'x-title': 'List User Identities',
|
|
48868
48896
|
},
|
|
48869
48897
|
post: {
|
|
48870
|
-
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).',
|
|
48871
48899
|
operationId: 'userIdentitiesListPost',
|
|
48872
48900
|
requestBody: {
|
|
48873
48901
|
content: {
|
|
@@ -48928,7 +48956,7 @@ export default {
|
|
|
48928
48956
|
},
|
|
48929
48957
|
'/user_identities/list_accessible_devices': {
|
|
48930
48958
|
get: {
|
|
48931
|
-
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).',
|
|
48932
48960
|
operationId: 'userIdentitiesListAccessibleDevicesGet',
|
|
48933
48961
|
parameters: [
|
|
48934
48962
|
{
|
|
@@ -48984,7 +49012,7 @@ export default {
|
|
|
48984
49012
|
'x-title': 'List Accessible Devices for a User Identity',
|
|
48985
49013
|
},
|
|
48986
49014
|
post: {
|
|
48987
|
-
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).',
|
|
48988
49016
|
operationId: 'userIdentitiesListAccessibleDevicesPost',
|
|
48989
49017
|
requestBody: {
|
|
48990
49018
|
content: {
|
|
@@ -49047,7 +49075,7 @@ export default {
|
|
|
49047
49075
|
},
|
|
49048
49076
|
'/user_identities/list_acs_systems': {
|
|
49049
49077
|
get: {
|
|
49050
|
-
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).',
|
|
49051
49079
|
operationId: 'userIdentitiesListAcsSystemsGet',
|
|
49052
49080
|
parameters: [
|
|
49053
49081
|
{
|
|
@@ -49098,7 +49126,7 @@ export default {
|
|
|
49098
49126
|
'x-title': 'List ACS Systems Associated with a User Identity',
|
|
49099
49127
|
},
|
|
49100
49128
|
post: {
|
|
49101
|
-
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).',
|
|
49102
49130
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
49103
49131
|
requestBody: {
|
|
49104
49132
|
content: {
|
|
@@ -49156,7 +49184,7 @@ export default {
|
|
|
49156
49184
|
},
|
|
49157
49185
|
'/user_identities/list_acs_users': {
|
|
49158
49186
|
get: {
|
|
49159
|
-
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).',
|
|
49160
49188
|
operationId: 'userIdentitiesListAcsUsersGet',
|
|
49161
49189
|
parameters: [
|
|
49162
49190
|
{
|
|
@@ -49206,7 +49234,7 @@ export default {
|
|
|
49206
49234
|
'x-title': 'List ACS Users Associated with a User Identity',
|
|
49207
49235
|
},
|
|
49208
49236
|
post: {
|
|
49209
|
-
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).',
|
|
49210
49238
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
49211
49239
|
requestBody: {
|
|
49212
49240
|
content: {
|
|
@@ -49263,7 +49291,7 @@ export default {
|
|
|
49263
49291
|
},
|
|
49264
49292
|
'/user_identities/remove_acs_user': {
|
|
49265
49293
|
delete: {
|
|
49266
|
-
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).',
|
|
49267
49295
|
operationId: 'userIdentitiesRemoveAcsUserDelete',
|
|
49268
49296
|
parameters: [
|
|
49269
49297
|
{
|
|
@@ -49316,7 +49344,7 @@ export default {
|
|
|
49316
49344
|
'x-title': 'Remove an ACS User from a User Identity',
|
|
49317
49345
|
},
|
|
49318
49346
|
post: {
|
|
49319
|
-
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).',
|
|
49320
49348
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
49321
49349
|
requestBody: {
|
|
49322
49350
|
content: {
|
|
@@ -49371,7 +49399,7 @@ export default {
|
|
|
49371
49399
|
},
|
|
49372
49400
|
'/user_identities/revoke_access_to_device': {
|
|
49373
49401
|
delete: {
|
|
49374
|
-
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).',
|
|
49375
49403
|
operationId: 'userIdentitiesRevokeAccessToDeviceDelete',
|
|
49376
49404
|
parameters: [
|
|
49377
49405
|
{
|
|
@@ -49424,7 +49452,7 @@ export default {
|
|
|
49424
49452
|
'x-title': 'Revoke Access to a Device from a User Identity',
|
|
49425
49453
|
},
|
|
49426
49454
|
post: {
|
|
49427
|
-
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).',
|
|
49428
49456
|
operationId: 'userIdentitiesRevokeAccessToDevicePost',
|
|
49429
49457
|
requestBody: {
|
|
49430
49458
|
content: {
|
|
@@ -49479,7 +49507,7 @@ export default {
|
|
|
49479
49507
|
},
|
|
49480
49508
|
'/user_identities/update': {
|
|
49481
49509
|
patch: {
|
|
49482
|
-
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).',
|
|
49483
49511
|
operationId: 'userIdentitiesUpdatePatch',
|
|
49484
49512
|
requestBody: {
|
|
49485
49513
|
content: {
|
|
@@ -49550,7 +49578,7 @@ export default {
|
|
|
49550
49578
|
'x-title': 'Update a User Identity',
|
|
49551
49579
|
},
|
|
49552
49580
|
post: {
|
|
49553
|
-
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).',
|
|
49554
49582
|
operationId: 'userIdentitiesUpdatePost',
|
|
49555
49583
|
requestBody: {
|
|
49556
49584
|
content: {
|