@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/dist/connect.cjs
CHANGED
|
@@ -2714,7 +2714,7 @@ var common_acs_credential = zod.z.object({
|
|
|
2714
2714
|
"Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
2715
2715
|
),
|
|
2716
2716
|
is_multi_phone_sync_credential: zod.z.boolean().optional().describe(
|
|
2717
|
-
"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
|
|
2717
|
+
"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)."
|
|
2718
2718
|
),
|
|
2719
2719
|
is_latest_desired_state_synced_with_provider: zod.z.boolean().nullable().optional().describe(
|
|
2720
2720
|
"Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider."
|
|
@@ -2795,7 +2795,7 @@ var acs_credential_on_encoder = zod.z.object({
|
|
|
2795
2795
|
"Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
2796
2796
|
),
|
|
2797
2797
|
card_holder: zod.z.string().optional().describe(
|
|
2798
|
-
"
|
|
2798
|
+
"Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
2799
2799
|
),
|
|
2800
2800
|
number_of_issued_cards: zod.z.number().describe(
|
|
2801
2801
|
"Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
@@ -5316,11 +5316,27 @@ var user_identity_being_deleted = common_user_identity_warning.extend({
|
|
|
5316
5316
|
"Unique identifier of the type of warning. Enables quick recognition and categorization of the issue."
|
|
5317
5317
|
)
|
|
5318
5318
|
}).describe("Indicates that the user identity is currently being deleted.");
|
|
5319
|
-
|
|
5319
|
+
var user_identity_issue_with_acs_user = common_user_identity_error.extend({
|
|
5320
|
+
error_code: zod.z.literal("issue_with_acs_user").describe(
|
|
5321
|
+
"Unique identifier of the type of error. Enables quick recognition and categorization of the issue."
|
|
5322
|
+
),
|
|
5323
|
+
acs_user_id: zod.z.string().uuid().describe("ID of the access system user that has an issue."),
|
|
5324
|
+
acs_system_id: zod.z.string().uuid().describe(
|
|
5325
|
+
"ID of the access system that the user identity is associated with."
|
|
5326
|
+
)
|
|
5327
|
+
}).describe(
|
|
5328
|
+
"Indicates that there is an issue with an access system user associated with this user identity."
|
|
5329
|
+
);
|
|
5330
|
+
zod.z.object({
|
|
5331
|
+
issue_with_acs_user: zod.z.record(zod.z.string().uuid(), user_identity_issue_with_acs_user).optional().nullable().describe(
|
|
5332
|
+
"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."
|
|
5333
|
+
)
|
|
5334
|
+
});
|
|
5320
5335
|
var user_identity_warnings = zod.z.discriminatedUnion("warning_code", [user_identity_being_deleted]).describe("Warnings associated with the user identity.");
|
|
5321
5336
|
zod.z.object({
|
|
5322
5337
|
user_identity_being_deleted: user_identity_being_deleted.optional().nullable()
|
|
5323
5338
|
});
|
|
5339
|
+
var user_identity_errors = zod.z.discriminatedUnion("error_code", [user_identity_issue_with_acs_user]).describe("Errors associated with the user identity.");
|
|
5324
5340
|
var user_identity = zod.z.object({
|
|
5325
5341
|
user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
|
|
5326
5342
|
user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
|
|
@@ -5334,8 +5350,8 @@ var user_identity = zod.z.object({
|
|
|
5334
5350
|
workspace_id: zod.z.string().uuid().describe(
|
|
5335
5351
|
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity."
|
|
5336
5352
|
),
|
|
5337
|
-
errors: zod.z.array(
|
|
5338
|
-
'Array of errors associated with the user identity. Each error object within the array contains
|
|
5353
|
+
errors: zod.z.array(user_identity_errors).describe(
|
|
5354
|
+
'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.'
|
|
5339
5355
|
),
|
|
5340
5356
|
warnings: zod.z.array(user_identity_warnings).describe(
|
|
5341
5357
|
'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.'
|
|
@@ -7387,7 +7403,7 @@ var openapi_default = {
|
|
|
7387
7403
|
},
|
|
7388
7404
|
is_managed: { enum: [true], type: "boolean" },
|
|
7389
7405
|
is_multi_phone_sync_credential: {
|
|
7390
|
-
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
|
|
7406
|
+
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).",
|
|
7391
7407
|
type: "boolean"
|
|
7392
7408
|
},
|
|
7393
7409
|
is_one_time_use: {
|
|
@@ -9284,7 +9300,7 @@ var openapi_default = {
|
|
|
9284
9300
|
type: "string"
|
|
9285
9301
|
},
|
|
9286
9302
|
card_holder: {
|
|
9287
|
-
description: "
|
|
9303
|
+
description: "Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
9288
9304
|
type: "string"
|
|
9289
9305
|
},
|
|
9290
9306
|
card_id: {
|
|
@@ -9482,7 +9498,7 @@ var openapi_default = {
|
|
|
9482
9498
|
},
|
|
9483
9499
|
is_managed: { enum: [true], type: "boolean" },
|
|
9484
9500
|
is_multi_phone_sync_credential: {
|
|
9485
|
-
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
|
|
9501
|
+
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).",
|
|
9486
9502
|
type: "boolean"
|
|
9487
9503
|
},
|
|
9488
9504
|
is_one_time_use: {
|
|
@@ -9870,7 +9886,7 @@ var openapi_default = {
|
|
|
9870
9886
|
},
|
|
9871
9887
|
is_managed: { enum: [false], type: "boolean" },
|
|
9872
9888
|
is_multi_phone_sync_credential: {
|
|
9873
|
-
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
|
|
9889
|
+
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).",
|
|
9874
9890
|
type: "boolean"
|
|
9875
9891
|
},
|
|
9876
9892
|
is_one_time_use: {
|
|
@@ -10436,7 +10452,7 @@ var openapi_default = {
|
|
|
10436
10452
|
},
|
|
10437
10453
|
is_managed: { enum: [true], type: "boolean" },
|
|
10438
10454
|
is_multi_phone_sync_credential: {
|
|
10439
|
-
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
|
|
10455
|
+
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).",
|
|
10440
10456
|
type: "boolean"
|
|
10441
10457
|
},
|
|
10442
10458
|
is_one_time_use: {
|
|
@@ -10822,7 +10838,7 @@ var openapi_default = {
|
|
|
10822
10838
|
},
|
|
10823
10839
|
is_managed: { enum: [false], type: "boolean" },
|
|
10824
10840
|
is_multi_phone_sync_credential: {
|
|
10825
|
-
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
|
|
10841
|
+
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).",
|
|
10826
10842
|
type: "boolean"
|
|
10827
10843
|
},
|
|
10828
10844
|
is_one_time_use: {
|
|
@@ -16750,7 +16766,7 @@ var openapi_default = {
|
|
|
16750
16766
|
},
|
|
16751
16767
|
enrollment_automation: {
|
|
16752
16768
|
deprecated: true,
|
|
16753
|
-
description: "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
16769
|
+
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/).",
|
|
16754
16770
|
properties: {
|
|
16755
16771
|
created_at: {
|
|
16756
16772
|
description: "Date and time at which the enrollment automation was created.",
|
|
@@ -16768,7 +16784,7 @@ var openapi_default = {
|
|
|
16768
16784
|
type: "string"
|
|
16769
16785
|
},
|
|
16770
16786
|
user_identity_id: {
|
|
16771
|
-
description: "ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
16787
|
+
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).",
|
|
16772
16788
|
format: "uuid",
|
|
16773
16789
|
type: "string"
|
|
16774
16790
|
},
|
|
@@ -22295,7 +22311,7 @@ var openapi_default = {
|
|
|
22295
22311
|
},
|
|
22296
22312
|
is_managed: { enum: [true], type: "boolean" },
|
|
22297
22313
|
is_multi_phone_sync_credential: {
|
|
22298
|
-
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
|
|
22314
|
+
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).",
|
|
22299
22315
|
type: "boolean"
|
|
22300
22316
|
},
|
|
22301
22317
|
is_one_time_use: {
|
|
@@ -24535,7 +24551,7 @@ var openapi_default = {
|
|
|
24535
24551
|
},
|
|
24536
24552
|
is_managed: { enum: [false], type: "boolean" },
|
|
24537
24553
|
is_multi_phone_sync_credential: {
|
|
24538
|
-
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
|
|
24554
|
+
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).",
|
|
24539
24555
|
type: "boolean"
|
|
24540
24556
|
},
|
|
24541
24557
|
is_one_time_use: {
|
|
@@ -26643,21 +26659,49 @@ var openapi_default = {
|
|
|
26643
26659
|
type: "string"
|
|
26644
26660
|
},
|
|
26645
26661
|
errors: {
|
|
26646
|
-
description: 'Array of errors associated with the user identity. Each error object within the array contains
|
|
26662
|
+
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.',
|
|
26647
26663
|
items: {
|
|
26648
|
-
|
|
26649
|
-
|
|
26650
|
-
|
|
26651
|
-
|
|
26652
|
-
|
|
26653
|
-
|
|
26654
|
-
|
|
26655
|
-
|
|
26656
|
-
|
|
26664
|
+
description: "Errors associated with the user identity.",
|
|
26665
|
+
discriminator: { propertyName: "error_code" },
|
|
26666
|
+
oneOf: [
|
|
26667
|
+
{
|
|
26668
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
26669
|
+
properties: {
|
|
26670
|
+
acs_system_id: {
|
|
26671
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
26672
|
+
format: "uuid",
|
|
26673
|
+
type: "string"
|
|
26674
|
+
},
|
|
26675
|
+
acs_user_id: {
|
|
26676
|
+
description: "ID of the access system user that has an issue.",
|
|
26677
|
+
format: "uuid",
|
|
26678
|
+
type: "string"
|
|
26679
|
+
},
|
|
26680
|
+
created_at: {
|
|
26681
|
+
description: "Date and time at which Seam created the error.",
|
|
26682
|
+
format: "date-time",
|
|
26683
|
+
type: "string"
|
|
26684
|
+
},
|
|
26685
|
+
error_code: {
|
|
26686
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
26687
|
+
enum: ["issue_with_acs_user"],
|
|
26688
|
+
type: "string"
|
|
26689
|
+
},
|
|
26690
|
+
message: {
|
|
26691
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
26692
|
+
type: "string"
|
|
26693
|
+
}
|
|
26694
|
+
},
|
|
26695
|
+
required: [
|
|
26696
|
+
"created_at",
|
|
26697
|
+
"message",
|
|
26698
|
+
"error_code",
|
|
26699
|
+
"acs_user_id",
|
|
26700
|
+
"acs_system_id"
|
|
26701
|
+
],
|
|
26702
|
+
type: "object"
|
|
26657
26703
|
}
|
|
26658
|
-
|
|
26659
|
-
required: ["created_at", "message"],
|
|
26660
|
-
type: "object"
|
|
26704
|
+
]
|
|
26661
26705
|
},
|
|
26662
26706
|
type: "array"
|
|
26663
26707
|
},
|
|
@@ -31548,7 +31592,7 @@ var openapi_default = {
|
|
|
31548
31592
|
},
|
|
31549
31593
|
is_multi_phone_sync_credential: {
|
|
31550
31594
|
default: false,
|
|
31551
|
-
description: "Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
31595
|
+
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).",
|
|
31552
31596
|
type: "boolean"
|
|
31553
31597
|
},
|
|
31554
31598
|
salto_space_metadata: {
|
|
@@ -53285,7 +53329,7 @@ var openapi_default = {
|
|
|
53285
53329
|
},
|
|
53286
53330
|
"/user_identities/add_acs_user": {
|
|
53287
53331
|
post: {
|
|
53288
|
-
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
|
|
53332
|
+
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).",
|
|
53289
53333
|
operationId: "userIdentitiesAddAcsUserPost",
|
|
53290
53334
|
requestBody: {
|
|
53291
53335
|
content: {
|
|
@@ -53338,7 +53382,7 @@ var openapi_default = {
|
|
|
53338
53382
|
"x-title": "Add an ACS User to a User Identity"
|
|
53339
53383
|
},
|
|
53340
53384
|
put: {
|
|
53341
|
-
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
|
|
53385
|
+
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).",
|
|
53342
53386
|
operationId: "userIdentitiesAddAcsUserPut",
|
|
53343
53387
|
requestBody: {
|
|
53344
53388
|
content: {
|
|
@@ -53393,7 +53437,7 @@ var openapi_default = {
|
|
|
53393
53437
|
},
|
|
53394
53438
|
"/user_identities/create": {
|
|
53395
53439
|
post: {
|
|
53396
|
-
description: "Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53440
|
+
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).",
|
|
53397
53441
|
operationId: "userIdentitiesCreatePost",
|
|
53398
53442
|
requestBody: {
|
|
53399
53443
|
content: {
|
|
@@ -53471,7 +53515,7 @@ var openapi_default = {
|
|
|
53471
53515
|
},
|
|
53472
53516
|
"/user_identities/delete": {
|
|
53473
53517
|
delete: {
|
|
53474
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53518
|
+
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).",
|
|
53475
53519
|
operationId: "userIdentitiesDeleteDelete",
|
|
53476
53520
|
parameters: [
|
|
53477
53521
|
{
|
|
@@ -53514,7 +53558,7 @@ var openapi_default = {
|
|
|
53514
53558
|
"x-title": "Delete a User Identity"
|
|
53515
53559
|
},
|
|
53516
53560
|
post: {
|
|
53517
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53561
|
+
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).",
|
|
53518
53562
|
operationId: "userIdentitiesDeletePost",
|
|
53519
53563
|
requestBody: {
|
|
53520
53564
|
content: {
|
|
@@ -53564,7 +53608,7 @@ var openapi_default = {
|
|
|
53564
53608
|
},
|
|
53565
53609
|
"/user_identities/enrollment_automations/delete": {
|
|
53566
53610
|
delete: {
|
|
53567
|
-
description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53611
|
+
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).",
|
|
53568
53612
|
operationId: "userIdentitiesEnrollmentAutomationsDeleteDelete",
|
|
53569
53613
|
parameters: [
|
|
53570
53614
|
{
|
|
@@ -53608,7 +53652,7 @@ var openapi_default = {
|
|
|
53608
53652
|
"x-title": "Delete an Enrollment Automation"
|
|
53609
53653
|
},
|
|
53610
53654
|
post: {
|
|
53611
|
-
description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53655
|
+
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).",
|
|
53612
53656
|
operationId: "userIdentitiesEnrollmentAutomationsDeletePost",
|
|
53613
53657
|
requestBody: {
|
|
53614
53658
|
content: {
|
|
@@ -53659,7 +53703,7 @@ var openapi_default = {
|
|
|
53659
53703
|
},
|
|
53660
53704
|
"/user_identities/enrollment_automations/get": {
|
|
53661
53705
|
get: {
|
|
53662
|
-
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53706
|
+
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
|
|
53663
53707
|
operationId: "userIdentitiesEnrollmentAutomationsGetGet",
|
|
53664
53708
|
parameters: [
|
|
53665
53709
|
{
|
|
@@ -53710,7 +53754,7 @@ var openapi_default = {
|
|
|
53710
53754
|
"x-title": "Get an Enrollment Automation"
|
|
53711
53755
|
},
|
|
53712
53756
|
post: {
|
|
53713
|
-
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53757
|
+
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
|
|
53714
53758
|
operationId: "userIdentitiesEnrollmentAutomationsGetPost",
|
|
53715
53759
|
requestBody: {
|
|
53716
53760
|
content: {
|
|
@@ -53768,7 +53812,7 @@ var openapi_default = {
|
|
|
53768
53812
|
},
|
|
53769
53813
|
"/user_identities/enrollment_automations/launch": {
|
|
53770
53814
|
post: {
|
|
53771
|
-
description: "Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53815
|
+
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).",
|
|
53772
53816
|
operationId: "userIdentitiesEnrollmentAutomationsLaunchPost",
|
|
53773
53817
|
requestBody: {
|
|
53774
53818
|
content: {
|
|
@@ -53847,7 +53891,7 @@ var openapi_default = {
|
|
|
53847
53891
|
},
|
|
53848
53892
|
"/user_identities/enrollment_automations/list": {
|
|
53849
53893
|
get: {
|
|
53850
|
-
description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53894
|
+
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).",
|
|
53851
53895
|
operationId: "userIdentitiesEnrollmentAutomationsListGet",
|
|
53852
53896
|
parameters: [
|
|
53853
53897
|
{
|
|
@@ -53901,7 +53945,7 @@ var openapi_default = {
|
|
|
53901
53945
|
"x-title": "List Enrollment Automations"
|
|
53902
53946
|
},
|
|
53903
53947
|
post: {
|
|
53904
|
-
description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53948
|
+
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).",
|
|
53905
53949
|
operationId: "userIdentitiesEnrollmentAutomationsListPost",
|
|
53906
53950
|
requestBody: {
|
|
53907
53951
|
content: {
|
|
@@ -53962,7 +54006,7 @@ var openapi_default = {
|
|
|
53962
54006
|
},
|
|
53963
54007
|
"/user_identities/generate_instant_key": {
|
|
53964
54008
|
post: {
|
|
53965
|
-
description: "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54009
|
+
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).",
|
|
53966
54010
|
operationId: "userIdentitiesGenerateInstantKeyPost",
|
|
53967
54011
|
requestBody: {
|
|
53968
54012
|
content: {
|
|
@@ -54022,7 +54066,7 @@ var openapi_default = {
|
|
|
54022
54066
|
},
|
|
54023
54067
|
"/user_identities/get": {
|
|
54024
54068
|
get: {
|
|
54025
|
-
description: "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54069
|
+
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).",
|
|
54026
54070
|
operationId: "userIdentitiesGetGet",
|
|
54027
54071
|
responses: {
|
|
54028
54072
|
200: {
|
|
@@ -54059,7 +54103,7 @@ var openapi_default = {
|
|
|
54059
54103
|
"x-title": "Get a User Identity"
|
|
54060
54104
|
},
|
|
54061
54105
|
post: {
|
|
54062
|
-
description: "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54106
|
+
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).",
|
|
54063
54107
|
operationId: "userIdentitiesGetPost",
|
|
54064
54108
|
requestBody: {
|
|
54065
54109
|
content: {
|
|
@@ -54124,7 +54168,7 @@ var openapi_default = {
|
|
|
54124
54168
|
},
|
|
54125
54169
|
"/user_identities/grant_access_to_device": {
|
|
54126
54170
|
post: {
|
|
54127
|
-
description: "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54171
|
+
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/).",
|
|
54128
54172
|
operationId: "userIdentitiesGrantAccessToDevicePost",
|
|
54129
54173
|
requestBody: {
|
|
54130
54174
|
content: {
|
|
@@ -54177,7 +54221,7 @@ var openapi_default = {
|
|
|
54177
54221
|
"x-title": "Grant a User Identity Access to a Device"
|
|
54178
54222
|
},
|
|
54179
54223
|
put: {
|
|
54180
|
-
description: "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54224
|
+
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/).",
|
|
54181
54225
|
operationId: "userIdentitiesGrantAccessToDevicePut",
|
|
54182
54226
|
requestBody: {
|
|
54183
54227
|
content: {
|
|
@@ -54232,7 +54276,7 @@ var openapi_default = {
|
|
|
54232
54276
|
},
|
|
54233
54277
|
"/user_identities/list": {
|
|
54234
54278
|
get: {
|
|
54235
|
-
description: "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54279
|
+
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).",
|
|
54236
54280
|
operationId: "userIdentitiesListGet",
|
|
54237
54281
|
parameters: [
|
|
54238
54282
|
{
|
|
@@ -54290,7 +54334,7 @@ var openapi_default = {
|
|
|
54290
54334
|
"x-title": "List User Identities"
|
|
54291
54335
|
},
|
|
54292
54336
|
post: {
|
|
54293
|
-
description: "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54337
|
+
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).",
|
|
54294
54338
|
operationId: "userIdentitiesListPost",
|
|
54295
54339
|
requestBody: {
|
|
54296
54340
|
content: {
|
|
@@ -54351,7 +54395,7 @@ var openapi_default = {
|
|
|
54351
54395
|
},
|
|
54352
54396
|
"/user_identities/list_accessible_devices": {
|
|
54353
54397
|
get: {
|
|
54354
|
-
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
|
|
54398
|
+
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).",
|
|
54355
54399
|
operationId: "userIdentitiesListAccessibleDevicesGet",
|
|
54356
54400
|
parameters: [
|
|
54357
54401
|
{
|
|
@@ -54407,7 +54451,7 @@ var openapi_default = {
|
|
|
54407
54451
|
"x-title": "List Accessible Devices for a User Identity"
|
|
54408
54452
|
},
|
|
54409
54453
|
post: {
|
|
54410
|
-
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
|
|
54454
|
+
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).",
|
|
54411
54455
|
operationId: "userIdentitiesListAccessibleDevicesPost",
|
|
54412
54456
|
requestBody: {
|
|
54413
54457
|
content: {
|
|
@@ -54470,7 +54514,7 @@ var openapi_default = {
|
|
|
54470
54514
|
},
|
|
54471
54515
|
"/user_identities/list_acs_systems": {
|
|
54472
54516
|
get: {
|
|
54473
|
-
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
|
|
54517
|
+
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).",
|
|
54474
54518
|
operationId: "userIdentitiesListAcsSystemsGet",
|
|
54475
54519
|
parameters: [
|
|
54476
54520
|
{
|
|
@@ -54521,7 +54565,7 @@ var openapi_default = {
|
|
|
54521
54565
|
"x-title": "List ACS Systems Associated with a User Identity"
|
|
54522
54566
|
},
|
|
54523
54567
|
post: {
|
|
54524
|
-
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
|
|
54568
|
+
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).",
|
|
54525
54569
|
operationId: "userIdentitiesListAcsSystemsPost",
|
|
54526
54570
|
requestBody: {
|
|
54527
54571
|
content: {
|
|
@@ -54579,7 +54623,7 @@ var openapi_default = {
|
|
|
54579
54623
|
},
|
|
54580
54624
|
"/user_identities/list_acs_users": {
|
|
54581
54625
|
get: {
|
|
54582
|
-
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
|
|
54626
|
+
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).",
|
|
54583
54627
|
operationId: "userIdentitiesListAcsUsersGet",
|
|
54584
54628
|
parameters: [
|
|
54585
54629
|
{
|
|
@@ -54629,7 +54673,7 @@ var openapi_default = {
|
|
|
54629
54673
|
"x-title": "List ACS Users Associated with a User Identity"
|
|
54630
54674
|
},
|
|
54631
54675
|
post: {
|
|
54632
|
-
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
|
|
54676
|
+
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).",
|
|
54633
54677
|
operationId: "userIdentitiesListAcsUsersPost",
|
|
54634
54678
|
requestBody: {
|
|
54635
54679
|
content: {
|
|
@@ -54686,7 +54730,7 @@ var openapi_default = {
|
|
|
54686
54730
|
},
|
|
54687
54731
|
"/user_identities/remove_acs_user": {
|
|
54688
54732
|
delete: {
|
|
54689
|
-
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
|
|
54733
|
+
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).",
|
|
54690
54734
|
operationId: "userIdentitiesRemoveAcsUserDelete",
|
|
54691
54735
|
parameters: [
|
|
54692
54736
|
{
|
|
@@ -54739,7 +54783,7 @@ var openapi_default = {
|
|
|
54739
54783
|
"x-title": "Remove an ACS User from a User Identity"
|
|
54740
54784
|
},
|
|
54741
54785
|
post: {
|
|
54742
|
-
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
|
|
54786
|
+
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).",
|
|
54743
54787
|
operationId: "userIdentitiesRemoveAcsUserPost",
|
|
54744
54788
|
requestBody: {
|
|
54745
54789
|
content: {
|
|
@@ -54794,7 +54838,7 @@ var openapi_default = {
|
|
|
54794
54838
|
},
|
|
54795
54839
|
"/user_identities/revoke_access_to_device": {
|
|
54796
54840
|
delete: {
|
|
54797
|
-
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
|
|
54841
|
+
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).",
|
|
54798
54842
|
operationId: "userIdentitiesRevokeAccessToDeviceDelete",
|
|
54799
54843
|
parameters: [
|
|
54800
54844
|
{
|
|
@@ -54847,7 +54891,7 @@ var openapi_default = {
|
|
|
54847
54891
|
"x-title": "Revoke Access to a Device from a User Identity"
|
|
54848
54892
|
},
|
|
54849
54893
|
post: {
|
|
54850
|
-
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
|
|
54894
|
+
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).",
|
|
54851
54895
|
operationId: "userIdentitiesRevokeAccessToDevicePost",
|
|
54852
54896
|
requestBody: {
|
|
54853
54897
|
content: {
|
|
@@ -54902,7 +54946,7 @@ var openapi_default = {
|
|
|
54902
54946
|
},
|
|
54903
54947
|
"/user_identities/update": {
|
|
54904
54948
|
patch: {
|
|
54905
|
-
description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54949
|
+
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).",
|
|
54906
54950
|
operationId: "userIdentitiesUpdatePatch",
|
|
54907
54951
|
requestBody: {
|
|
54908
54952
|
content: {
|
|
@@ -54973,7 +55017,7 @@ var openapi_default = {
|
|
|
54973
55017
|
"x-title": "Update a User Identity"
|
|
54974
55018
|
},
|
|
54975
55019
|
post: {
|
|
54976
|
-
description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
55020
|
+
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).",
|
|
54977
55021
|
operationId: "userIdentitiesUpdatePost",
|
|
54978
55022
|
requestBody: {
|
|
54979
55023
|
content: {
|