@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
package/package.json
CHANGED
|
@@ -29,7 +29,7 @@ export const enrollment_automation = z.object({
|
|
|
29
29
|
.string()
|
|
30
30
|
.uuid()
|
|
31
31
|
.describe(
|
|
32
|
-
'ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
32
|
+
'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).',
|
|
33
33
|
),
|
|
34
34
|
created_at: z
|
|
35
35
|
.string()
|
|
@@ -46,7 +46,7 @@ export const enrollment_automation = z.object({
|
|
|
46
46
|
route_path: /user_identities/enrollment_automations
|
|
47
47
|
deprecated: Will be removed. Instead, link the \`user_identity\` to the \`acs_user\` in the access system in which you want to issue credentials.
|
|
48
48
|
---
|
|
49
|
-
Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
49
|
+
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/).
|
|
50
50
|
`)
|
|
51
51
|
|
|
52
52
|
export type EnrollmentAutomation = z.output<typeof enrollment_automation>
|
|
@@ -266,7 +266,7 @@ const common_acs_credential = z.object({
|
|
|
266
266
|
.boolean()
|
|
267
267
|
.optional()
|
|
268
268
|
.describe(
|
|
269
|
-
'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
|
|
269
|
+
'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).',
|
|
270
270
|
),
|
|
271
271
|
is_latest_desired_state_synced_with_provider: z
|
|
272
272
|
.boolean()
|
|
@@ -405,7 +405,7 @@ export const acs_credential_on_encoder = z.object({
|
|
|
405
405
|
.string()
|
|
406
406
|
.optional()
|
|
407
407
|
.describe(
|
|
408
|
-
'
|
|
408
|
+
'Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
409
409
|
),
|
|
410
410
|
|
|
411
411
|
number_of_issued_cards: z
|
|
@@ -36,7 +36,37 @@ const user_identity_being_deleted = common_user_identity_warning
|
|
|
36
36
|
})
|
|
37
37
|
.describe('Indicates that the user identity is currently being deleted.')
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
const user_identity_issue_with_acs_user = common_user_identity_error
|
|
40
|
+
.extend({
|
|
41
|
+
error_code: z
|
|
42
|
+
.literal('issue_with_acs_user')
|
|
43
|
+
.describe(
|
|
44
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
45
|
+
),
|
|
46
|
+
acs_user_id: z
|
|
47
|
+
.string()
|
|
48
|
+
.uuid()
|
|
49
|
+
.describe('ID of the access system user that has an issue.'),
|
|
50
|
+
acs_system_id: z
|
|
51
|
+
.string()
|
|
52
|
+
.uuid()
|
|
53
|
+
.describe(
|
|
54
|
+
'ID of the access system that the user identity is associated with.',
|
|
55
|
+
),
|
|
56
|
+
})
|
|
57
|
+
.describe(
|
|
58
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
59
|
+
)
|
|
60
|
+
|
|
61
|
+
export const user_identity_error_map = z.object({
|
|
62
|
+
issue_with_acs_user: z
|
|
63
|
+
.record(z.string().uuid(), user_identity_issue_with_acs_user)
|
|
64
|
+
.optional()
|
|
65
|
+
.nullable()
|
|
66
|
+
.describe(
|
|
67
|
+
'Map of access system user IDs to issues with the access system user. The key is the access system user ID, and the value is the issue with the access system user.',
|
|
68
|
+
),
|
|
69
|
+
})
|
|
40
70
|
|
|
41
71
|
export type UserIdentityErrorMap = z.infer<typeof user_identity_error_map>
|
|
42
72
|
|
|
@@ -52,6 +82,10 @@ export const user_identity_warning_map = z.object({
|
|
|
52
82
|
|
|
53
83
|
export type UserIdentityWarningMap = z.infer<typeof user_identity_warning_map>
|
|
54
84
|
|
|
85
|
+
const user_identity_errors = z
|
|
86
|
+
.discriminatedUnion('error_code', [user_identity_issue_with_acs_user])
|
|
87
|
+
.describe('Errors associated with the user identity.')
|
|
88
|
+
|
|
55
89
|
export const user_identity = z.object({
|
|
56
90
|
user_identity_id: z.string().uuid().describe('ID of the user identity.'),
|
|
57
91
|
user_identity_key: z
|
|
@@ -82,9 +116,9 @@ export const user_identity = z.object({
|
|
|
82
116
|
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
83
117
|
),
|
|
84
118
|
errors: z
|
|
85
|
-
.array(
|
|
119
|
+
.array(user_identity_errors)
|
|
86
120
|
.describe(
|
|
87
|
-
'Array of errors associated with the user identity. Each error object within the array contains
|
|
121
|
+
'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.',
|
|
88
122
|
),
|
|
89
123
|
warnings: z
|
|
90
124
|
.array(user_identity_warnings)
|
|
@@ -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: {
|
|
@@ -4404,7 +4404,7 @@ export default {
|
|
|
4404
4404
|
},
|
|
4405
4405
|
card_holder: {
|
|
4406
4406
|
description:
|
|
4407
|
-
'
|
|
4407
|
+
'Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).',
|
|
4408
4408
|
type: 'string',
|
|
4409
4409
|
},
|
|
4410
4410
|
card_id: {
|
|
@@ -4636,7 +4636,7 @@ export default {
|
|
|
4636
4636
|
is_managed: { enum: [true], type: 'boolean' },
|
|
4637
4637
|
is_multi_phone_sync_credential: {
|
|
4638
4638
|
description:
|
|
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
|
|
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).',
|
|
4640
4640
|
type: 'boolean',
|
|
4641
4641
|
},
|
|
4642
4642
|
is_one_time_use: {
|
|
@@ -5090,7 +5090,7 @@ export default {
|
|
|
5090
5090
|
is_managed: { enum: [false], type: 'boolean' },
|
|
5091
5091
|
is_multi_phone_sync_credential: {
|
|
5092
5092
|
description:
|
|
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
|
|
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).',
|
|
5094
5094
|
type: 'boolean',
|
|
5095
5095
|
},
|
|
5096
5096
|
is_one_time_use: {
|
|
@@ -5743,7 +5743,7 @@ export default {
|
|
|
5743
5743
|
is_managed: { enum: [true], type: 'boolean' },
|
|
5744
5744
|
is_multi_phone_sync_credential: {
|
|
5745
5745
|
description:
|
|
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
|
|
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).',
|
|
5747
5747
|
type: 'boolean',
|
|
5748
5748
|
},
|
|
5749
5749
|
is_one_time_use: {
|
|
@@ -6194,7 +6194,7 @@ export default {
|
|
|
6194
6194
|
is_managed: { enum: [false], type: 'boolean' },
|
|
6195
6195
|
is_multi_phone_sync_credential: {
|
|
6196
6196
|
description:
|
|
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
|
|
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).',
|
|
6198
6198
|
type: 'boolean',
|
|
6199
6199
|
},
|
|
6200
6200
|
is_one_time_use: {
|
|
@@ -12784,7 +12784,7 @@ export default {
|
|
|
12784
12784
|
enrollment_automation: {
|
|
12785
12785
|
deprecated: true,
|
|
12786
12786
|
description:
|
|
12787
|
-
'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/).',
|
|
12788
12788
|
properties: {
|
|
12789
12789
|
created_at: {
|
|
12790
12790
|
description:
|
|
@@ -12805,7 +12805,7 @@ export default {
|
|
|
12805
12805
|
},
|
|
12806
12806
|
user_identity_id: {
|
|
12807
12807
|
description:
|
|
12808
|
-
'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).',
|
|
12809
12809
|
format: 'uuid',
|
|
12810
12810
|
type: 'string',
|
|
12811
12811
|
},
|
|
@@ -18722,7 +18722,7 @@ export default {
|
|
|
18722
18722
|
is_managed: { enum: [true], type: 'boolean' },
|
|
18723
18723
|
is_multi_phone_sync_credential: {
|
|
18724
18724
|
description:
|
|
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
|
|
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).',
|
|
18726
18726
|
type: 'boolean',
|
|
18727
18727
|
},
|
|
18728
18728
|
is_one_time_use: {
|
|
@@ -21296,7 +21296,7 @@ export default {
|
|
|
21296
21296
|
is_managed: { enum: [false], type: 'boolean' },
|
|
21297
21297
|
is_multi_phone_sync_credential: {
|
|
21298
21298
|
description:
|
|
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
|
|
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).',
|
|
21300
21300
|
type: 'boolean',
|
|
21301
21301
|
},
|
|
21302
21302
|
is_one_time_use: {
|
|
@@ -23696,22 +23696,55 @@ export default {
|
|
|
23696
23696
|
},
|
|
23697
23697
|
errors: {
|
|
23698
23698
|
description:
|
|
23699
|
-
'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.',
|
|
23700
23700
|
items: {
|
|
23701
|
-
|
|
23702
|
-
|
|
23703
|
-
|
|
23704
|
-
|
|
23705
|
-
type: 'string',
|
|
23706
|
-
},
|
|
23707
|
-
message: {
|
|
23701
|
+
description: 'Errors associated with the user identity.',
|
|
23702
|
+
discriminator: { propertyName: 'error_code' },
|
|
23703
|
+
oneOf: [
|
|
23704
|
+
{
|
|
23708
23705
|
description:
|
|
23709
|
-
'
|
|
23710
|
-
|
|
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',
|
|
23711
23746
|
},
|
|
23712
|
-
|
|
23713
|
-
required: ['created_at', 'message'],
|
|
23714
|
-
type: 'object',
|
|
23747
|
+
],
|
|
23715
23748
|
},
|
|
23716
23749
|
type: 'array',
|
|
23717
23750
|
},
|
|
@@ -28905,7 +28938,7 @@ export default {
|
|
|
28905
28938
|
is_multi_phone_sync_credential: {
|
|
28906
28939
|
default: false,
|
|
28907
28940
|
description:
|
|
28908
|
-
'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).',
|
|
28909
28942
|
type: 'boolean',
|
|
28910
28943
|
},
|
|
28911
28944
|
salto_space_metadata: {
|
|
@@ -51813,7 +51846,7 @@ export default {
|
|
|
51813
51846
|
'/user_identities/add_acs_user': {
|
|
51814
51847
|
post: {
|
|
51815
51848
|
description:
|
|
51816
|
-
'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).',
|
|
51817
51850
|
operationId: 'userIdentitiesAddAcsUserPost',
|
|
51818
51851
|
requestBody: {
|
|
51819
51852
|
content: {
|
|
@@ -51869,7 +51902,7 @@ export default {
|
|
|
51869
51902
|
},
|
|
51870
51903
|
put: {
|
|
51871
51904
|
description:
|
|
51872
|
-
'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).',
|
|
51873
51906
|
operationId: 'userIdentitiesAddAcsUserPut',
|
|
51874
51907
|
requestBody: {
|
|
51875
51908
|
content: {
|
|
@@ -51927,7 +51960,7 @@ export default {
|
|
|
51927
51960
|
'/user_identities/create': {
|
|
51928
51961
|
post: {
|
|
51929
51962
|
description:
|
|
51930
|
-
'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).',
|
|
51931
51964
|
operationId: 'userIdentitiesCreatePost',
|
|
51932
51965
|
requestBody: {
|
|
51933
51966
|
content: {
|
|
@@ -52010,7 +52043,7 @@ export default {
|
|
|
52010
52043
|
'/user_identities/delete': {
|
|
52011
52044
|
delete: {
|
|
52012
52045
|
description:
|
|
52013
|
-
'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).',
|
|
52014
52047
|
operationId: 'userIdentitiesDeleteDelete',
|
|
52015
52048
|
parameters: [
|
|
52016
52049
|
{
|
|
@@ -52054,7 +52087,7 @@ export default {
|
|
|
52054
52087
|
},
|
|
52055
52088
|
post: {
|
|
52056
52089
|
description:
|
|
52057
|
-
'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).',
|
|
52058
52091
|
operationId: 'userIdentitiesDeletePost',
|
|
52059
52092
|
requestBody: {
|
|
52060
52093
|
content: {
|
|
@@ -52106,7 +52139,7 @@ export default {
|
|
|
52106
52139
|
'/user_identities/enrollment_automations/delete': {
|
|
52107
52140
|
delete: {
|
|
52108
52141
|
description:
|
|
52109
|
-
'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).',
|
|
52110
52143
|
operationId: 'userIdentitiesEnrollmentAutomationsDeleteDelete',
|
|
52111
52144
|
parameters: [
|
|
52112
52145
|
{
|
|
@@ -52153,7 +52186,7 @@ export default {
|
|
|
52153
52186
|
},
|
|
52154
52187
|
post: {
|
|
52155
52188
|
description:
|
|
52156
|
-
'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).',
|
|
52157
52190
|
operationId: 'userIdentitiesEnrollmentAutomationsDeletePost',
|
|
52158
52191
|
requestBody: {
|
|
52159
52192
|
content: {
|
|
@@ -52207,7 +52240,7 @@ export default {
|
|
|
52207
52240
|
'/user_identities/enrollment_automations/get': {
|
|
52208
52241
|
get: {
|
|
52209
52242
|
description:
|
|
52210
|
-
'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/).',
|
|
52211
52244
|
operationId: 'userIdentitiesEnrollmentAutomationsGetGet',
|
|
52212
52245
|
parameters: [
|
|
52213
52246
|
{
|
|
@@ -52261,7 +52294,7 @@ export default {
|
|
|
52261
52294
|
},
|
|
52262
52295
|
post: {
|
|
52263
52296
|
description:
|
|
52264
|
-
'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/).',
|
|
52265
52298
|
operationId: 'userIdentitiesEnrollmentAutomationsGetPost',
|
|
52266
52299
|
requestBody: {
|
|
52267
52300
|
content: {
|
|
@@ -52322,7 +52355,7 @@ export default {
|
|
|
52322
52355
|
'/user_identities/enrollment_automations/launch': {
|
|
52323
52356
|
post: {
|
|
52324
52357
|
description:
|
|
52325
|
-
'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).',
|
|
52326
52359
|
operationId: 'userIdentitiesEnrollmentAutomationsLaunchPost',
|
|
52327
52360
|
requestBody: {
|
|
52328
52361
|
content: {
|
|
@@ -52408,7 +52441,7 @@ export default {
|
|
|
52408
52441
|
'/user_identities/enrollment_automations/list': {
|
|
52409
52442
|
get: {
|
|
52410
52443
|
description:
|
|
52411
|
-
'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).',
|
|
52412
52445
|
operationId: 'userIdentitiesEnrollmentAutomationsListGet',
|
|
52413
52446
|
parameters: [
|
|
52414
52447
|
{
|
|
@@ -52465,7 +52498,7 @@ export default {
|
|
|
52465
52498
|
},
|
|
52466
52499
|
post: {
|
|
52467
52500
|
description:
|
|
52468
|
-
'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).',
|
|
52469
52502
|
operationId: 'userIdentitiesEnrollmentAutomationsListPost',
|
|
52470
52503
|
requestBody: {
|
|
52471
52504
|
content: {
|
|
@@ -52529,7 +52562,7 @@ export default {
|
|
|
52529
52562
|
'/user_identities/generate_instant_key': {
|
|
52530
52563
|
post: {
|
|
52531
52564
|
description:
|
|
52532
|
-
'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).',
|
|
52533
52566
|
operationId: 'userIdentitiesGenerateInstantKeyPost',
|
|
52534
52567
|
requestBody: {
|
|
52535
52568
|
content: {
|
|
@@ -52592,7 +52625,7 @@ export default {
|
|
|
52592
52625
|
'/user_identities/get': {
|
|
52593
52626
|
get: {
|
|
52594
52627
|
description:
|
|
52595
|
-
'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).',
|
|
52596
52629
|
operationId: 'userIdentitiesGetGet',
|
|
52597
52630
|
responses: {
|
|
52598
52631
|
200: {
|
|
@@ -52630,7 +52663,7 @@ export default {
|
|
|
52630
52663
|
},
|
|
52631
52664
|
post: {
|
|
52632
52665
|
description:
|
|
52633
|
-
'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).',
|
|
52634
52667
|
operationId: 'userIdentitiesGetPost',
|
|
52635
52668
|
requestBody: {
|
|
52636
52669
|
content: {
|
|
@@ -52697,7 +52730,7 @@ export default {
|
|
|
52697
52730
|
'/user_identities/grant_access_to_device': {
|
|
52698
52731
|
post: {
|
|
52699
52732
|
description:
|
|
52700
|
-
'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/).',
|
|
52701
52734
|
operationId: 'userIdentitiesGrantAccessToDevicePost',
|
|
52702
52735
|
requestBody: {
|
|
52703
52736
|
content: {
|
|
@@ -52753,7 +52786,7 @@ export default {
|
|
|
52753
52786
|
},
|
|
52754
52787
|
put: {
|
|
52755
52788
|
description:
|
|
52756
|
-
'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/).',
|
|
52757
52790
|
operationId: 'userIdentitiesGrantAccessToDevicePut',
|
|
52758
52791
|
requestBody: {
|
|
52759
52792
|
content: {
|
|
@@ -52811,7 +52844,7 @@ export default {
|
|
|
52811
52844
|
'/user_identities/list': {
|
|
52812
52845
|
get: {
|
|
52813
52846
|
description:
|
|
52814
|
-
'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).',
|
|
52815
52848
|
operationId: 'userIdentitiesListGet',
|
|
52816
52849
|
parameters: [
|
|
52817
52850
|
{
|
|
@@ -52872,7 +52905,7 @@ export default {
|
|
|
52872
52905
|
},
|
|
52873
52906
|
post: {
|
|
52874
52907
|
description:
|
|
52875
|
-
'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).',
|
|
52876
52909
|
operationId: 'userIdentitiesListPost',
|
|
52877
52910
|
requestBody: {
|
|
52878
52911
|
content: {
|
|
@@ -52936,7 +52969,7 @@ export default {
|
|
|
52936
52969
|
'/user_identities/list_accessible_devices': {
|
|
52937
52970
|
get: {
|
|
52938
52971
|
description:
|
|
52939
|
-
'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).',
|
|
52940
52973
|
operationId: 'userIdentitiesListAccessibleDevicesGet',
|
|
52941
52974
|
parameters: [
|
|
52942
52975
|
{
|
|
@@ -52994,7 +53027,7 @@ export default {
|
|
|
52994
53027
|
},
|
|
52995
53028
|
post: {
|
|
52996
53029
|
description:
|
|
52997
|
-
'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).',
|
|
52998
53031
|
operationId: 'userIdentitiesListAccessibleDevicesPost',
|
|
52999
53032
|
requestBody: {
|
|
53000
53033
|
content: {
|
|
@@ -53059,7 +53092,7 @@ export default {
|
|
|
53059
53092
|
'/user_identities/list_acs_systems': {
|
|
53060
53093
|
get: {
|
|
53061
53094
|
description:
|
|
53062
|
-
'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).',
|
|
53063
53096
|
operationId: 'userIdentitiesListAcsSystemsGet',
|
|
53064
53097
|
parameters: [
|
|
53065
53098
|
{
|
|
@@ -53112,7 +53145,7 @@ export default {
|
|
|
53112
53145
|
},
|
|
53113
53146
|
post: {
|
|
53114
53147
|
description:
|
|
53115
|
-
'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).',
|
|
53116
53149
|
operationId: 'userIdentitiesListAcsSystemsPost',
|
|
53117
53150
|
requestBody: {
|
|
53118
53151
|
content: {
|
|
@@ -53172,7 +53205,7 @@ export default {
|
|
|
53172
53205
|
'/user_identities/list_acs_users': {
|
|
53173
53206
|
get: {
|
|
53174
53207
|
description:
|
|
53175
|
-
'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).',
|
|
53176
53209
|
operationId: 'userIdentitiesListAcsUsersGet',
|
|
53177
53210
|
parameters: [
|
|
53178
53211
|
{
|
|
@@ -53224,7 +53257,7 @@ export default {
|
|
|
53224
53257
|
},
|
|
53225
53258
|
post: {
|
|
53226
53259
|
description:
|
|
53227
|
-
'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).',
|
|
53228
53261
|
operationId: 'userIdentitiesListAcsUsersPost',
|
|
53229
53262
|
requestBody: {
|
|
53230
53263
|
content: {
|
|
@@ -53283,7 +53316,7 @@ export default {
|
|
|
53283
53316
|
'/user_identities/remove_acs_user': {
|
|
53284
53317
|
delete: {
|
|
53285
53318
|
description:
|
|
53286
|
-
'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).',
|
|
53287
53320
|
operationId: 'userIdentitiesRemoveAcsUserDelete',
|
|
53288
53321
|
parameters: [
|
|
53289
53322
|
{
|
|
@@ -53339,7 +53372,7 @@ export default {
|
|
|
53339
53372
|
},
|
|
53340
53373
|
post: {
|
|
53341
53374
|
description:
|
|
53342
|
-
'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).',
|
|
53343
53376
|
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
53344
53377
|
requestBody: {
|
|
53345
53378
|
content: {
|
|
@@ -53397,7 +53430,7 @@ export default {
|
|
|
53397
53430
|
'/user_identities/revoke_access_to_device': {
|
|
53398
53431
|
delete: {
|
|
53399
53432
|
description:
|
|
53400
|
-
'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).',
|
|
53401
53434
|
operationId: 'userIdentitiesRevokeAccessToDeviceDelete',
|
|
53402
53435
|
parameters: [
|
|
53403
53436
|
{
|
|
@@ -53453,7 +53486,7 @@ export default {
|
|
|
53453
53486
|
},
|
|
53454
53487
|
post: {
|
|
53455
53488
|
description:
|
|
53456
|
-
'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).',
|
|
53457
53490
|
operationId: 'userIdentitiesRevokeAccessToDevicePost',
|
|
53458
53491
|
requestBody: {
|
|
53459
53492
|
content: {
|
|
@@ -53511,7 +53544,7 @@ export default {
|
|
|
53511
53544
|
'/user_identities/update': {
|
|
53512
53545
|
patch: {
|
|
53513
53546
|
description:
|
|
53514
|
-
'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).',
|
|
53515
53548
|
operationId: 'userIdentitiesUpdatePatch',
|
|
53516
53549
|
requestBody: {
|
|
53517
53550
|
content: {
|
|
@@ -53585,7 +53618,7 @@ export default {
|
|
|
53585
53618
|
},
|
|
53586
53619
|
post: {
|
|
53587
53620
|
description:
|
|
53588
|
-
'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).',
|
|
53589
53622
|
operationId: 'userIdentitiesUpdatePost',
|
|
53590
53623
|
requestBody: {
|
|
53591
53624
|
content: {
|