@seamapi/types 1.431.0 → 1.433.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 +118 -63
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +229 -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/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -3
- package/lib/seam/connect/models/devices/device-provider.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 +39 -12
- package/lib/seam/connect/openapi.js +97 -55
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +171 -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/devices/device-provider.ts +0 -3
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +37 -3
- package/src/lib/seam/connect/openapi.ts +104 -55
- package/src/lib/seam/connect/route-types.ts +171 -151
package/dist/connect.cjs
CHANGED
|
@@ -1927,7 +1927,6 @@ var ALL_DEVICE_PROVIDERS = Object.values(DEVICE_PROVIDERS);
|
|
|
1927
1927
|
var PROVIDER_CATEGORY_MAP = {
|
|
1928
1928
|
stable: [
|
|
1929
1929
|
"august",
|
|
1930
|
-
"avigilon_alta",
|
|
1931
1930
|
"brivo",
|
|
1932
1931
|
"schlage",
|
|
1933
1932
|
"smartthings",
|
|
@@ -1935,7 +1934,6 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1935
1934
|
"nuki",
|
|
1936
1935
|
"salto",
|
|
1937
1936
|
"salto_space",
|
|
1938
|
-
"controlbyweb",
|
|
1939
1937
|
"minut",
|
|
1940
1938
|
"my_2n",
|
|
1941
1939
|
"kwikset",
|
|
@@ -1943,7 +1941,6 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1943
1941
|
"noiseaware",
|
|
1944
1942
|
"igloohome",
|
|
1945
1943
|
"ecobee",
|
|
1946
|
-
"four_suites",
|
|
1947
1944
|
"lockly",
|
|
1948
1945
|
"wyze",
|
|
1949
1946
|
"nest",
|
|
@@ -2714,7 +2711,7 @@ var common_acs_credential = zod.z.object({
|
|
|
2714
2711
|
"Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
2715
2712
|
),
|
|
2716
2713
|
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
|
|
2714
|
+
"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
2715
|
),
|
|
2719
2716
|
is_latest_desired_state_synced_with_provider: zod.z.boolean().nullable().optional().describe(
|
|
2720
2717
|
"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 +2792,7 @@ var acs_credential_on_encoder = zod.z.object({
|
|
|
2795
2792
|
"Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
2796
2793
|
),
|
|
2797
2794
|
card_holder: zod.z.string().optional().describe(
|
|
2798
|
-
"
|
|
2795
|
+
"Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
2799
2796
|
),
|
|
2800
2797
|
number_of_issued_cards: zod.z.number().describe(
|
|
2801
2798
|
"Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)."
|
|
@@ -5316,11 +5313,27 @@ var user_identity_being_deleted = common_user_identity_warning.extend({
|
|
|
5316
5313
|
"Unique identifier of the type of warning. Enables quick recognition and categorization of the issue."
|
|
5317
5314
|
)
|
|
5318
5315
|
}).describe("Indicates that the user identity is currently being deleted.");
|
|
5319
|
-
|
|
5316
|
+
var user_identity_issue_with_acs_user = common_user_identity_error.extend({
|
|
5317
|
+
error_code: zod.z.literal("issue_with_acs_user").describe(
|
|
5318
|
+
"Unique identifier of the type of error. Enables quick recognition and categorization of the issue."
|
|
5319
|
+
),
|
|
5320
|
+
acs_user_id: zod.z.string().uuid().describe("ID of the access system user that has an issue."),
|
|
5321
|
+
acs_system_id: zod.z.string().uuid().describe(
|
|
5322
|
+
"ID of the access system that the user identity is associated with."
|
|
5323
|
+
)
|
|
5324
|
+
}).describe(
|
|
5325
|
+
"Indicates that there is an issue with an access system user associated with this user identity."
|
|
5326
|
+
);
|
|
5327
|
+
zod.z.object({
|
|
5328
|
+
issue_with_acs_user: zod.z.record(zod.z.string().uuid(), user_identity_issue_with_acs_user).optional().nullable().describe(
|
|
5329
|
+
"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."
|
|
5330
|
+
)
|
|
5331
|
+
});
|
|
5320
5332
|
var user_identity_warnings = zod.z.discriminatedUnion("warning_code", [user_identity_being_deleted]).describe("Warnings associated with the user identity.");
|
|
5321
5333
|
zod.z.object({
|
|
5322
5334
|
user_identity_being_deleted: user_identity_being_deleted.optional().nullable()
|
|
5323
5335
|
});
|
|
5336
|
+
var user_identity_errors = zod.z.discriminatedUnion("error_code", [user_identity_issue_with_acs_user]).describe("Errors associated with the user identity.");
|
|
5324
5337
|
var user_identity = zod.z.object({
|
|
5325
5338
|
user_identity_id: zod.z.string().uuid().describe("ID of the user identity."),
|
|
5326
5339
|
user_identity_key: zod.z.string().min(1).nullable().describe("Unique key for the user identity."),
|
|
@@ -5334,8 +5347,8 @@ var user_identity = zod.z.object({
|
|
|
5334
5347
|
workspace_id: zod.z.string().uuid().describe(
|
|
5335
5348
|
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity."
|
|
5336
5349
|
),
|
|
5337
|
-
errors: zod.z.array(
|
|
5338
|
-
'Array of errors associated with the user identity. Each error object within the array contains
|
|
5350
|
+
errors: zod.z.array(user_identity_errors).describe(
|
|
5351
|
+
'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
5352
|
),
|
|
5340
5353
|
warnings: zod.z.array(user_identity_warnings).describe(
|
|
5341
5354
|
'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 +7400,7 @@ var openapi_default = {
|
|
|
7387
7400
|
},
|
|
7388
7401
|
is_managed: { enum: [true], type: "boolean" },
|
|
7389
7402
|
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
|
|
7403
|
+
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
7404
|
type: "boolean"
|
|
7392
7405
|
},
|
|
7393
7406
|
is_one_time_use: {
|
|
@@ -9284,7 +9297,7 @@ var openapi_default = {
|
|
|
9284
9297
|
type: "string"
|
|
9285
9298
|
},
|
|
9286
9299
|
card_holder: {
|
|
9287
|
-
description: "
|
|
9300
|
+
description: "Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
9288
9301
|
type: "string"
|
|
9289
9302
|
},
|
|
9290
9303
|
card_id: {
|
|
@@ -9482,7 +9495,7 @@ var openapi_default = {
|
|
|
9482
9495
|
},
|
|
9483
9496
|
is_managed: { enum: [true], type: "boolean" },
|
|
9484
9497
|
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
|
|
9498
|
+
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
9499
|
type: "boolean"
|
|
9487
9500
|
},
|
|
9488
9501
|
is_one_time_use: {
|
|
@@ -9870,7 +9883,7 @@ var openapi_default = {
|
|
|
9870
9883
|
},
|
|
9871
9884
|
is_managed: { enum: [false], type: "boolean" },
|
|
9872
9885
|
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
|
|
9886
|
+
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
9887
|
type: "boolean"
|
|
9875
9888
|
},
|
|
9876
9889
|
is_one_time_use: {
|
|
@@ -10436,7 +10449,7 @@ var openapi_default = {
|
|
|
10436
10449
|
},
|
|
10437
10450
|
is_managed: { enum: [true], type: "boolean" },
|
|
10438
10451
|
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
|
|
10452
|
+
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
10453
|
type: "boolean"
|
|
10441
10454
|
},
|
|
10442
10455
|
is_one_time_use: {
|
|
@@ -10822,7 +10835,7 @@ var openapi_default = {
|
|
|
10822
10835
|
},
|
|
10823
10836
|
is_managed: { enum: [false], type: "boolean" },
|
|
10824
10837
|
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
|
|
10838
|
+
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
10839
|
type: "boolean"
|
|
10827
10840
|
},
|
|
10828
10841
|
is_one_time_use: {
|
|
@@ -16750,7 +16763,7 @@ var openapi_default = {
|
|
|
16750
16763
|
},
|
|
16751
16764
|
enrollment_automation: {
|
|
16752
16765
|
deprecated: true,
|
|
16753
|
-
description: "Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
16766
|
+
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
16767
|
properties: {
|
|
16755
16768
|
created_at: {
|
|
16756
16769
|
description: "Date and time at which the enrollment automation was created.",
|
|
@@ -16768,7 +16781,7 @@ var openapi_default = {
|
|
|
16768
16781
|
type: "string"
|
|
16769
16782
|
},
|
|
16770
16783
|
user_identity_id: {
|
|
16771
|
-
description: "ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
16784
|
+
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
16785
|
format: "uuid",
|
|
16773
16786
|
type: "string"
|
|
16774
16787
|
},
|
|
@@ -22295,7 +22308,7 @@ var openapi_default = {
|
|
|
22295
22308
|
},
|
|
22296
22309
|
is_managed: { enum: [true], type: "boolean" },
|
|
22297
22310
|
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
|
|
22311
|
+
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
22312
|
type: "boolean"
|
|
22300
22313
|
},
|
|
22301
22314
|
is_one_time_use: {
|
|
@@ -24535,7 +24548,7 @@ var openapi_default = {
|
|
|
24535
24548
|
},
|
|
24536
24549
|
is_managed: { enum: [false], type: "boolean" },
|
|
24537
24550
|
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
|
|
24551
|
+
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
24552
|
type: "boolean"
|
|
24540
24553
|
},
|
|
24541
24554
|
is_one_time_use: {
|
|
@@ -26643,21 +26656,49 @@ var openapi_default = {
|
|
|
26643
26656
|
type: "string"
|
|
26644
26657
|
},
|
|
26645
26658
|
errors: {
|
|
26646
|
-
description: 'Array of errors associated with the user identity. Each error object within the array contains
|
|
26659
|
+
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
26660
|
items: {
|
|
26648
|
-
|
|
26649
|
-
|
|
26650
|
-
|
|
26651
|
-
|
|
26652
|
-
|
|
26653
|
-
|
|
26654
|
-
|
|
26655
|
-
|
|
26656
|
-
|
|
26661
|
+
description: "Errors associated with the user identity.",
|
|
26662
|
+
discriminator: { propertyName: "error_code" },
|
|
26663
|
+
oneOf: [
|
|
26664
|
+
{
|
|
26665
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
26666
|
+
properties: {
|
|
26667
|
+
acs_system_id: {
|
|
26668
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
26669
|
+
format: "uuid",
|
|
26670
|
+
type: "string"
|
|
26671
|
+
},
|
|
26672
|
+
acs_user_id: {
|
|
26673
|
+
description: "ID of the access system user that has an issue.",
|
|
26674
|
+
format: "uuid",
|
|
26675
|
+
type: "string"
|
|
26676
|
+
},
|
|
26677
|
+
created_at: {
|
|
26678
|
+
description: "Date and time at which Seam created the error.",
|
|
26679
|
+
format: "date-time",
|
|
26680
|
+
type: "string"
|
|
26681
|
+
},
|
|
26682
|
+
error_code: {
|
|
26683
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
26684
|
+
enum: ["issue_with_acs_user"],
|
|
26685
|
+
type: "string"
|
|
26686
|
+
},
|
|
26687
|
+
message: {
|
|
26688
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
26689
|
+
type: "string"
|
|
26690
|
+
}
|
|
26691
|
+
},
|
|
26692
|
+
required: [
|
|
26693
|
+
"created_at",
|
|
26694
|
+
"message",
|
|
26695
|
+
"error_code",
|
|
26696
|
+
"acs_user_id",
|
|
26697
|
+
"acs_system_id"
|
|
26698
|
+
],
|
|
26699
|
+
type: "object"
|
|
26657
26700
|
}
|
|
26658
|
-
|
|
26659
|
-
required: ["created_at", "message"],
|
|
26660
|
-
type: "object"
|
|
26701
|
+
]
|
|
26661
26702
|
},
|
|
26662
26703
|
type: "array"
|
|
26663
26704
|
},
|
|
@@ -31548,7 +31589,7 @@ var openapi_default = {
|
|
|
31548
31589
|
},
|
|
31549
31590
|
is_multi_phone_sync_credential: {
|
|
31550
31591
|
default: false,
|
|
31551
|
-
description: "Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
31592
|
+
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
31593
|
type: "boolean"
|
|
31553
31594
|
},
|
|
31554
31595
|
salto_space_metadata: {
|
|
@@ -33616,6 +33657,15 @@ var openapi_default = {
|
|
|
33616
33657
|
format: "uuid",
|
|
33617
33658
|
type: "string"
|
|
33618
33659
|
}
|
|
33660
|
+
},
|
|
33661
|
+
{
|
|
33662
|
+
in: "query",
|
|
33663
|
+
name: "connected_account_id",
|
|
33664
|
+
schema: {
|
|
33665
|
+
description: "ID of the connected account for which you want to retrieve all entrances.",
|
|
33666
|
+
format: "uuid",
|
|
33667
|
+
type: "string"
|
|
33668
|
+
}
|
|
33619
33669
|
}
|
|
33620
33670
|
],
|
|
33621
33671
|
responses: {
|
|
@@ -33682,6 +33732,11 @@ var openapi_default = {
|
|
|
33682
33732
|
format: "uuid",
|
|
33683
33733
|
type: "string"
|
|
33684
33734
|
},
|
|
33735
|
+
connected_account_id: {
|
|
33736
|
+
description: "ID of the connected account for which you want to retrieve all entrances.",
|
|
33737
|
+
format: "uuid",
|
|
33738
|
+
type: "string"
|
|
33739
|
+
},
|
|
33685
33740
|
location_id: {
|
|
33686
33741
|
deprecated: true,
|
|
33687
33742
|
format: "uuid",
|
|
@@ -53285,7 +53340,7 @@ var openapi_default = {
|
|
|
53285
53340
|
},
|
|
53286
53341
|
"/user_identities/add_acs_user": {
|
|
53287
53342
|
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
|
|
53343
|
+
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
53344
|
operationId: "userIdentitiesAddAcsUserPost",
|
|
53290
53345
|
requestBody: {
|
|
53291
53346
|
content: {
|
|
@@ -53338,7 +53393,7 @@ var openapi_default = {
|
|
|
53338
53393
|
"x-title": "Add an ACS User to a User Identity"
|
|
53339
53394
|
},
|
|
53340
53395
|
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
|
|
53396
|
+
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
53397
|
operationId: "userIdentitiesAddAcsUserPut",
|
|
53343
53398
|
requestBody: {
|
|
53344
53399
|
content: {
|
|
@@ -53393,7 +53448,7 @@ var openapi_default = {
|
|
|
53393
53448
|
},
|
|
53394
53449
|
"/user_identities/create": {
|
|
53395
53450
|
post: {
|
|
53396
|
-
description: "Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53451
|
+
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
53452
|
operationId: "userIdentitiesCreatePost",
|
|
53398
53453
|
requestBody: {
|
|
53399
53454
|
content: {
|
|
@@ -53471,7 +53526,7 @@ var openapi_default = {
|
|
|
53471
53526
|
},
|
|
53472
53527
|
"/user_identities/delete": {
|
|
53473
53528
|
delete: {
|
|
53474
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53529
|
+
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
53530
|
operationId: "userIdentitiesDeleteDelete",
|
|
53476
53531
|
parameters: [
|
|
53477
53532
|
{
|
|
@@ -53514,7 +53569,7 @@ var openapi_default = {
|
|
|
53514
53569
|
"x-title": "Delete a User Identity"
|
|
53515
53570
|
},
|
|
53516
53571
|
post: {
|
|
53517
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53572
|
+
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
53573
|
operationId: "userIdentitiesDeletePost",
|
|
53519
53574
|
requestBody: {
|
|
53520
53575
|
content: {
|
|
@@ -53564,7 +53619,7 @@ var openapi_default = {
|
|
|
53564
53619
|
},
|
|
53565
53620
|
"/user_identities/enrollment_automations/delete": {
|
|
53566
53621
|
delete: {
|
|
53567
|
-
description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53622
|
+
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
53623
|
operationId: "userIdentitiesEnrollmentAutomationsDeleteDelete",
|
|
53569
53624
|
parameters: [
|
|
53570
53625
|
{
|
|
@@ -53608,7 +53663,7 @@ var openapi_default = {
|
|
|
53608
53663
|
"x-title": "Delete an Enrollment Automation"
|
|
53609
53664
|
},
|
|
53610
53665
|
post: {
|
|
53611
|
-
description: "Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53666
|
+
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
53667
|
operationId: "userIdentitiesEnrollmentAutomationsDeletePost",
|
|
53613
53668
|
requestBody: {
|
|
53614
53669
|
content: {
|
|
@@ -53659,7 +53714,7 @@ var openapi_default = {
|
|
|
53659
53714
|
},
|
|
53660
53715
|
"/user_identities/enrollment_automations/get": {
|
|
53661
53716
|
get: {
|
|
53662
|
-
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53717
|
+
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
|
|
53663
53718
|
operationId: "userIdentitiesEnrollmentAutomationsGetGet",
|
|
53664
53719
|
parameters: [
|
|
53665
53720
|
{
|
|
@@ -53710,7 +53765,7 @@ var openapi_default = {
|
|
|
53710
53765
|
"x-title": "Get an Enrollment Automation"
|
|
53711
53766
|
},
|
|
53712
53767
|
post: {
|
|
53713
|
-
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53768
|
+
description: "Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system/).",
|
|
53714
53769
|
operationId: "userIdentitiesEnrollmentAutomationsGetPost",
|
|
53715
53770
|
requestBody: {
|
|
53716
53771
|
content: {
|
|
@@ -53768,7 +53823,7 @@ var openapi_default = {
|
|
|
53768
53823
|
},
|
|
53769
53824
|
"/user_identities/enrollment_automations/launch": {
|
|
53770
53825
|
post: {
|
|
53771
|
-
description: "Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53826
|
+
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
53827
|
operationId: "userIdentitiesEnrollmentAutomationsLaunchPost",
|
|
53773
53828
|
requestBody: {
|
|
53774
53829
|
content: {
|
|
@@ -53847,7 +53902,7 @@ var openapi_default = {
|
|
|
53847
53902
|
},
|
|
53848
53903
|
"/user_identities/enrollment_automations/list": {
|
|
53849
53904
|
get: {
|
|
53850
|
-
description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53905
|
+
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
53906
|
operationId: "userIdentitiesEnrollmentAutomationsListGet",
|
|
53852
53907
|
parameters: [
|
|
53853
53908
|
{
|
|
@@ -53901,7 +53956,7 @@ var openapi_default = {
|
|
|
53901
53956
|
"x-title": "List Enrollment Automations"
|
|
53902
53957
|
},
|
|
53903
53958
|
post: {
|
|
53904
|
-
description: "Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
53959
|
+
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
53960
|
operationId: "userIdentitiesEnrollmentAutomationsListPost",
|
|
53906
53961
|
requestBody: {
|
|
53907
53962
|
content: {
|
|
@@ -53962,7 +54017,7 @@ var openapi_default = {
|
|
|
53962
54017
|
},
|
|
53963
54018
|
"/user_identities/generate_instant_key": {
|
|
53964
54019
|
post: {
|
|
53965
|
-
description: "Generates a new [instant key](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54020
|
+
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
54021
|
operationId: "userIdentitiesGenerateInstantKeyPost",
|
|
53967
54022
|
requestBody: {
|
|
53968
54023
|
content: {
|
|
@@ -54022,7 +54077,7 @@ var openapi_default = {
|
|
|
54022
54077
|
},
|
|
54023
54078
|
"/user_identities/get": {
|
|
54024
54079
|
get: {
|
|
54025
|
-
description: "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54080
|
+
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
54081
|
operationId: "userIdentitiesGetGet",
|
|
54027
54082
|
responses: {
|
|
54028
54083
|
200: {
|
|
@@ -54059,7 +54114,7 @@ var openapi_default = {
|
|
|
54059
54114
|
"x-title": "Get a User Identity"
|
|
54060
54115
|
},
|
|
54061
54116
|
post: {
|
|
54062
|
-
description: "Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54117
|
+
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
54118
|
operationId: "userIdentitiesGetPost",
|
|
54064
54119
|
requestBody: {
|
|
54065
54120
|
content: {
|
|
@@ -54124,7 +54179,7 @@ var openapi_default = {
|
|
|
54124
54179
|
},
|
|
54125
54180
|
"/user_identities/grant_access_to_device": {
|
|
54126
54181
|
post: {
|
|
54127
|
-
description: "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54182
|
+
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
54183
|
operationId: "userIdentitiesGrantAccessToDevicePost",
|
|
54129
54184
|
requestBody: {
|
|
54130
54185
|
content: {
|
|
@@ -54177,7 +54232,7 @@ var openapi_default = {
|
|
|
54177
54232
|
"x-title": "Grant a User Identity Access to a Device"
|
|
54178
54233
|
},
|
|
54179
54234
|
put: {
|
|
54180
|
-
description: "Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54235
|
+
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
54236
|
operationId: "userIdentitiesGrantAccessToDevicePut",
|
|
54182
54237
|
requestBody: {
|
|
54183
54238
|
content: {
|
|
@@ -54232,7 +54287,7 @@ var openapi_default = {
|
|
|
54232
54287
|
},
|
|
54233
54288
|
"/user_identities/list": {
|
|
54234
54289
|
get: {
|
|
54235
|
-
description: "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54290
|
+
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
54291
|
operationId: "userIdentitiesListGet",
|
|
54237
54292
|
parameters: [
|
|
54238
54293
|
{
|
|
@@ -54290,7 +54345,7 @@ var openapi_default = {
|
|
|
54290
54345
|
"x-title": "List User Identities"
|
|
54291
54346
|
},
|
|
54292
54347
|
post: {
|
|
54293
|
-
description: "Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54348
|
+
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
54349
|
operationId: "userIdentitiesListPost",
|
|
54295
54350
|
requestBody: {
|
|
54296
54351
|
content: {
|
|
@@ -54351,7 +54406,7 @@ var openapi_default = {
|
|
|
54351
54406
|
},
|
|
54352
54407
|
"/user_identities/list_accessible_devices": {
|
|
54353
54408
|
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
|
|
54409
|
+
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
54410
|
operationId: "userIdentitiesListAccessibleDevicesGet",
|
|
54356
54411
|
parameters: [
|
|
54357
54412
|
{
|
|
@@ -54407,7 +54462,7 @@ var openapi_default = {
|
|
|
54407
54462
|
"x-title": "List Accessible Devices for a User Identity"
|
|
54408
54463
|
},
|
|
54409
54464
|
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
|
|
54465
|
+
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
54466
|
operationId: "userIdentitiesListAccessibleDevicesPost",
|
|
54412
54467
|
requestBody: {
|
|
54413
54468
|
content: {
|
|
@@ -54470,7 +54525,7 @@ var openapi_default = {
|
|
|
54470
54525
|
},
|
|
54471
54526
|
"/user_identities/list_acs_systems": {
|
|
54472
54527
|
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
|
|
54528
|
+
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
54529
|
operationId: "userIdentitiesListAcsSystemsGet",
|
|
54475
54530
|
parameters: [
|
|
54476
54531
|
{
|
|
@@ -54521,7 +54576,7 @@ var openapi_default = {
|
|
|
54521
54576
|
"x-title": "List ACS Systems Associated with a User Identity"
|
|
54522
54577
|
},
|
|
54523
54578
|
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
|
|
54579
|
+
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
54580
|
operationId: "userIdentitiesListAcsSystemsPost",
|
|
54526
54581
|
requestBody: {
|
|
54527
54582
|
content: {
|
|
@@ -54579,7 +54634,7 @@ var openapi_default = {
|
|
|
54579
54634
|
},
|
|
54580
54635
|
"/user_identities/list_acs_users": {
|
|
54581
54636
|
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
|
|
54637
|
+
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
54638
|
operationId: "userIdentitiesListAcsUsersGet",
|
|
54584
54639
|
parameters: [
|
|
54585
54640
|
{
|
|
@@ -54629,7 +54684,7 @@ var openapi_default = {
|
|
|
54629
54684
|
"x-title": "List ACS Users Associated with a User Identity"
|
|
54630
54685
|
},
|
|
54631
54686
|
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
|
|
54687
|
+
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
54688
|
operationId: "userIdentitiesListAcsUsersPost",
|
|
54634
54689
|
requestBody: {
|
|
54635
54690
|
content: {
|
|
@@ -54686,7 +54741,7 @@ var openapi_default = {
|
|
|
54686
54741
|
},
|
|
54687
54742
|
"/user_identities/remove_acs_user": {
|
|
54688
54743
|
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
|
|
54744
|
+
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
54745
|
operationId: "userIdentitiesRemoveAcsUserDelete",
|
|
54691
54746
|
parameters: [
|
|
54692
54747
|
{
|
|
@@ -54739,7 +54794,7 @@ var openapi_default = {
|
|
|
54739
54794
|
"x-title": "Remove an ACS User from a User Identity"
|
|
54740
54795
|
},
|
|
54741
54796
|
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
|
|
54797
|
+
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
54798
|
operationId: "userIdentitiesRemoveAcsUserPost",
|
|
54744
54799
|
requestBody: {
|
|
54745
54800
|
content: {
|
|
@@ -54794,7 +54849,7 @@ var openapi_default = {
|
|
|
54794
54849
|
},
|
|
54795
54850
|
"/user_identities/revoke_access_to_device": {
|
|
54796
54851
|
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
|
|
54852
|
+
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
54853
|
operationId: "userIdentitiesRevokeAccessToDeviceDelete",
|
|
54799
54854
|
parameters: [
|
|
54800
54855
|
{
|
|
@@ -54847,7 +54902,7 @@ var openapi_default = {
|
|
|
54847
54902
|
"x-title": "Revoke Access to a Device from a User Identity"
|
|
54848
54903
|
},
|
|
54849
54904
|
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
|
|
54905
|
+
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
54906
|
operationId: "userIdentitiesRevokeAccessToDevicePost",
|
|
54852
54907
|
requestBody: {
|
|
54853
54908
|
content: {
|
|
@@ -54902,7 +54957,7 @@ var openapi_default = {
|
|
|
54902
54957
|
},
|
|
54903
54958
|
"/user_identities/update": {
|
|
54904
54959
|
patch: {
|
|
54905
|
-
description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
54960
|
+
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
54961
|
operationId: "userIdentitiesUpdatePatch",
|
|
54907
54962
|
requestBody: {
|
|
54908
54963
|
content: {
|
|
@@ -54973,7 +55028,7 @@ var openapi_default = {
|
|
|
54973
55028
|
"x-title": "Update a User Identity"
|
|
54974
55029
|
},
|
|
54975
55030
|
post: {
|
|
54976
|
-
description: "Updates a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
55031
|
+
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
55032
|
operationId: "userIdentitiesUpdatePost",
|
|
54978
55033
|
requestBody: {
|
|
54979
55034
|
content: {
|