@seamapi/types 1.279.0 → 1.281.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 +678 -147
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1813 -0
- package/lib/seam/connect/models/acs/acs-credential.js +81 -22
- package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +169 -0
- package/lib/seam/connect/openapi.js +619 -114
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1644 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-credential.ts +107 -28
- package/src/lib/seam/connect/openapi.ts +765 -114
- package/src/lib/seam/connect/route-types.ts +1644 -0
package/dist/connect.cjs
CHANGED
|
@@ -1213,23 +1213,35 @@ var acs_credential_access_method_type = zod.z.enum([
|
|
|
1213
1213
|
"mobile_key"
|
|
1214
1214
|
]);
|
|
1215
1215
|
var common_acs_credential = zod.z.object({
|
|
1216
|
-
acs_credential_id: zod.z.string().uuid(),
|
|
1217
|
-
acs_user_id: zod.z.string().uuid().optional(),
|
|
1216
|
+
acs_credential_id: zod.z.string().uuid().describe("ID of the credential."),
|
|
1217
|
+
acs_user_id: zod.z.string().uuid().optional().describe("ID of the ACS user to whom the credential belongs."),
|
|
1218
1218
|
acs_credential_pool_id: zod.z.string().uuid().optional(),
|
|
1219
|
-
acs_system_id: zod.z.string().uuid(),
|
|
1220
|
-
parent_acs_credential_id: zod.z.string().uuid().optional(),
|
|
1221
|
-
display_name: zod.z.string().min(1),
|
|
1222
|
-
code: zod.z.string().optional().nullable(),
|
|
1219
|
+
acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the credential."),
|
|
1220
|
+
parent_acs_credential_id: zod.z.string().uuid().optional().describe("ID of the parent credential."),
|
|
1221
|
+
display_name: zod.z.string().min(1).describe("Display name that corresponds to the credential type."),
|
|
1222
|
+
code: zod.z.string().optional().nullable().describe("Access (PIN) code for the credential."),
|
|
1223
1223
|
card_number: zod.z.string().optional().nullable(),
|
|
1224
1224
|
is_issued: zod.z.boolean().optional(),
|
|
1225
1225
|
issued_at: zod.z.string().datetime().optional().nullable(),
|
|
1226
|
-
access_method: acs_credential_access_method_type
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
|
|
1230
|
-
|
|
1231
|
-
|
|
1232
|
-
|
|
1226
|
+
access_method: acs_credential_access_method_type.describe(
|
|
1227
|
+
"Access method for the credential. Supported values: `code`, `card`, `mobile_key`."
|
|
1228
|
+
),
|
|
1229
|
+
external_type: acs_credential_external_type.optional().describe(
|
|
1230
|
+
"Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`."
|
|
1231
|
+
),
|
|
1232
|
+
external_type_display_name: zod.z.string().optional().describe(
|
|
1233
|
+
"Display name that corresponds to the brand-specific terminology for the credential type."
|
|
1234
|
+
),
|
|
1235
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the credential was created."),
|
|
1236
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
1237
|
+
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential."
|
|
1238
|
+
),
|
|
1239
|
+
starts_at: zod.z.string().optional().describe(
|
|
1240
|
+
"Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
|
|
1241
|
+
),
|
|
1242
|
+
ends_at: zod.z.string().optional().describe(
|
|
1243
|
+
"Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`."
|
|
1244
|
+
),
|
|
1233
1245
|
errors: zod.z.array(
|
|
1234
1246
|
zod.z.object({
|
|
1235
1247
|
error_code: zod.z.string(),
|
|
@@ -1242,21 +1254,35 @@ var common_acs_credential = zod.z.object({
|
|
|
1242
1254
|
message: zod.z.string()
|
|
1243
1255
|
})
|
|
1244
1256
|
),
|
|
1245
|
-
is_multi_phone_sync_credential: zod.z.boolean().optional()
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1257
|
+
is_multi_phone_sync_credential: zod.z.boolean().optional().describe(
|
|
1258
|
+
"Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials)."
|
|
1259
|
+
),
|
|
1260
|
+
is_latest_desired_state_synced_with_provider: zod.z.boolean().optional().describe(
|
|
1261
|
+
"Indicates whether the latest state of the credential has been synced from Seam to the provider."
|
|
1262
|
+
),
|
|
1263
|
+
latest_desired_state_synced_with_provider_at: zod.z.string().datetime().optional().describe(
|
|
1264
|
+
"Date and time at which the state of the credential was most recently synced from Seam to the provider."
|
|
1265
|
+
),
|
|
1266
|
+
visionline_metadata: acs_credential_visionline_metadata.optional().describe("Visionline-specific metadata for the credential.")
|
|
1249
1267
|
});
|
|
1250
1268
|
var acs_credential = common_acs_credential.merge(
|
|
1251
1269
|
zod.z.object({
|
|
1252
1270
|
is_managed: zod.z.literal(true)
|
|
1253
1271
|
})
|
|
1254
|
-
);
|
|
1272
|
+
).describe(getAcsCredentialDescription());
|
|
1255
1273
|
var unmanaged_acs_credential = common_acs_credential.merge(
|
|
1256
1274
|
zod.z.object({
|
|
1257
1275
|
is_managed: zod.z.literal(false)
|
|
1258
1276
|
})
|
|
1259
|
-
);
|
|
1277
|
+
).describe(getAcsCredentialDescription(false));
|
|
1278
|
+
function getAcsCredentialDescription(is_managed = true) {
|
|
1279
|
+
const resource_name = is_managed ? "acs_credential" : "unmanaged_acs_credential";
|
|
1280
|
+
const management_clause = is_managed ? "" : ", which is not managed by Seam,";
|
|
1281
|
+
return `
|
|
1282
|
+
Means by which a user gains access at an entrance.
|
|
1283
|
+
|
|
1284
|
+
The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim();
|
|
1285
|
+
}
|
|
1260
1286
|
var acs_credential_on_encoder = zod.z.object({
|
|
1261
1287
|
created_at: zod.z.string().datetime().nullable().describe("Date and time the credential was created."),
|
|
1262
1288
|
is_issued: zod.z.boolean().nullable(),
|
|
@@ -1277,7 +1303,7 @@ var acs_credential_on_encoder = zod.z.object({
|
|
|
1277
1303
|
number_of_issued_cards: zod.z.number(),
|
|
1278
1304
|
guest_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional(),
|
|
1279
1305
|
common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
|
|
1280
|
-
}).optional()
|
|
1306
|
+
}).optional().describe("Visionline-specific metadata for the credential.")
|
|
1281
1307
|
});
|
|
1282
1308
|
var acs_entrance = zod.z.object({
|
|
1283
1309
|
acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the entrance."),
|
|
@@ -2859,20 +2885,49 @@ var openapi_default = {
|
|
|
2859
2885
|
type: "object"
|
|
2860
2886
|
},
|
|
2861
2887
|
acs_credential: {
|
|
2888
|
+
description: "Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
2862
2889
|
properties: {
|
|
2863
2890
|
access_method: {
|
|
2891
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
2864
2892
|
enum: ["code", "card", "mobile_key"],
|
|
2865
2893
|
type: "string"
|
|
2866
2894
|
},
|
|
2867
|
-
acs_credential_id: {
|
|
2895
|
+
acs_credential_id: {
|
|
2896
|
+
description: "ID of the credential.",
|
|
2897
|
+
format: "uuid",
|
|
2898
|
+
type: "string"
|
|
2899
|
+
},
|
|
2868
2900
|
acs_credential_pool_id: { format: "uuid", type: "string" },
|
|
2869
|
-
acs_system_id: {
|
|
2870
|
-
|
|
2901
|
+
acs_system_id: {
|
|
2902
|
+
description: "ID of the access control system that contains the credential.",
|
|
2903
|
+
format: "uuid",
|
|
2904
|
+
type: "string"
|
|
2905
|
+
},
|
|
2906
|
+
acs_user_id: {
|
|
2907
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
2908
|
+
format: "uuid",
|
|
2909
|
+
type: "string"
|
|
2910
|
+
},
|
|
2871
2911
|
card_number: { nullable: true, type: "string" },
|
|
2872
|
-
code: {
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
|
|
2912
|
+
code: {
|
|
2913
|
+
description: "Access (PIN) code for the credential.",
|
|
2914
|
+
nullable: true,
|
|
2915
|
+
type: "string"
|
|
2916
|
+
},
|
|
2917
|
+
created_at: {
|
|
2918
|
+
description: "Date and time at which the credential was created.",
|
|
2919
|
+
format: "date-time",
|
|
2920
|
+
type: "string"
|
|
2921
|
+
},
|
|
2922
|
+
display_name: {
|
|
2923
|
+
description: "Display name that corresponds to the credential type.",
|
|
2924
|
+
minLength: 1,
|
|
2925
|
+
type: "string"
|
|
2926
|
+
},
|
|
2927
|
+
ends_at: {
|
|
2928
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
2929
|
+
type: "string"
|
|
2930
|
+
},
|
|
2876
2931
|
errors: {
|
|
2877
2932
|
items: {
|
|
2878
2933
|
properties: {
|
|
@@ -2885,6 +2940,7 @@ var openapi_default = {
|
|
|
2885
2940
|
type: "array"
|
|
2886
2941
|
},
|
|
2887
2942
|
external_type: {
|
|
2943
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
2888
2944
|
enum: [
|
|
2889
2945
|
"pti_card",
|
|
2890
2946
|
"brivo_credential",
|
|
@@ -2894,19 +2950,37 @@ var openapi_default = {
|
|
|
2894
2950
|
],
|
|
2895
2951
|
type: "string"
|
|
2896
2952
|
},
|
|
2897
|
-
external_type_display_name: {
|
|
2953
|
+
external_type_display_name: {
|
|
2954
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
2955
|
+
type: "string"
|
|
2956
|
+
},
|
|
2898
2957
|
is_issued: { type: "boolean" },
|
|
2899
|
-
is_latest_desired_state_synced_with_provider: {
|
|
2958
|
+
is_latest_desired_state_synced_with_provider: {
|
|
2959
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
2960
|
+
type: "boolean"
|
|
2961
|
+
},
|
|
2900
2962
|
is_managed: { enum: [true], type: "boolean" },
|
|
2901
|
-
is_multi_phone_sync_credential: {
|
|
2963
|
+
is_multi_phone_sync_credential: {
|
|
2964
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
2965
|
+
type: "boolean"
|
|
2966
|
+
},
|
|
2902
2967
|
issued_at: { format: "date-time", nullable: true, type: "string" },
|
|
2903
2968
|
latest_desired_state_synced_with_provider_at: {
|
|
2969
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
2904
2970
|
format: "date-time",
|
|
2905
2971
|
type: "string"
|
|
2906
2972
|
},
|
|
2907
|
-
parent_acs_credential_id: {
|
|
2908
|
-
|
|
2973
|
+
parent_acs_credential_id: {
|
|
2974
|
+
description: "ID of the parent credential.",
|
|
2975
|
+
format: "uuid",
|
|
2976
|
+
type: "string"
|
|
2977
|
+
},
|
|
2978
|
+
starts_at: {
|
|
2979
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
2980
|
+
type: "string"
|
|
2981
|
+
},
|
|
2909
2982
|
visionline_metadata: {
|
|
2983
|
+
description: "Visionline-specific metadata for the credential.",
|
|
2910
2984
|
properties: {
|
|
2911
2985
|
auto_join: { type: "boolean" },
|
|
2912
2986
|
card_function_type: { enum: ["guest", "staff"], type: "string" },
|
|
@@ -2940,7 +3014,11 @@ var openapi_default = {
|
|
|
2940
3014
|
},
|
|
2941
3015
|
type: "array"
|
|
2942
3016
|
},
|
|
2943
|
-
workspace_id: {
|
|
3017
|
+
workspace_id: {
|
|
3018
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
3019
|
+
format: "uuid",
|
|
3020
|
+
type: "string"
|
|
3021
|
+
}
|
|
2944
3022
|
},
|
|
2945
3023
|
required: [
|
|
2946
3024
|
"acs_credential_id",
|
|
@@ -3860,6 +3938,7 @@ var openapi_default = {
|
|
|
3860
3938
|
type: "string"
|
|
3861
3939
|
},
|
|
3862
3940
|
visionline_metadata: {
|
|
3941
|
+
description: "Visionline-specific metadata for the credential.",
|
|
3863
3942
|
properties: {
|
|
3864
3943
|
cancelled: { type: "boolean" },
|
|
3865
3944
|
card_format: {
|
|
@@ -3913,23 +3992,52 @@ var openapi_default = {
|
|
|
3913
3992
|
nullable: true,
|
|
3914
3993
|
oneOf: [
|
|
3915
3994
|
{
|
|
3995
|
+
description: "Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
3916
3996
|
properties: {
|
|
3917
3997
|
access_method: {
|
|
3998
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
3918
3999
|
enum: ["code", "card", "mobile_key"],
|
|
3919
4000
|
type: "string"
|
|
3920
4001
|
},
|
|
3921
|
-
acs_credential_id: {
|
|
4002
|
+
acs_credential_id: {
|
|
4003
|
+
description: "ID of the credential.",
|
|
4004
|
+
format: "uuid",
|
|
4005
|
+
type: "string"
|
|
4006
|
+
},
|
|
3922
4007
|
acs_credential_pool_id: {
|
|
3923
4008
|
format: "uuid",
|
|
3924
4009
|
type: "string"
|
|
3925
4010
|
},
|
|
3926
|
-
acs_system_id: {
|
|
3927
|
-
|
|
4011
|
+
acs_system_id: {
|
|
4012
|
+
description: "ID of the access control system that contains the credential.",
|
|
4013
|
+
format: "uuid",
|
|
4014
|
+
type: "string"
|
|
4015
|
+
},
|
|
4016
|
+
acs_user_id: {
|
|
4017
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
4018
|
+
format: "uuid",
|
|
4019
|
+
type: "string"
|
|
4020
|
+
},
|
|
3928
4021
|
card_number: { nullable: true, type: "string" },
|
|
3929
|
-
code: {
|
|
3930
|
-
|
|
3931
|
-
|
|
3932
|
-
|
|
4022
|
+
code: {
|
|
4023
|
+
description: "Access (PIN) code for the credential.",
|
|
4024
|
+
nullable: true,
|
|
4025
|
+
type: "string"
|
|
4026
|
+
},
|
|
4027
|
+
created_at: {
|
|
4028
|
+
description: "Date and time at which the credential was created.",
|
|
4029
|
+
format: "date-time",
|
|
4030
|
+
type: "string"
|
|
4031
|
+
},
|
|
4032
|
+
display_name: {
|
|
4033
|
+
description: "Display name that corresponds to the credential type.",
|
|
4034
|
+
minLength: 1,
|
|
4035
|
+
type: "string"
|
|
4036
|
+
},
|
|
4037
|
+
ends_at: {
|
|
4038
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
4039
|
+
type: "string"
|
|
4040
|
+
},
|
|
3933
4041
|
errors: {
|
|
3934
4042
|
items: {
|
|
3935
4043
|
properties: {
|
|
@@ -3942,6 +4050,7 @@ var openapi_default = {
|
|
|
3942
4050
|
type: "array"
|
|
3943
4051
|
},
|
|
3944
4052
|
external_type: {
|
|
4053
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
3945
4054
|
enum: [
|
|
3946
4055
|
"pti_card",
|
|
3947
4056
|
"brivo_credential",
|
|
@@ -3951,28 +4060,41 @@ var openapi_default = {
|
|
|
3951
4060
|
],
|
|
3952
4061
|
type: "string"
|
|
3953
4062
|
},
|
|
3954
|
-
external_type_display_name: {
|
|
4063
|
+
external_type_display_name: {
|
|
4064
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
4065
|
+
type: "string"
|
|
4066
|
+
},
|
|
3955
4067
|
is_issued: { type: "boolean" },
|
|
3956
4068
|
is_latest_desired_state_synced_with_provider: {
|
|
4069
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
3957
4070
|
type: "boolean"
|
|
3958
4071
|
},
|
|
3959
4072
|
is_managed: { enum: [true], type: "boolean" },
|
|
3960
|
-
is_multi_phone_sync_credential: {
|
|
4073
|
+
is_multi_phone_sync_credential: {
|
|
4074
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
4075
|
+
type: "boolean"
|
|
4076
|
+
},
|
|
3961
4077
|
issued_at: {
|
|
3962
4078
|
format: "date-time",
|
|
3963
4079
|
nullable: true,
|
|
3964
4080
|
type: "string"
|
|
3965
4081
|
},
|
|
3966
4082
|
latest_desired_state_synced_with_provider_at: {
|
|
4083
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
3967
4084
|
format: "date-time",
|
|
3968
4085
|
type: "string"
|
|
3969
4086
|
},
|
|
3970
4087
|
parent_acs_credential_id: {
|
|
4088
|
+
description: "ID of the parent credential.",
|
|
3971
4089
|
format: "uuid",
|
|
3972
4090
|
type: "string"
|
|
3973
4091
|
},
|
|
3974
|
-
starts_at: {
|
|
4092
|
+
starts_at: {
|
|
4093
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
4094
|
+
type: "string"
|
|
4095
|
+
},
|
|
3975
4096
|
visionline_metadata: {
|
|
4097
|
+
description: "Visionline-specific metadata for the credential.",
|
|
3976
4098
|
properties: {
|
|
3977
4099
|
auto_join: { type: "boolean" },
|
|
3978
4100
|
card_function_type: {
|
|
@@ -4009,7 +4131,11 @@ var openapi_default = {
|
|
|
4009
4131
|
},
|
|
4010
4132
|
type: "array"
|
|
4011
4133
|
},
|
|
4012
|
-
workspace_id: {
|
|
4134
|
+
workspace_id: {
|
|
4135
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
4136
|
+
format: "uuid",
|
|
4137
|
+
type: "string"
|
|
4138
|
+
}
|
|
4013
4139
|
},
|
|
4014
4140
|
required: [
|
|
4015
4141
|
"acs_credential_id",
|
|
@@ -4025,23 +4151,52 @@ var openapi_default = {
|
|
|
4025
4151
|
type: "object"
|
|
4026
4152
|
},
|
|
4027
4153
|
{
|
|
4154
|
+
description: "Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
4028
4155
|
properties: {
|
|
4029
4156
|
access_method: {
|
|
4157
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
4030
4158
|
enum: ["code", "card", "mobile_key"],
|
|
4031
4159
|
type: "string"
|
|
4032
4160
|
},
|
|
4033
|
-
acs_credential_id: {
|
|
4161
|
+
acs_credential_id: {
|
|
4162
|
+
description: "ID of the credential.",
|
|
4163
|
+
format: "uuid",
|
|
4164
|
+
type: "string"
|
|
4165
|
+
},
|
|
4034
4166
|
acs_credential_pool_id: {
|
|
4035
4167
|
format: "uuid",
|
|
4036
4168
|
type: "string"
|
|
4037
4169
|
},
|
|
4038
|
-
acs_system_id: {
|
|
4039
|
-
|
|
4170
|
+
acs_system_id: {
|
|
4171
|
+
description: "ID of the access control system that contains the credential.",
|
|
4172
|
+
format: "uuid",
|
|
4173
|
+
type: "string"
|
|
4174
|
+
},
|
|
4175
|
+
acs_user_id: {
|
|
4176
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
4177
|
+
format: "uuid",
|
|
4178
|
+
type: "string"
|
|
4179
|
+
},
|
|
4040
4180
|
card_number: { nullable: true, type: "string" },
|
|
4041
|
-
code: {
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4181
|
+
code: {
|
|
4182
|
+
description: "Access (PIN) code for the credential.",
|
|
4183
|
+
nullable: true,
|
|
4184
|
+
type: "string"
|
|
4185
|
+
},
|
|
4186
|
+
created_at: {
|
|
4187
|
+
description: "Date and time at which the credential was created.",
|
|
4188
|
+
format: "date-time",
|
|
4189
|
+
type: "string"
|
|
4190
|
+
},
|
|
4191
|
+
display_name: {
|
|
4192
|
+
description: "Display name that corresponds to the credential type.",
|
|
4193
|
+
minLength: 1,
|
|
4194
|
+
type: "string"
|
|
4195
|
+
},
|
|
4196
|
+
ends_at: {
|
|
4197
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
4198
|
+
type: "string"
|
|
4199
|
+
},
|
|
4045
4200
|
errors: {
|
|
4046
4201
|
items: {
|
|
4047
4202
|
properties: {
|
|
@@ -4054,6 +4209,7 @@ var openapi_default = {
|
|
|
4054
4209
|
type: "array"
|
|
4055
4210
|
},
|
|
4056
4211
|
external_type: {
|
|
4212
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
4057
4213
|
enum: [
|
|
4058
4214
|
"pti_card",
|
|
4059
4215
|
"brivo_credential",
|
|
@@ -4063,28 +4219,41 @@ var openapi_default = {
|
|
|
4063
4219
|
],
|
|
4064
4220
|
type: "string"
|
|
4065
4221
|
},
|
|
4066
|
-
external_type_display_name: {
|
|
4222
|
+
external_type_display_name: {
|
|
4223
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
4224
|
+
type: "string"
|
|
4225
|
+
},
|
|
4067
4226
|
is_issued: { type: "boolean" },
|
|
4068
4227
|
is_latest_desired_state_synced_with_provider: {
|
|
4228
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
4069
4229
|
type: "boolean"
|
|
4070
4230
|
},
|
|
4071
4231
|
is_managed: { enum: [false], type: "boolean" },
|
|
4072
|
-
is_multi_phone_sync_credential: {
|
|
4232
|
+
is_multi_phone_sync_credential: {
|
|
4233
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
4234
|
+
type: "boolean"
|
|
4235
|
+
},
|
|
4073
4236
|
issued_at: {
|
|
4074
4237
|
format: "date-time",
|
|
4075
4238
|
nullable: true,
|
|
4076
4239
|
type: "string"
|
|
4077
4240
|
},
|
|
4078
4241
|
latest_desired_state_synced_with_provider_at: {
|
|
4242
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
4079
4243
|
format: "date-time",
|
|
4080
4244
|
type: "string"
|
|
4081
4245
|
},
|
|
4082
4246
|
parent_acs_credential_id: {
|
|
4247
|
+
description: "ID of the parent credential.",
|
|
4083
4248
|
format: "uuid",
|
|
4084
4249
|
type: "string"
|
|
4085
4250
|
},
|
|
4086
|
-
starts_at: {
|
|
4251
|
+
starts_at: {
|
|
4252
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
4253
|
+
type: "string"
|
|
4254
|
+
},
|
|
4087
4255
|
visionline_metadata: {
|
|
4256
|
+
description: "Visionline-specific metadata for the credential.",
|
|
4088
4257
|
properties: {
|
|
4089
4258
|
auto_join: { type: "boolean" },
|
|
4090
4259
|
card_function_type: {
|
|
@@ -4121,7 +4290,11 @@ var openapi_default = {
|
|
|
4121
4290
|
},
|
|
4122
4291
|
type: "array"
|
|
4123
4292
|
},
|
|
4124
|
-
workspace_id: {
|
|
4293
|
+
workspace_id: {
|
|
4294
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
4295
|
+
format: "uuid",
|
|
4296
|
+
type: "string"
|
|
4297
|
+
}
|
|
4125
4298
|
},
|
|
4126
4299
|
required: [
|
|
4127
4300
|
"acs_credential_id",
|
|
@@ -4236,25 +4409,55 @@ var openapi_default = {
|
|
|
4236
4409
|
action_type: { enum: ["ENCODE_CARD"], type: "string" },
|
|
4237
4410
|
error: { nullable: true },
|
|
4238
4411
|
result: {
|
|
4412
|
+
description: "Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
4239
4413
|
oneOf: [
|
|
4240
4414
|
{
|
|
4415
|
+
description: "Means by which a user gains access at an entrance.\n\n The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
4241
4416
|
properties: {
|
|
4242
4417
|
access_method: {
|
|
4418
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
4243
4419
|
enum: ["code", "card", "mobile_key"],
|
|
4244
4420
|
type: "string"
|
|
4245
4421
|
},
|
|
4246
|
-
acs_credential_id: {
|
|
4422
|
+
acs_credential_id: {
|
|
4423
|
+
description: "ID of the credential.",
|
|
4424
|
+
format: "uuid",
|
|
4425
|
+
type: "string"
|
|
4426
|
+
},
|
|
4247
4427
|
acs_credential_pool_id: {
|
|
4248
4428
|
format: "uuid",
|
|
4249
4429
|
type: "string"
|
|
4250
4430
|
},
|
|
4251
|
-
acs_system_id: {
|
|
4252
|
-
|
|
4431
|
+
acs_system_id: {
|
|
4432
|
+
description: "ID of the access control system that contains the credential.",
|
|
4433
|
+
format: "uuid",
|
|
4434
|
+
type: "string"
|
|
4435
|
+
},
|
|
4436
|
+
acs_user_id: {
|
|
4437
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
4438
|
+
format: "uuid",
|
|
4439
|
+
type: "string"
|
|
4440
|
+
},
|
|
4253
4441
|
card_number: { nullable: true, type: "string" },
|
|
4254
|
-
code: {
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
|
|
4442
|
+
code: {
|
|
4443
|
+
description: "Access (PIN) code for the credential.",
|
|
4444
|
+
nullable: true,
|
|
4445
|
+
type: "string"
|
|
4446
|
+
},
|
|
4447
|
+
created_at: {
|
|
4448
|
+
description: "Date and time at which the credential was created.",
|
|
4449
|
+
format: "date-time",
|
|
4450
|
+
type: "string"
|
|
4451
|
+
},
|
|
4452
|
+
display_name: {
|
|
4453
|
+
description: "Display name that corresponds to the credential type.",
|
|
4454
|
+
minLength: 1,
|
|
4455
|
+
type: "string"
|
|
4456
|
+
},
|
|
4457
|
+
ends_at: {
|
|
4458
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
4459
|
+
type: "string"
|
|
4460
|
+
},
|
|
4258
4461
|
errors: {
|
|
4259
4462
|
items: {
|
|
4260
4463
|
properties: {
|
|
@@ -4267,6 +4470,7 @@ var openapi_default = {
|
|
|
4267
4470
|
type: "array"
|
|
4268
4471
|
},
|
|
4269
4472
|
external_type: {
|
|
4473
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
4270
4474
|
enum: [
|
|
4271
4475
|
"pti_card",
|
|
4272
4476
|
"brivo_credential",
|
|
@@ -4276,28 +4480,41 @@ var openapi_default = {
|
|
|
4276
4480
|
],
|
|
4277
4481
|
type: "string"
|
|
4278
4482
|
},
|
|
4279
|
-
external_type_display_name: {
|
|
4483
|
+
external_type_display_name: {
|
|
4484
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
4485
|
+
type: "string"
|
|
4486
|
+
},
|
|
4280
4487
|
is_issued: { type: "boolean" },
|
|
4281
4488
|
is_latest_desired_state_synced_with_provider: {
|
|
4489
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
4282
4490
|
type: "boolean"
|
|
4283
4491
|
},
|
|
4284
4492
|
is_managed: { enum: [true], type: "boolean" },
|
|
4285
|
-
is_multi_phone_sync_credential: {
|
|
4493
|
+
is_multi_phone_sync_credential: {
|
|
4494
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
4495
|
+
type: "boolean"
|
|
4496
|
+
},
|
|
4286
4497
|
issued_at: {
|
|
4287
4498
|
format: "date-time",
|
|
4288
4499
|
nullable: true,
|
|
4289
4500
|
type: "string"
|
|
4290
4501
|
},
|
|
4291
4502
|
latest_desired_state_synced_with_provider_at: {
|
|
4503
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
4292
4504
|
format: "date-time",
|
|
4293
4505
|
type: "string"
|
|
4294
4506
|
},
|
|
4295
4507
|
parent_acs_credential_id: {
|
|
4508
|
+
description: "ID of the parent credential.",
|
|
4296
4509
|
format: "uuid",
|
|
4297
4510
|
type: "string"
|
|
4298
4511
|
},
|
|
4299
|
-
starts_at: {
|
|
4512
|
+
starts_at: {
|
|
4513
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
4514
|
+
type: "string"
|
|
4515
|
+
},
|
|
4300
4516
|
visionline_metadata: {
|
|
4517
|
+
description: "Visionline-specific metadata for the credential.",
|
|
4301
4518
|
properties: {
|
|
4302
4519
|
auto_join: { type: "boolean" },
|
|
4303
4520
|
card_function_type: {
|
|
@@ -4334,7 +4551,11 @@ var openapi_default = {
|
|
|
4334
4551
|
},
|
|
4335
4552
|
type: "array"
|
|
4336
4553
|
},
|
|
4337
|
-
workspace_id: {
|
|
4554
|
+
workspace_id: {
|
|
4555
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
4556
|
+
format: "uuid",
|
|
4557
|
+
type: "string"
|
|
4558
|
+
}
|
|
4338
4559
|
},
|
|
4339
4560
|
required: [
|
|
4340
4561
|
"acs_credential_id",
|
|
@@ -4350,23 +4571,52 @@ var openapi_default = {
|
|
|
4350
4571
|
type: "object"
|
|
4351
4572
|
},
|
|
4352
4573
|
{
|
|
4574
|
+
description: "Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
4353
4575
|
properties: {
|
|
4354
4576
|
access_method: {
|
|
4577
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
4355
4578
|
enum: ["code", "card", "mobile_key"],
|
|
4356
4579
|
type: "string"
|
|
4357
4580
|
},
|
|
4358
|
-
acs_credential_id: {
|
|
4581
|
+
acs_credential_id: {
|
|
4582
|
+
description: "ID of the credential.",
|
|
4583
|
+
format: "uuid",
|
|
4584
|
+
type: "string"
|
|
4585
|
+
},
|
|
4359
4586
|
acs_credential_pool_id: {
|
|
4360
4587
|
format: "uuid",
|
|
4361
4588
|
type: "string"
|
|
4362
4589
|
},
|
|
4363
|
-
acs_system_id: {
|
|
4364
|
-
|
|
4590
|
+
acs_system_id: {
|
|
4591
|
+
description: "ID of the access control system that contains the credential.",
|
|
4592
|
+
format: "uuid",
|
|
4593
|
+
type: "string"
|
|
4594
|
+
},
|
|
4595
|
+
acs_user_id: {
|
|
4596
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
4597
|
+
format: "uuid",
|
|
4598
|
+
type: "string"
|
|
4599
|
+
},
|
|
4365
4600
|
card_number: { nullable: true, type: "string" },
|
|
4366
|
-
code: {
|
|
4367
|
-
|
|
4368
|
-
|
|
4369
|
-
|
|
4601
|
+
code: {
|
|
4602
|
+
description: "Access (PIN) code for the credential.",
|
|
4603
|
+
nullable: true,
|
|
4604
|
+
type: "string"
|
|
4605
|
+
},
|
|
4606
|
+
created_at: {
|
|
4607
|
+
description: "Date and time at which the credential was created.",
|
|
4608
|
+
format: "date-time",
|
|
4609
|
+
type: "string"
|
|
4610
|
+
},
|
|
4611
|
+
display_name: {
|
|
4612
|
+
description: "Display name that corresponds to the credential type.",
|
|
4613
|
+
minLength: 1,
|
|
4614
|
+
type: "string"
|
|
4615
|
+
},
|
|
4616
|
+
ends_at: {
|
|
4617
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
4618
|
+
type: "string"
|
|
4619
|
+
},
|
|
4370
4620
|
errors: {
|
|
4371
4621
|
items: {
|
|
4372
4622
|
properties: {
|
|
@@ -4379,6 +4629,7 @@ var openapi_default = {
|
|
|
4379
4629
|
type: "array"
|
|
4380
4630
|
},
|
|
4381
4631
|
external_type: {
|
|
4632
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
4382
4633
|
enum: [
|
|
4383
4634
|
"pti_card",
|
|
4384
4635
|
"brivo_credential",
|
|
@@ -4388,28 +4639,41 @@ var openapi_default = {
|
|
|
4388
4639
|
],
|
|
4389
4640
|
type: "string"
|
|
4390
4641
|
},
|
|
4391
|
-
external_type_display_name: {
|
|
4642
|
+
external_type_display_name: {
|
|
4643
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
4644
|
+
type: "string"
|
|
4645
|
+
},
|
|
4392
4646
|
is_issued: { type: "boolean" },
|
|
4393
4647
|
is_latest_desired_state_synced_with_provider: {
|
|
4648
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
4394
4649
|
type: "boolean"
|
|
4395
4650
|
},
|
|
4396
4651
|
is_managed: { enum: [false], type: "boolean" },
|
|
4397
|
-
is_multi_phone_sync_credential: {
|
|
4652
|
+
is_multi_phone_sync_credential: {
|
|
4653
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
4654
|
+
type: "boolean"
|
|
4655
|
+
},
|
|
4398
4656
|
issued_at: {
|
|
4399
4657
|
format: "date-time",
|
|
4400
4658
|
nullable: true,
|
|
4401
4659
|
type: "string"
|
|
4402
4660
|
},
|
|
4403
4661
|
latest_desired_state_synced_with_provider_at: {
|
|
4662
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
4404
4663
|
format: "date-time",
|
|
4405
4664
|
type: "string"
|
|
4406
4665
|
},
|
|
4407
4666
|
parent_acs_credential_id: {
|
|
4667
|
+
description: "ID of the parent credential.",
|
|
4408
4668
|
format: "uuid",
|
|
4409
4669
|
type: "string"
|
|
4410
4670
|
},
|
|
4411
|
-
starts_at: {
|
|
4671
|
+
starts_at: {
|
|
4672
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
4673
|
+
type: "string"
|
|
4674
|
+
},
|
|
4412
4675
|
visionline_metadata: {
|
|
4676
|
+
description: "Visionline-specific metadata for the credential.",
|
|
4413
4677
|
properties: {
|
|
4414
4678
|
auto_join: { type: "boolean" },
|
|
4415
4679
|
card_function_type: {
|
|
@@ -4446,7 +4710,11 @@ var openapi_default = {
|
|
|
4446
4710
|
},
|
|
4447
4711
|
type: "array"
|
|
4448
4712
|
},
|
|
4449
|
-
workspace_id: {
|
|
4713
|
+
workspace_id: {
|
|
4714
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
4715
|
+
format: "uuid",
|
|
4716
|
+
type: "string"
|
|
4717
|
+
}
|
|
4450
4718
|
},
|
|
4451
4719
|
required: [
|
|
4452
4720
|
"acs_credential_id",
|
|
@@ -9921,14 +10189,23 @@ var openapi_default = {
|
|
|
9921
10189
|
},
|
|
9922
10190
|
"/acs/credentials/assign": {
|
|
9923
10191
|
patch: {
|
|
10192
|
+
description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
9924
10193
|
operationId: "acsCredentialsAssignPatch",
|
|
9925
10194
|
requestBody: {
|
|
9926
10195
|
content: {
|
|
9927
10196
|
"application/json": {
|
|
9928
10197
|
schema: {
|
|
9929
10198
|
properties: {
|
|
9930
|
-
acs_credential_id: {
|
|
9931
|
-
|
|
10199
|
+
acs_credential_id: {
|
|
10200
|
+
description: "ID of the desired credential.",
|
|
10201
|
+
format: "uuid",
|
|
10202
|
+
type: "string"
|
|
10203
|
+
},
|
|
10204
|
+
acs_user_id: {
|
|
10205
|
+
description: "ID of the desired user.",
|
|
10206
|
+
format: "uuid",
|
|
10207
|
+
type: "string"
|
|
10208
|
+
}
|
|
9932
10209
|
},
|
|
9933
10210
|
required: ["acs_user_id", "acs_credential_id"],
|
|
9934
10211
|
type: "object"
|
|
@@ -9965,17 +10242,27 @@ var openapi_default = {
|
|
|
9965
10242
|
summary: "/acs/credentials/assign",
|
|
9966
10243
|
tags: ["/acs"],
|
|
9967
10244
|
"x-fern-ignore": true,
|
|
9968
|
-
"x-response-key": null
|
|
10245
|
+
"x-response-key": null,
|
|
10246
|
+
"x-title": "Assign a Credential to an ACS User"
|
|
9969
10247
|
},
|
|
9970
10248
|
post: {
|
|
10249
|
+
description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
9971
10250
|
operationId: "acsCredentialsAssignPost",
|
|
9972
10251
|
requestBody: {
|
|
9973
10252
|
content: {
|
|
9974
10253
|
"application/json": {
|
|
9975
10254
|
schema: {
|
|
9976
10255
|
properties: {
|
|
9977
|
-
acs_credential_id: {
|
|
9978
|
-
|
|
10256
|
+
acs_credential_id: {
|
|
10257
|
+
description: "ID of the desired credential.",
|
|
10258
|
+
format: "uuid",
|
|
10259
|
+
type: "string"
|
|
10260
|
+
},
|
|
10261
|
+
acs_user_id: {
|
|
10262
|
+
description: "ID of the desired user.",
|
|
10263
|
+
format: "uuid",
|
|
10264
|
+
type: "string"
|
|
10265
|
+
}
|
|
9979
10266
|
},
|
|
9980
10267
|
required: ["acs_user_id", "acs_credential_id"],
|
|
9981
10268
|
type: "object"
|
|
@@ -10013,11 +10300,13 @@ var openapi_default = {
|
|
|
10013
10300
|
tags: ["/acs"],
|
|
10014
10301
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10015
10302
|
"x-fern-sdk-method-name": "assign",
|
|
10016
|
-
"x-response-key": null
|
|
10303
|
+
"x-response-key": null,
|
|
10304
|
+
"x-title": "Assign a Credential to an ACS User"
|
|
10017
10305
|
}
|
|
10018
10306
|
},
|
|
10019
10307
|
"/acs/credentials/create": {
|
|
10020
10308
|
post: {
|
|
10309
|
+
description: "Creates a new [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10021
10310
|
operationId: "acsCredentialsCreatePost",
|
|
10022
10311
|
requestBody: {
|
|
10023
10312
|
content: {
|
|
@@ -10025,27 +10314,48 @@ var openapi_default = {
|
|
|
10025
10314
|
schema: {
|
|
10026
10315
|
properties: {
|
|
10027
10316
|
access_method: {
|
|
10317
|
+
description: "Access method for the new credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
10028
10318
|
enum: ["code", "card", "mobile_key"],
|
|
10029
10319
|
type: "string"
|
|
10030
10320
|
},
|
|
10031
|
-
acs_user_id: {
|
|
10321
|
+
acs_user_id: {
|
|
10322
|
+
description: "ID of the ACS user to whom the new credential belongs.",
|
|
10323
|
+
format: "uuid",
|
|
10324
|
+
type: "string"
|
|
10325
|
+
},
|
|
10032
10326
|
allowed_acs_entrance_ids: {
|
|
10033
10327
|
default: [],
|
|
10328
|
+
description: "Set of IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access.",
|
|
10034
10329
|
items: { format: "uuid", type: "string" },
|
|
10035
10330
|
type: "array"
|
|
10036
10331
|
},
|
|
10037
|
-
code: {
|
|
10332
|
+
code: {
|
|
10333
|
+
description: "Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview).",
|
|
10334
|
+
pattern: "^\\d+$",
|
|
10335
|
+
type: "string"
|
|
10336
|
+
},
|
|
10038
10337
|
credential_manager_acs_system_id: {
|
|
10338
|
+
description: "ACS system ID of the credential manager for the new credential.",
|
|
10039
10339
|
format: "uuid",
|
|
10040
10340
|
type: "string"
|
|
10041
10341
|
},
|
|
10042
|
-
ends_at: {
|
|
10342
|
+
ends_at: {
|
|
10343
|
+
description: "Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
10344
|
+
format: "date-time",
|
|
10345
|
+
type: "string"
|
|
10346
|
+
},
|
|
10043
10347
|
is_multi_phone_sync_credential: {
|
|
10044
10348
|
default: false,
|
|
10349
|
+
description: "Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
10045
10350
|
type: "boolean"
|
|
10046
10351
|
},
|
|
10047
|
-
starts_at: {
|
|
10352
|
+
starts_at: {
|
|
10353
|
+
description: "Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
10354
|
+
format: "date-time",
|
|
10355
|
+
type: "string"
|
|
10356
|
+
},
|
|
10048
10357
|
visionline_metadata: {
|
|
10358
|
+
description: "Visionline-specific metadata for the new credential.",
|
|
10049
10359
|
properties: {
|
|
10050
10360
|
assa_abloy_credential_service_mobile_endpoint_id: {
|
|
10051
10361
|
format: "uuid",
|
|
@@ -10112,18 +10422,24 @@ var openapi_default = {
|
|
|
10112
10422
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10113
10423
|
"x-fern-sdk-method-name": "create",
|
|
10114
10424
|
"x-fern-sdk-return-value": "acs_credential",
|
|
10115
|
-
"x-response-key": "acs_credential"
|
|
10425
|
+
"x-response-key": "acs_credential",
|
|
10426
|
+
"x-title": "Create a Credential for an ACS User"
|
|
10116
10427
|
}
|
|
10117
10428
|
},
|
|
10118
10429
|
"/acs/credentials/delete": {
|
|
10119
10430
|
post: {
|
|
10431
|
+
description: "Deletes a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10120
10432
|
operationId: "acsCredentialsDeletePost",
|
|
10121
10433
|
requestBody: {
|
|
10122
10434
|
content: {
|
|
10123
10435
|
"application/json": {
|
|
10124
10436
|
schema: {
|
|
10125
10437
|
properties: {
|
|
10126
|
-
acs_credential_id: {
|
|
10438
|
+
acs_credential_id: {
|
|
10439
|
+
description: "ID of the desired credential.",
|
|
10440
|
+
format: "uuid",
|
|
10441
|
+
type: "string"
|
|
10442
|
+
}
|
|
10127
10443
|
},
|
|
10128
10444
|
required: ["acs_credential_id"],
|
|
10129
10445
|
type: "object"
|
|
@@ -10156,18 +10472,24 @@ var openapi_default = {
|
|
|
10156
10472
|
tags: ["/acs"],
|
|
10157
10473
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10158
10474
|
"x-fern-sdk-method-name": "delete",
|
|
10159
|
-
"x-response-key": null
|
|
10475
|
+
"x-response-key": null,
|
|
10476
|
+
"x-title": "Delete a Credential"
|
|
10160
10477
|
}
|
|
10161
10478
|
},
|
|
10162
10479
|
"/acs/credentials/get": {
|
|
10163
10480
|
post: {
|
|
10481
|
+
description: "Returns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10164
10482
|
operationId: "acsCredentialsGetPost",
|
|
10165
10483
|
requestBody: {
|
|
10166
10484
|
content: {
|
|
10167
10485
|
"application/json": {
|
|
10168
10486
|
schema: {
|
|
10169
10487
|
properties: {
|
|
10170
|
-
acs_credential_id: {
|
|
10488
|
+
acs_credential_id: {
|
|
10489
|
+
description: "ID of the desired credential.",
|
|
10490
|
+
format: "uuid",
|
|
10491
|
+
type: "string"
|
|
10492
|
+
}
|
|
10171
10493
|
},
|
|
10172
10494
|
required: ["acs_credential_id"],
|
|
10173
10495
|
type: "object"
|
|
@@ -10206,11 +10528,13 @@ var openapi_default = {
|
|
|
10206
10528
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10207
10529
|
"x-fern-sdk-method-name": "get",
|
|
10208
10530
|
"x-fern-sdk-return-value": "acs_credential",
|
|
10209
|
-
"x-response-key": "acs_credential"
|
|
10531
|
+
"x-response-key": "acs_credential",
|
|
10532
|
+
"x-title": "Get a Credential"
|
|
10210
10533
|
}
|
|
10211
10534
|
},
|
|
10212
10535
|
"/acs/credentials/list": {
|
|
10213
10536
|
post: {
|
|
10537
|
+
description: "Returns a list of all [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10214
10538
|
operationId: "acsCredentialsListPost",
|
|
10215
10539
|
requestBody: {
|
|
10216
10540
|
content: {
|
|
@@ -10221,29 +10545,49 @@ var openapi_default = {
|
|
|
10221
10545
|
oneOf: [
|
|
10222
10546
|
{
|
|
10223
10547
|
properties: {
|
|
10224
|
-
acs_user_id: {
|
|
10548
|
+
acs_user_id: {
|
|
10549
|
+
description: "ID of the ACS user for which you want to retrieve all credentials.",
|
|
10550
|
+
format: "uuid",
|
|
10551
|
+
type: "string"
|
|
10552
|
+
}
|
|
10225
10553
|
},
|
|
10226
10554
|
required: ["acs_user_id"],
|
|
10227
10555
|
type: "object"
|
|
10228
10556
|
},
|
|
10229
10557
|
{
|
|
10230
10558
|
properties: {
|
|
10231
|
-
acs_system_id: {
|
|
10559
|
+
acs_system_id: {
|
|
10560
|
+
description: "ID of the access control system for which you want to retrieve all credentials.",
|
|
10561
|
+
format: "uuid",
|
|
10562
|
+
type: "string"
|
|
10563
|
+
}
|
|
10232
10564
|
},
|
|
10233
10565
|
required: ["acs_system_id"],
|
|
10234
10566
|
type: "object"
|
|
10235
10567
|
},
|
|
10236
10568
|
{
|
|
10237
10569
|
properties: {
|
|
10238
|
-
acs_system_id: {
|
|
10239
|
-
|
|
10570
|
+
acs_system_id: {
|
|
10571
|
+
description: "ID of the access control system for which you want to retrieve all credentials.",
|
|
10572
|
+
format: "uuid",
|
|
10573
|
+
type: "string"
|
|
10574
|
+
},
|
|
10575
|
+
acs_user_id: {
|
|
10576
|
+
description: "ID of the ACS user for which you want to retrieve all credentials.",
|
|
10577
|
+
format: "uuid",
|
|
10578
|
+
type: "string"
|
|
10579
|
+
}
|
|
10240
10580
|
},
|
|
10241
10581
|
required: ["acs_user_id", "acs_system_id"],
|
|
10242
10582
|
type: "object"
|
|
10243
10583
|
},
|
|
10244
10584
|
{
|
|
10245
10585
|
properties: {
|
|
10246
|
-
user_identity_id: {
|
|
10586
|
+
user_identity_id: {
|
|
10587
|
+
description: "ID of the user identity for which you want to retrieve all credentials.",
|
|
10588
|
+
format: "uuid",
|
|
10589
|
+
type: "string"
|
|
10590
|
+
}
|
|
10247
10591
|
},
|
|
10248
10592
|
required: ["user_identity_id"],
|
|
10249
10593
|
type: "object"
|
|
@@ -10252,9 +10596,21 @@ var openapi_default = {
|
|
|
10252
10596
|
},
|
|
10253
10597
|
{
|
|
10254
10598
|
properties: {
|
|
10255
|
-
created_before: {
|
|
10256
|
-
|
|
10257
|
-
|
|
10599
|
+
created_before: {
|
|
10600
|
+
description: "Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.",
|
|
10601
|
+
format: "date-time",
|
|
10602
|
+
type: "string"
|
|
10603
|
+
},
|
|
10604
|
+
is_multi_phone_sync_credential: {
|
|
10605
|
+
description: "Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials.",
|
|
10606
|
+
type: "boolean"
|
|
10607
|
+
},
|
|
10608
|
+
limit: {
|
|
10609
|
+
default: 500,
|
|
10610
|
+
description: "Number of credentials to return.",
|
|
10611
|
+
format: "float",
|
|
10612
|
+
type: "number"
|
|
10613
|
+
}
|
|
10258
10614
|
},
|
|
10259
10615
|
type: "object"
|
|
10260
10616
|
}
|
|
@@ -10296,18 +10652,24 @@ var openapi_default = {
|
|
|
10296
10652
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10297
10653
|
"x-fern-sdk-method-name": "list",
|
|
10298
10654
|
"x-fern-sdk-return-value": "acs_credentials",
|
|
10299
|
-
"x-response-key": "acs_credentials"
|
|
10655
|
+
"x-response-key": "acs_credentials",
|
|
10656
|
+
"x-title": "List Credentials"
|
|
10300
10657
|
}
|
|
10301
10658
|
},
|
|
10302
10659
|
"/acs/credentials/list_accessible_entrances": {
|
|
10303
10660
|
post: {
|
|
10661
|
+
description: "Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.",
|
|
10304
10662
|
operationId: "acsCredentialsListAccessibleEntrancesPost",
|
|
10305
10663
|
requestBody: {
|
|
10306
10664
|
content: {
|
|
10307
10665
|
"application/json": {
|
|
10308
10666
|
schema: {
|
|
10309
10667
|
properties: {
|
|
10310
|
-
acs_credential_id: {
|
|
10668
|
+
acs_credential_id: {
|
|
10669
|
+
description: "ID of the credential for which you want to retrieve all entrances to which this credential grants access.",
|
|
10670
|
+
format: "uuid",
|
|
10671
|
+
type: "string"
|
|
10672
|
+
}
|
|
10311
10673
|
},
|
|
10312
10674
|
required: ["acs_credential_id"],
|
|
10313
10675
|
type: "object"
|
|
@@ -10347,19 +10709,29 @@ var openapi_default = {
|
|
|
10347
10709
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10348
10710
|
"x-fern-sdk-method-name": "list_accessible_entrances",
|
|
10349
10711
|
"x-fern-sdk-return-value": "acs_entrances",
|
|
10350
|
-
"x-response-key": "acs_entrances"
|
|
10712
|
+
"x-response-key": "acs_entrances",
|
|
10713
|
+
"x-title": "List Accessible Entrances"
|
|
10351
10714
|
}
|
|
10352
10715
|
},
|
|
10353
10716
|
"/acs/credentials/unassign": {
|
|
10354
10717
|
patch: {
|
|
10718
|
+
description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10355
10719
|
operationId: "acsCredentialsUnassignPatch",
|
|
10356
10720
|
requestBody: {
|
|
10357
10721
|
content: {
|
|
10358
10722
|
"application/json": {
|
|
10359
10723
|
schema: {
|
|
10360
10724
|
properties: {
|
|
10361
|
-
acs_credential_id: {
|
|
10362
|
-
|
|
10725
|
+
acs_credential_id: {
|
|
10726
|
+
description: "ID of the desired credential.",
|
|
10727
|
+
format: "uuid",
|
|
10728
|
+
type: "string"
|
|
10729
|
+
},
|
|
10730
|
+
acs_user_id: {
|
|
10731
|
+
description: "ID of the desired user.",
|
|
10732
|
+
format: "uuid",
|
|
10733
|
+
type: "string"
|
|
10734
|
+
}
|
|
10363
10735
|
},
|
|
10364
10736
|
required: ["acs_user_id", "acs_credential_id"],
|
|
10365
10737
|
type: "object"
|
|
@@ -10396,17 +10768,27 @@ var openapi_default = {
|
|
|
10396
10768
|
summary: "/acs/credentials/unassign",
|
|
10397
10769
|
tags: ["/acs"],
|
|
10398
10770
|
"x-fern-ignore": true,
|
|
10399
|
-
"x-response-key": null
|
|
10771
|
+
"x-response-key": null,
|
|
10772
|
+
"x-title": "Unassign a Credential from an ACS User"
|
|
10400
10773
|
},
|
|
10401
10774
|
post: {
|
|
10775
|
+
description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
10402
10776
|
operationId: "acsCredentialsUnassignPost",
|
|
10403
10777
|
requestBody: {
|
|
10404
10778
|
content: {
|
|
10405
10779
|
"application/json": {
|
|
10406
10780
|
schema: {
|
|
10407
10781
|
properties: {
|
|
10408
|
-
acs_credential_id: {
|
|
10409
|
-
|
|
10782
|
+
acs_credential_id: {
|
|
10783
|
+
description: "ID of the desired credential.",
|
|
10784
|
+
format: "uuid",
|
|
10785
|
+
type: "string"
|
|
10786
|
+
},
|
|
10787
|
+
acs_user_id: {
|
|
10788
|
+
description: "ID of the desired user.",
|
|
10789
|
+
format: "uuid",
|
|
10790
|
+
type: "string"
|
|
10791
|
+
}
|
|
10410
10792
|
},
|
|
10411
10793
|
required: ["acs_user_id", "acs_credential_id"],
|
|
10412
10794
|
type: "object"
|
|
@@ -10444,18 +10826,24 @@ var openapi_default = {
|
|
|
10444
10826
|
tags: ["/acs"],
|
|
10445
10827
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10446
10828
|
"x-fern-sdk-method-name": "unassign",
|
|
10447
|
-
"x-response-key": null
|
|
10829
|
+
"x-response-key": null,
|
|
10830
|
+
"x-title": "Unassign a Credential from an ACS User"
|
|
10448
10831
|
}
|
|
10449
10832
|
},
|
|
10450
10833
|
"/acs/credentials/unmanaged/get": {
|
|
10451
10834
|
post: {
|
|
10835
|
+
description: "Returns a specified unmanaged [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10452
10836
|
operationId: "acsCredentialsUnmanagedGetPost",
|
|
10453
10837
|
requestBody: {
|
|
10454
10838
|
content: {
|
|
10455
10839
|
"application/json": {
|
|
10456
10840
|
schema: {
|
|
10457
10841
|
properties: {
|
|
10458
|
-
acs_credential_id: {
|
|
10842
|
+
acs_credential_id: {
|
|
10843
|
+
description: "ID of the desired unmanaged credential.",
|
|
10844
|
+
format: "uuid",
|
|
10845
|
+
type: "string"
|
|
10846
|
+
}
|
|
10459
10847
|
},
|
|
10460
10848
|
required: ["acs_credential_id"],
|
|
10461
10849
|
type: "object"
|
|
@@ -10470,23 +10858,52 @@ var openapi_default = {
|
|
|
10470
10858
|
schema: {
|
|
10471
10859
|
properties: {
|
|
10472
10860
|
acs_credential: {
|
|
10861
|
+
description: "Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
10473
10862
|
properties: {
|
|
10474
10863
|
access_method: {
|
|
10864
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
10475
10865
|
enum: ["code", "card", "mobile_key"],
|
|
10476
10866
|
type: "string"
|
|
10477
10867
|
},
|
|
10478
|
-
acs_credential_id: {
|
|
10868
|
+
acs_credential_id: {
|
|
10869
|
+
description: "ID of the credential.",
|
|
10870
|
+
format: "uuid",
|
|
10871
|
+
type: "string"
|
|
10872
|
+
},
|
|
10479
10873
|
acs_credential_pool_id: {
|
|
10480
10874
|
format: "uuid",
|
|
10481
10875
|
type: "string"
|
|
10482
10876
|
},
|
|
10483
|
-
acs_system_id: {
|
|
10484
|
-
|
|
10877
|
+
acs_system_id: {
|
|
10878
|
+
description: "ID of the access control system that contains the credential.",
|
|
10879
|
+
format: "uuid",
|
|
10880
|
+
type: "string"
|
|
10881
|
+
},
|
|
10882
|
+
acs_user_id: {
|
|
10883
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
10884
|
+
format: "uuid",
|
|
10885
|
+
type: "string"
|
|
10886
|
+
},
|
|
10485
10887
|
card_number: { nullable: true, type: "string" },
|
|
10486
|
-
code: {
|
|
10487
|
-
|
|
10488
|
-
|
|
10489
|
-
|
|
10888
|
+
code: {
|
|
10889
|
+
description: "Access (PIN) code for the credential.",
|
|
10890
|
+
nullable: true,
|
|
10891
|
+
type: "string"
|
|
10892
|
+
},
|
|
10893
|
+
created_at: {
|
|
10894
|
+
description: "Date and time at which the credential was created.",
|
|
10895
|
+
format: "date-time",
|
|
10896
|
+
type: "string"
|
|
10897
|
+
},
|
|
10898
|
+
display_name: {
|
|
10899
|
+
description: "Display name that corresponds to the credential type.",
|
|
10900
|
+
minLength: 1,
|
|
10901
|
+
type: "string"
|
|
10902
|
+
},
|
|
10903
|
+
ends_at: {
|
|
10904
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
10905
|
+
type: "string"
|
|
10906
|
+
},
|
|
10490
10907
|
errors: {
|
|
10491
10908
|
items: {
|
|
10492
10909
|
properties: {
|
|
@@ -10499,6 +10916,7 @@ var openapi_default = {
|
|
|
10499
10916
|
type: "array"
|
|
10500
10917
|
},
|
|
10501
10918
|
external_type: {
|
|
10919
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
10502
10920
|
enum: [
|
|
10503
10921
|
"pti_card",
|
|
10504
10922
|
"brivo_credential",
|
|
@@ -10508,28 +10926,41 @@ var openapi_default = {
|
|
|
10508
10926
|
],
|
|
10509
10927
|
type: "string"
|
|
10510
10928
|
},
|
|
10511
|
-
external_type_display_name: {
|
|
10929
|
+
external_type_display_name: {
|
|
10930
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
10931
|
+
type: "string"
|
|
10932
|
+
},
|
|
10512
10933
|
is_issued: { type: "boolean" },
|
|
10513
10934
|
is_latest_desired_state_synced_with_provider: {
|
|
10935
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
10514
10936
|
type: "boolean"
|
|
10515
10937
|
},
|
|
10516
10938
|
is_managed: { enum: [false], type: "boolean" },
|
|
10517
|
-
is_multi_phone_sync_credential: {
|
|
10939
|
+
is_multi_phone_sync_credential: {
|
|
10940
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
10941
|
+
type: "boolean"
|
|
10942
|
+
},
|
|
10518
10943
|
issued_at: {
|
|
10519
10944
|
format: "date-time",
|
|
10520
10945
|
nullable: true,
|
|
10521
10946
|
type: "string"
|
|
10522
10947
|
},
|
|
10523
10948
|
latest_desired_state_synced_with_provider_at: {
|
|
10949
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
10524
10950
|
format: "date-time",
|
|
10525
10951
|
type: "string"
|
|
10526
10952
|
},
|
|
10527
10953
|
parent_acs_credential_id: {
|
|
10954
|
+
description: "ID of the parent credential.",
|
|
10528
10955
|
format: "uuid",
|
|
10529
10956
|
type: "string"
|
|
10530
10957
|
},
|
|
10531
|
-
starts_at: {
|
|
10958
|
+
starts_at: {
|
|
10959
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
10960
|
+
type: "string"
|
|
10961
|
+
},
|
|
10532
10962
|
visionline_metadata: {
|
|
10963
|
+
description: "Visionline-specific metadata for the credential.",
|
|
10533
10964
|
properties: {
|
|
10534
10965
|
auto_join: { type: "boolean" },
|
|
10535
10966
|
card_function_type: {
|
|
@@ -10566,7 +10997,11 @@ var openapi_default = {
|
|
|
10566
10997
|
},
|
|
10567
10998
|
type: "array"
|
|
10568
10999
|
},
|
|
10569
|
-
workspace_id: {
|
|
11000
|
+
workspace_id: {
|
|
11001
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
11002
|
+
format: "uuid",
|
|
11003
|
+
type: "string"
|
|
11004
|
+
}
|
|
10570
11005
|
},
|
|
10571
11006
|
required: [
|
|
10572
11007
|
"acs_credential_id",
|
|
@@ -10603,11 +11038,13 @@ var openapi_default = {
|
|
|
10603
11038
|
"x-fern-sdk-group-name": ["acs", "credentials", "unmanaged"],
|
|
10604
11039
|
"x-fern-sdk-method-name": "get",
|
|
10605
11040
|
"x-fern-sdk-return-value": "acs_credential",
|
|
10606
|
-
"x-response-key": "acs_credential"
|
|
11041
|
+
"x-response-key": "acs_credential",
|
|
11042
|
+
"x-title": "Get an Unmanaged Credential"
|
|
10607
11043
|
}
|
|
10608
11044
|
},
|
|
10609
11045
|
"/acs/credentials/unmanaged/list": {
|
|
10610
11046
|
post: {
|
|
11047
|
+
description: "Returns a list of all unmanaged [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10611
11048
|
operationId: "acsCredentialsUnmanagedListPost",
|
|
10612
11049
|
requestBody: {
|
|
10613
11050
|
content: {
|
|
@@ -10616,29 +11053,49 @@ var openapi_default = {
|
|
|
10616
11053
|
oneOf: [
|
|
10617
11054
|
{
|
|
10618
11055
|
properties: {
|
|
10619
|
-
acs_user_id: {
|
|
11056
|
+
acs_user_id: {
|
|
11057
|
+
description: "ID of the ACS user for which you want to retrieve all credentials.",
|
|
11058
|
+
format: "uuid",
|
|
11059
|
+
type: "string"
|
|
11060
|
+
}
|
|
10620
11061
|
},
|
|
10621
11062
|
required: ["acs_user_id"],
|
|
10622
11063
|
type: "object"
|
|
10623
11064
|
},
|
|
10624
11065
|
{
|
|
10625
11066
|
properties: {
|
|
10626
|
-
acs_system_id: {
|
|
11067
|
+
acs_system_id: {
|
|
11068
|
+
description: "ID of the access control system for which you want to retrieve all credentials.",
|
|
11069
|
+
format: "uuid",
|
|
11070
|
+
type: "string"
|
|
11071
|
+
}
|
|
10627
11072
|
},
|
|
10628
11073
|
required: ["acs_system_id"],
|
|
10629
11074
|
type: "object"
|
|
10630
11075
|
},
|
|
10631
11076
|
{
|
|
10632
11077
|
properties: {
|
|
10633
|
-
acs_system_id: {
|
|
10634
|
-
|
|
11078
|
+
acs_system_id: {
|
|
11079
|
+
description: "ID of the access control system for which you want to retrieve all credentials.",
|
|
11080
|
+
format: "uuid",
|
|
11081
|
+
type: "string"
|
|
11082
|
+
},
|
|
11083
|
+
acs_user_id: {
|
|
11084
|
+
description: "ID of the ACS user for which you want to retrieve all credentials.",
|
|
11085
|
+
format: "uuid",
|
|
11086
|
+
type: "string"
|
|
11087
|
+
}
|
|
10635
11088
|
},
|
|
10636
11089
|
required: ["acs_user_id", "acs_system_id"],
|
|
10637
11090
|
type: "object"
|
|
10638
11091
|
},
|
|
10639
11092
|
{
|
|
10640
11093
|
properties: {
|
|
10641
|
-
user_identity_id: {
|
|
11094
|
+
user_identity_id: {
|
|
11095
|
+
description: "ID of the user identity for which you want to retrieve all credentials.",
|
|
11096
|
+
format: "uuid",
|
|
11097
|
+
type: "string"
|
|
11098
|
+
}
|
|
10642
11099
|
},
|
|
10643
11100
|
required: ["user_identity_id"],
|
|
10644
11101
|
type: "object"
|
|
@@ -10656,23 +11113,52 @@ var openapi_default = {
|
|
|
10656
11113
|
properties: {
|
|
10657
11114
|
acs_credentials: {
|
|
10658
11115
|
items: {
|
|
11116
|
+
description: "Means by which a user gains access at an entrance.\n\n The `unmanaged_acs_credential` object, which is not managed by Seam, represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.",
|
|
10659
11117
|
properties: {
|
|
10660
11118
|
access_method: {
|
|
11119
|
+
description: "Access method for the credential. Supported values: `code`, `card`, `mobile_key`.",
|
|
10661
11120
|
enum: ["code", "card", "mobile_key"],
|
|
10662
11121
|
type: "string"
|
|
10663
11122
|
},
|
|
10664
|
-
acs_credential_id: {
|
|
11123
|
+
acs_credential_id: {
|
|
11124
|
+
description: "ID of the credential.",
|
|
11125
|
+
format: "uuid",
|
|
11126
|
+
type: "string"
|
|
11127
|
+
},
|
|
10665
11128
|
acs_credential_pool_id: {
|
|
10666
11129
|
format: "uuid",
|
|
10667
11130
|
type: "string"
|
|
10668
11131
|
},
|
|
10669
|
-
acs_system_id: {
|
|
10670
|
-
|
|
11132
|
+
acs_system_id: {
|
|
11133
|
+
description: "ID of the access control system that contains the credential.",
|
|
11134
|
+
format: "uuid",
|
|
11135
|
+
type: "string"
|
|
11136
|
+
},
|
|
11137
|
+
acs_user_id: {
|
|
11138
|
+
description: "ID of the ACS user to whom the credential belongs.",
|
|
11139
|
+
format: "uuid",
|
|
11140
|
+
type: "string"
|
|
11141
|
+
},
|
|
10671
11142
|
card_number: { nullable: true, type: "string" },
|
|
10672
|
-
code: {
|
|
10673
|
-
|
|
10674
|
-
|
|
10675
|
-
|
|
11143
|
+
code: {
|
|
11144
|
+
description: "Access (PIN) code for the credential.",
|
|
11145
|
+
nullable: true,
|
|
11146
|
+
type: "string"
|
|
11147
|
+
},
|
|
11148
|
+
created_at: {
|
|
11149
|
+
description: "Date and time at which the credential was created.",
|
|
11150
|
+
format: "date-time",
|
|
11151
|
+
type: "string"
|
|
11152
|
+
},
|
|
11153
|
+
display_name: {
|
|
11154
|
+
description: "Display name that corresponds to the credential type.",
|
|
11155
|
+
minLength: 1,
|
|
11156
|
+
type: "string"
|
|
11157
|
+
},
|
|
11158
|
+
ends_at: {
|
|
11159
|
+
description: "Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.",
|
|
11160
|
+
type: "string"
|
|
11161
|
+
},
|
|
10676
11162
|
errors: {
|
|
10677
11163
|
items: {
|
|
10678
11164
|
properties: {
|
|
@@ -10685,6 +11171,7 @@ var openapi_default = {
|
|
|
10685
11171
|
type: "array"
|
|
10686
11172
|
},
|
|
10687
11173
|
external_type: {
|
|
11174
|
+
description: "Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
|
|
10688
11175
|
enum: [
|
|
10689
11176
|
"pti_card",
|
|
10690
11177
|
"brivo_credential",
|
|
@@ -10694,28 +11181,41 @@ var openapi_default = {
|
|
|
10694
11181
|
],
|
|
10695
11182
|
type: "string"
|
|
10696
11183
|
},
|
|
10697
|
-
external_type_display_name: {
|
|
11184
|
+
external_type_display_name: {
|
|
11185
|
+
description: "Display name that corresponds to the brand-specific terminology for the credential type.",
|
|
11186
|
+
type: "string"
|
|
11187
|
+
},
|
|
10698
11188
|
is_issued: { type: "boolean" },
|
|
10699
11189
|
is_latest_desired_state_synced_with_provider: {
|
|
11190
|
+
description: "Indicates whether the latest state of the credential has been synced from Seam to the provider.",
|
|
10700
11191
|
type: "boolean"
|
|
10701
11192
|
},
|
|
10702
11193
|
is_managed: { enum: [false], type: "boolean" },
|
|
10703
|
-
is_multi_phone_sync_credential: {
|
|
11194
|
+
is_multi_phone_sync_credential: {
|
|
11195
|
+
description: "Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).",
|
|
11196
|
+
type: "boolean"
|
|
11197
|
+
},
|
|
10704
11198
|
issued_at: {
|
|
10705
11199
|
format: "date-time",
|
|
10706
11200
|
nullable: true,
|
|
10707
11201
|
type: "string"
|
|
10708
11202
|
},
|
|
10709
11203
|
latest_desired_state_synced_with_provider_at: {
|
|
11204
|
+
description: "Date and time at which the state of the credential was most recently synced from Seam to the provider.",
|
|
10710
11205
|
format: "date-time",
|
|
10711
11206
|
type: "string"
|
|
10712
11207
|
},
|
|
10713
11208
|
parent_acs_credential_id: {
|
|
11209
|
+
description: "ID of the parent credential.",
|
|
10714
11210
|
format: "uuid",
|
|
10715
11211
|
type: "string"
|
|
10716
11212
|
},
|
|
10717
|
-
starts_at: {
|
|
11213
|
+
starts_at: {
|
|
11214
|
+
description: "Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
11215
|
+
type: "string"
|
|
11216
|
+
},
|
|
10718
11217
|
visionline_metadata: {
|
|
11218
|
+
description: "Visionline-specific metadata for the credential.",
|
|
10719
11219
|
properties: {
|
|
10720
11220
|
auto_join: { type: "boolean" },
|
|
10721
11221
|
card_function_type: {
|
|
@@ -10752,7 +11252,11 @@ var openapi_default = {
|
|
|
10752
11252
|
},
|
|
10753
11253
|
type: "array"
|
|
10754
11254
|
},
|
|
10755
|
-
workspace_id: {
|
|
11255
|
+
workspace_id: {
|
|
11256
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential.",
|
|
11257
|
+
format: "uuid",
|
|
11258
|
+
type: "string"
|
|
11259
|
+
}
|
|
10756
11260
|
},
|
|
10757
11261
|
required: [
|
|
10758
11262
|
"acs_credential_id",
|
|
@@ -10791,20 +11295,33 @@ var openapi_default = {
|
|
|
10791
11295
|
"x-fern-sdk-group-name": ["acs", "credentials", "unmanaged"],
|
|
10792
11296
|
"x-fern-sdk-method-name": "list",
|
|
10793
11297
|
"x-fern-sdk-return-value": "acs_credentials",
|
|
10794
|
-
"x-response-key": "acs_credentials"
|
|
11298
|
+
"x-response-key": "acs_credentials",
|
|
11299
|
+
"x-title": "List Unmanaged Credentials"
|
|
10795
11300
|
}
|
|
10796
11301
|
},
|
|
10797
11302
|
"/acs/credentials/update": {
|
|
10798
11303
|
patch: {
|
|
11304
|
+
description: "Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10799
11305
|
operationId: "acsCredentialsUpdatePatch",
|
|
10800
11306
|
requestBody: {
|
|
10801
11307
|
content: {
|
|
10802
11308
|
"application/json": {
|
|
10803
11309
|
schema: {
|
|
10804
11310
|
properties: {
|
|
10805
|
-
acs_credential_id: {
|
|
10806
|
-
|
|
10807
|
-
|
|
11311
|
+
acs_credential_id: {
|
|
11312
|
+
description: "ID of the desired credential.",
|
|
11313
|
+
type: "string"
|
|
11314
|
+
},
|
|
11315
|
+
code: {
|
|
11316
|
+
description: "Replacement access (PIN) code for the credential.",
|
|
11317
|
+
pattern: "^\\d+$",
|
|
11318
|
+
type: "string"
|
|
11319
|
+
},
|
|
11320
|
+
ends_at: {
|
|
11321
|
+
description: "Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.",
|
|
11322
|
+
format: "date-time",
|
|
11323
|
+
type: "string"
|
|
11324
|
+
}
|
|
10808
11325
|
},
|
|
10809
11326
|
required: ["acs_credential_id"],
|
|
10810
11327
|
type: "object"
|
|
@@ -10841,18 +11358,31 @@ var openapi_default = {
|
|
|
10841
11358
|
summary: "/acs/credentials/update",
|
|
10842
11359
|
tags: ["/acs"],
|
|
10843
11360
|
"x-fern-ignore": true,
|
|
10844
|
-
"x-response-key": null
|
|
11361
|
+
"x-response-key": null,
|
|
11362
|
+
"x-title": "Update a Credential"
|
|
10845
11363
|
},
|
|
10846
11364
|
post: {
|
|
11365
|
+
description: "Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
10847
11366
|
operationId: "acsCredentialsUpdatePost",
|
|
10848
11367
|
requestBody: {
|
|
10849
11368
|
content: {
|
|
10850
11369
|
"application/json": {
|
|
10851
11370
|
schema: {
|
|
10852
11371
|
properties: {
|
|
10853
|
-
acs_credential_id: {
|
|
10854
|
-
|
|
10855
|
-
|
|
11372
|
+
acs_credential_id: {
|
|
11373
|
+
description: "ID of the desired credential.",
|
|
11374
|
+
type: "string"
|
|
11375
|
+
},
|
|
11376
|
+
code: {
|
|
11377
|
+
description: "Replacement access (PIN) code for the credential.",
|
|
11378
|
+
pattern: "^\\d+$",
|
|
11379
|
+
type: "string"
|
|
11380
|
+
},
|
|
11381
|
+
ends_at: {
|
|
11382
|
+
description: "Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential.",
|
|
11383
|
+
format: "date-time",
|
|
11384
|
+
type: "string"
|
|
11385
|
+
}
|
|
10856
11386
|
},
|
|
10857
11387
|
required: ["acs_credential_id"],
|
|
10858
11388
|
type: "object"
|
|
@@ -10890,7 +11420,8 @@ var openapi_default = {
|
|
|
10890
11420
|
tags: ["/acs"],
|
|
10891
11421
|
"x-fern-sdk-group-name": ["acs", "credentials"],
|
|
10892
11422
|
"x-fern-sdk-method-name": "update",
|
|
10893
|
-
"x-response-key": null
|
|
11423
|
+
"x-response-key": null,
|
|
11424
|
+
"x-title": "Update a Credential"
|
|
10894
11425
|
}
|
|
10895
11426
|
},
|
|
10896
11427
|
"/acs/encoders/encode_card": {
|