@seamapi/types 1.584.0 → 1.585.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 +2789 -396
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2916 -336
- package/dist/index.cjs +2789 -396
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +99 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +13 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.d.ts +59 -0
- package/lib/seam/connect/models/access-grants/access-method.js +12 -0
- package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.d.ts +109 -0
- package/lib/seam/connect/models/user-identities/user-identity.js +10 -0
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +2583 -336
- package/lib/seam/connect/openapi.js +3484 -1123
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +333 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +3 -0
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +16 -0
- package/src/lib/seam/connect/models/access-grants/access-method.ts +15 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +13 -0
- package/src/lib/seam/connect/openapi.ts +3354 -729
- package/src/lib/seam/connect/route-types.ts +339 -0
package/dist/index.cjs
CHANGED
|
@@ -2381,6 +2381,18 @@ var access_grant = zod.z.object({
|
|
|
2381
2381
|
---
|
|
2382
2382
|
Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
|
|
2383
2383
|
`);
|
|
2384
|
+
access_grant.omit({
|
|
2385
|
+
client_session_token: true,
|
|
2386
|
+
instant_key_url: true,
|
|
2387
|
+
customization_profile_id: true,
|
|
2388
|
+
access_grant_key: true
|
|
2389
|
+
}).describe(`
|
|
2390
|
+
---
|
|
2391
|
+
draft: Early access.
|
|
2392
|
+
route_path: /access_grants/unmanaged
|
|
2393
|
+
---
|
|
2394
|
+
Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.
|
|
2395
|
+
`);
|
|
2384
2396
|
var common_access_method_warning = zod.z.object({
|
|
2385
2397
|
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the warning."),
|
|
2386
2398
|
message: zod.z.string().describe(
|
|
@@ -2428,6 +2440,17 @@ var access_method = zod.z.object({
|
|
|
2428
2440
|
---
|
|
2429
2441
|
Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
|
|
2430
2442
|
`);
|
|
2443
|
+
access_method.omit({
|
|
2444
|
+
instant_key_url: true,
|
|
2445
|
+
client_session_token: true,
|
|
2446
|
+
customization_profile_id: true
|
|
2447
|
+
}).describe(`
|
|
2448
|
+
---
|
|
2449
|
+
draft: Early access.
|
|
2450
|
+
route_path: /access_methods/unmanaged
|
|
2451
|
+
---
|
|
2452
|
+
Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.
|
|
2453
|
+
`);
|
|
2431
2454
|
var acs_access_group_external_type = zod.z.enum([
|
|
2432
2455
|
"pti_unit",
|
|
2433
2456
|
"pti_access_level",
|
|
@@ -5409,6 +5432,15 @@ var user_identity = zod.z.object({
|
|
|
5409
5432
|
---
|
|
5410
5433
|
Represents 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) associated with an application user account.
|
|
5411
5434
|
`);
|
|
5435
|
+
user_identity.omit({
|
|
5436
|
+
user_identity_key: true
|
|
5437
|
+
}).describe(`
|
|
5438
|
+
---
|
|
5439
|
+
draft: Early access.
|
|
5440
|
+
route_path: /user_identities/unmanaged
|
|
5441
|
+
---
|
|
5442
|
+
Represents an unmanaged user identity. Unmanaged user identities do not have keys.
|
|
5443
|
+
`);
|
|
5412
5444
|
var hex_color_code = zod.z.string().refine((value) => {
|
|
5413
5445
|
if (value != null) {
|
|
5414
5446
|
return /^#[\da-fa-z]{3,6}$/i.test(value);
|
|
@@ -31895,50 +31927,186 @@ var openapi_default = {
|
|
|
31895
31927
|
"x-title": "List Access Grants"
|
|
31896
31928
|
}
|
|
31897
31929
|
},
|
|
31898
|
-
"/access_grants/
|
|
31899
|
-
|
|
31900
|
-
description: "
|
|
31901
|
-
operationId: "
|
|
31902
|
-
|
|
31903
|
-
|
|
31904
|
-
"
|
|
31905
|
-
|
|
31906
|
-
|
|
31907
|
-
|
|
31908
|
-
|
|
31909
|
-
|
|
31910
|
-
|
|
31911
|
-
},
|
|
31912
|
-
ends_at: {
|
|
31913
|
-
description: "Date and time at which the validity of the grant 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`.",
|
|
31914
|
-
format: "date-time",
|
|
31915
|
-
nullable: true,
|
|
31916
|
-
type: "string"
|
|
31917
|
-
},
|
|
31918
|
-
name: {
|
|
31919
|
-
description: "Display name for the access grant.",
|
|
31920
|
-
nullable: true,
|
|
31921
|
-
type: "string"
|
|
31922
|
-
},
|
|
31923
|
-
starts_at: {
|
|
31924
|
-
description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
31925
|
-
format: "date-time",
|
|
31926
|
-
type: "string"
|
|
31927
|
-
}
|
|
31928
|
-
},
|
|
31929
|
-
required: ["access_grant_id"],
|
|
31930
|
-
type: "object"
|
|
31931
|
-
}
|
|
31930
|
+
"/access_grants/unmanaged/get": {
|
|
31931
|
+
get: {
|
|
31932
|
+
description: "Get an unmanaged Access Grant (where is_managed = false).",
|
|
31933
|
+
operationId: "accessGrantsUnmanagedGetGet",
|
|
31934
|
+
parameters: [
|
|
31935
|
+
{
|
|
31936
|
+
in: "query",
|
|
31937
|
+
name: "access_grant_id",
|
|
31938
|
+
required: true,
|
|
31939
|
+
schema: {
|
|
31940
|
+
description: "ID of unmanaged Access Grant to get.",
|
|
31941
|
+
format: "uuid",
|
|
31942
|
+
type: "string"
|
|
31932
31943
|
}
|
|
31933
31944
|
}
|
|
31934
|
-
|
|
31945
|
+
],
|
|
31935
31946
|
responses: {
|
|
31936
31947
|
200: {
|
|
31937
31948
|
content: {
|
|
31938
31949
|
"application/json": {
|
|
31939
31950
|
schema: {
|
|
31940
|
-
properties: {
|
|
31941
|
-
|
|
31951
|
+
properties: {
|
|
31952
|
+
access_grant: {
|
|
31953
|
+
description: "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.",
|
|
31954
|
+
properties: {
|
|
31955
|
+
access_grant_id: {
|
|
31956
|
+
description: "ID of the Access Grant.",
|
|
31957
|
+
format: "uuid",
|
|
31958
|
+
type: "string"
|
|
31959
|
+
},
|
|
31960
|
+
access_method_ids: {
|
|
31961
|
+
description: "IDs of the access methods created for the Access Grant.",
|
|
31962
|
+
items: { format: "uuid", type: "string" },
|
|
31963
|
+
type: "array"
|
|
31964
|
+
},
|
|
31965
|
+
created_at: {
|
|
31966
|
+
description: "Date and time at which the Access Grant was created.",
|
|
31967
|
+
format: "date-time",
|
|
31968
|
+
type: "string"
|
|
31969
|
+
},
|
|
31970
|
+
display_name: {
|
|
31971
|
+
description: "Display name of the Access Grant.",
|
|
31972
|
+
type: "string"
|
|
31973
|
+
},
|
|
31974
|
+
ends_at: {
|
|
31975
|
+
description: "Date and time at which the Access Grant ends.",
|
|
31976
|
+
format: "date-time",
|
|
31977
|
+
nullable: true,
|
|
31978
|
+
type: "string"
|
|
31979
|
+
},
|
|
31980
|
+
location_ids: {
|
|
31981
|
+
deprecated: true,
|
|
31982
|
+
items: { format: "uuid", type: "string" },
|
|
31983
|
+
type: "array",
|
|
31984
|
+
"x-deprecated": "Use `space_ids`."
|
|
31985
|
+
},
|
|
31986
|
+
name: {
|
|
31987
|
+
description: "Name of the Access Grant. If not provided, the display name will be computed.",
|
|
31988
|
+
nullable: true,
|
|
31989
|
+
type: "string"
|
|
31990
|
+
},
|
|
31991
|
+
requested_access_methods: {
|
|
31992
|
+
description: "Access methods that the user requested for the Access Grant.",
|
|
31993
|
+
items: {
|
|
31994
|
+
properties: {
|
|
31995
|
+
code: {
|
|
31996
|
+
description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
31997
|
+
maxLength: 9,
|
|
31998
|
+
minLength: 4,
|
|
31999
|
+
pattern: "^\\d+$",
|
|
32000
|
+
type: "string"
|
|
32001
|
+
},
|
|
32002
|
+
created_access_method_ids: {
|
|
32003
|
+
description: "IDs of the access methods created for the requested access method.",
|
|
32004
|
+
items: { format: "uuid", type: "string" },
|
|
32005
|
+
type: "array"
|
|
32006
|
+
},
|
|
32007
|
+
created_at: {
|
|
32008
|
+
description: "Date and time at which the requested access method was added to the Access Grant.",
|
|
32009
|
+
format: "date-time",
|
|
32010
|
+
type: "string"
|
|
32011
|
+
},
|
|
32012
|
+
display_name: {
|
|
32013
|
+
description: "Display name of the access method.",
|
|
32014
|
+
type: "string"
|
|
32015
|
+
},
|
|
32016
|
+
mode: {
|
|
32017
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32018
|
+
enum: ["code", "card", "mobile_key"],
|
|
32019
|
+
type: "string"
|
|
32020
|
+
}
|
|
32021
|
+
},
|
|
32022
|
+
required: [
|
|
32023
|
+
"display_name",
|
|
32024
|
+
"mode",
|
|
32025
|
+
"created_at",
|
|
32026
|
+
"created_access_method_ids"
|
|
32027
|
+
],
|
|
32028
|
+
type: "object"
|
|
32029
|
+
},
|
|
32030
|
+
type: "array"
|
|
32031
|
+
},
|
|
32032
|
+
space_ids: {
|
|
32033
|
+
description: "IDs of the spaces to which the Access Grant gives access.",
|
|
32034
|
+
items: { format: "uuid", type: "string" },
|
|
32035
|
+
type: "array"
|
|
32036
|
+
},
|
|
32037
|
+
starts_at: {
|
|
32038
|
+
description: "Date and time at which the Access Grant starts.",
|
|
32039
|
+
format: "date-time",
|
|
32040
|
+
type: "string"
|
|
32041
|
+
},
|
|
32042
|
+
user_identity_id: {
|
|
32043
|
+
description: "ID of user identity to which the Access Grant gives access.",
|
|
32044
|
+
format: "uuid",
|
|
32045
|
+
type: "string"
|
|
32046
|
+
},
|
|
32047
|
+
warnings: {
|
|
32048
|
+
description: "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32049
|
+
items: {
|
|
32050
|
+
description: "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32051
|
+
discriminator: { propertyName: "warning_code" },
|
|
32052
|
+
oneOf: [
|
|
32053
|
+
{
|
|
32054
|
+
description: "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.",
|
|
32055
|
+
properties: {
|
|
32056
|
+
created_at: {
|
|
32057
|
+
description: "Date and time at which Seam created the warning.",
|
|
32058
|
+
format: "date-time",
|
|
32059
|
+
type: "string"
|
|
32060
|
+
},
|
|
32061
|
+
message: {
|
|
32062
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
32063
|
+
type: "string"
|
|
32064
|
+
},
|
|
32065
|
+
warning_code: {
|
|
32066
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
32067
|
+
enum: ["being_deleted"],
|
|
32068
|
+
type: "string"
|
|
32069
|
+
}
|
|
32070
|
+
},
|
|
32071
|
+
required: [
|
|
32072
|
+
"created_at",
|
|
32073
|
+
"message",
|
|
32074
|
+
"warning_code"
|
|
32075
|
+
],
|
|
32076
|
+
type: "object"
|
|
32077
|
+
}
|
|
32078
|
+
]
|
|
32079
|
+
},
|
|
32080
|
+
type: "array"
|
|
32081
|
+
},
|
|
32082
|
+
workspace_id: {
|
|
32083
|
+
description: "ID of the Seam workspace associated with the Access Grant.",
|
|
32084
|
+
format: "uuid",
|
|
32085
|
+
type: "string"
|
|
32086
|
+
}
|
|
32087
|
+
},
|
|
32088
|
+
required: [
|
|
32089
|
+
"workspace_id",
|
|
32090
|
+
"access_grant_id",
|
|
32091
|
+
"user_identity_id",
|
|
32092
|
+
"location_ids",
|
|
32093
|
+
"space_ids",
|
|
32094
|
+
"requested_access_methods",
|
|
32095
|
+
"access_method_ids",
|
|
32096
|
+
"name",
|
|
32097
|
+
"display_name",
|
|
32098
|
+
"created_at",
|
|
32099
|
+
"starts_at",
|
|
32100
|
+
"ends_at",
|
|
32101
|
+
"warnings"
|
|
32102
|
+
],
|
|
32103
|
+
type: "object",
|
|
32104
|
+
"x-draft": "Early access.",
|
|
32105
|
+
"x-route-path": "/access_grants/unmanaged"
|
|
32106
|
+
},
|
|
32107
|
+
ok: { type: "boolean" }
|
|
32108
|
+
},
|
|
32109
|
+
required: ["access_grant", "ok"],
|
|
31942
32110
|
type: "object"
|
|
31943
32111
|
}
|
|
31944
32112
|
}
|
|
@@ -31954,42 +32122,27 @@ var openapi_default = {
|
|
|
31954
32122
|
{ api_key: [] },
|
|
31955
32123
|
{ client_session_with_customer: [] }
|
|
31956
32124
|
],
|
|
31957
|
-
summary: "/access_grants/
|
|
32125
|
+
summary: "/access_grants/unmanaged/get",
|
|
31958
32126
|
tags: [],
|
|
31959
32127
|
"x-draft": "Early access.",
|
|
31960
|
-
"x-fern-sdk-group-name": ["access_grants"],
|
|
31961
|
-
"x-fern-sdk-method-name": "
|
|
31962
|
-
"x-
|
|
31963
|
-
"x-
|
|
32128
|
+
"x-fern-sdk-group-name": ["access_grants", "unmanaged"],
|
|
32129
|
+
"x-fern-sdk-method-name": "get",
|
|
32130
|
+
"x-fern-sdk-return-value": "access_grant",
|
|
32131
|
+
"x-response-key": "access_grant",
|
|
32132
|
+
"x-title": "Get an Unmanaged Access Grant"
|
|
31964
32133
|
},
|
|
31965
32134
|
post: {
|
|
31966
|
-
description: "
|
|
31967
|
-
operationId: "
|
|
32135
|
+
description: "Get an unmanaged Access Grant (where is_managed = false).",
|
|
32136
|
+
operationId: "accessGrantsUnmanagedGetPost",
|
|
31968
32137
|
requestBody: {
|
|
31969
32138
|
content: {
|
|
31970
32139
|
"application/json": {
|
|
31971
32140
|
schema: {
|
|
31972
32141
|
properties: {
|
|
31973
32142
|
access_grant_id: {
|
|
31974
|
-
description: "ID of
|
|
32143
|
+
description: "ID of unmanaged Access Grant to get.",
|
|
31975
32144
|
format: "uuid",
|
|
31976
32145
|
type: "string"
|
|
31977
|
-
},
|
|
31978
|
-
ends_at: {
|
|
31979
|
-
description: "Date and time at which the validity of the grant 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`.",
|
|
31980
|
-
format: "date-time",
|
|
31981
|
-
nullable: true,
|
|
31982
|
-
type: "string"
|
|
31983
|
-
},
|
|
31984
|
-
name: {
|
|
31985
|
-
description: "Display name for the access grant.",
|
|
31986
|
-
nullable: true,
|
|
31987
|
-
type: "string"
|
|
31988
|
-
},
|
|
31989
|
-
starts_at: {
|
|
31990
|
-
description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
31991
|
-
format: "date-time",
|
|
31992
|
-
type: "string"
|
|
31993
32146
|
}
|
|
31994
32147
|
},
|
|
31995
32148
|
required: ["access_grant_id"],
|
|
@@ -32003,8 +32156,165 @@ var openapi_default = {
|
|
|
32003
32156
|
content: {
|
|
32004
32157
|
"application/json": {
|
|
32005
32158
|
schema: {
|
|
32006
|
-
properties: {
|
|
32007
|
-
|
|
32159
|
+
properties: {
|
|
32160
|
+
access_grant: {
|
|
32161
|
+
description: "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.",
|
|
32162
|
+
properties: {
|
|
32163
|
+
access_grant_id: {
|
|
32164
|
+
description: "ID of the Access Grant.",
|
|
32165
|
+
format: "uuid",
|
|
32166
|
+
type: "string"
|
|
32167
|
+
},
|
|
32168
|
+
access_method_ids: {
|
|
32169
|
+
description: "IDs of the access methods created for the Access Grant.",
|
|
32170
|
+
items: { format: "uuid", type: "string" },
|
|
32171
|
+
type: "array"
|
|
32172
|
+
},
|
|
32173
|
+
created_at: {
|
|
32174
|
+
description: "Date and time at which the Access Grant was created.",
|
|
32175
|
+
format: "date-time",
|
|
32176
|
+
type: "string"
|
|
32177
|
+
},
|
|
32178
|
+
display_name: {
|
|
32179
|
+
description: "Display name of the Access Grant.",
|
|
32180
|
+
type: "string"
|
|
32181
|
+
},
|
|
32182
|
+
ends_at: {
|
|
32183
|
+
description: "Date and time at which the Access Grant ends.",
|
|
32184
|
+
format: "date-time",
|
|
32185
|
+
nullable: true,
|
|
32186
|
+
type: "string"
|
|
32187
|
+
},
|
|
32188
|
+
location_ids: {
|
|
32189
|
+
deprecated: true,
|
|
32190
|
+
items: { format: "uuid", type: "string" },
|
|
32191
|
+
type: "array",
|
|
32192
|
+
"x-deprecated": "Use `space_ids`."
|
|
32193
|
+
},
|
|
32194
|
+
name: {
|
|
32195
|
+
description: "Name of the Access Grant. If not provided, the display name will be computed.",
|
|
32196
|
+
nullable: true,
|
|
32197
|
+
type: "string"
|
|
32198
|
+
},
|
|
32199
|
+
requested_access_methods: {
|
|
32200
|
+
description: "Access methods that the user requested for the Access Grant.",
|
|
32201
|
+
items: {
|
|
32202
|
+
properties: {
|
|
32203
|
+
code: {
|
|
32204
|
+
description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
32205
|
+
maxLength: 9,
|
|
32206
|
+
minLength: 4,
|
|
32207
|
+
pattern: "^\\d+$",
|
|
32208
|
+
type: "string"
|
|
32209
|
+
},
|
|
32210
|
+
created_access_method_ids: {
|
|
32211
|
+
description: "IDs of the access methods created for the requested access method.",
|
|
32212
|
+
items: { format: "uuid", type: "string" },
|
|
32213
|
+
type: "array"
|
|
32214
|
+
},
|
|
32215
|
+
created_at: {
|
|
32216
|
+
description: "Date and time at which the requested access method was added to the Access Grant.",
|
|
32217
|
+
format: "date-time",
|
|
32218
|
+
type: "string"
|
|
32219
|
+
},
|
|
32220
|
+
display_name: {
|
|
32221
|
+
description: "Display name of the access method.",
|
|
32222
|
+
type: "string"
|
|
32223
|
+
},
|
|
32224
|
+
mode: {
|
|
32225
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32226
|
+
enum: ["code", "card", "mobile_key"],
|
|
32227
|
+
type: "string"
|
|
32228
|
+
}
|
|
32229
|
+
},
|
|
32230
|
+
required: [
|
|
32231
|
+
"display_name",
|
|
32232
|
+
"mode",
|
|
32233
|
+
"created_at",
|
|
32234
|
+
"created_access_method_ids"
|
|
32235
|
+
],
|
|
32236
|
+
type: "object"
|
|
32237
|
+
},
|
|
32238
|
+
type: "array"
|
|
32239
|
+
},
|
|
32240
|
+
space_ids: {
|
|
32241
|
+
description: "IDs of the spaces to which the Access Grant gives access.",
|
|
32242
|
+
items: { format: "uuid", type: "string" },
|
|
32243
|
+
type: "array"
|
|
32244
|
+
},
|
|
32245
|
+
starts_at: {
|
|
32246
|
+
description: "Date and time at which the Access Grant starts.",
|
|
32247
|
+
format: "date-time",
|
|
32248
|
+
type: "string"
|
|
32249
|
+
},
|
|
32250
|
+
user_identity_id: {
|
|
32251
|
+
description: "ID of user identity to which the Access Grant gives access.",
|
|
32252
|
+
format: "uuid",
|
|
32253
|
+
type: "string"
|
|
32254
|
+
},
|
|
32255
|
+
warnings: {
|
|
32256
|
+
description: "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32257
|
+
items: {
|
|
32258
|
+
description: "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32259
|
+
discriminator: { propertyName: "warning_code" },
|
|
32260
|
+
oneOf: [
|
|
32261
|
+
{
|
|
32262
|
+
description: "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.",
|
|
32263
|
+
properties: {
|
|
32264
|
+
created_at: {
|
|
32265
|
+
description: "Date and time at which Seam created the warning.",
|
|
32266
|
+
format: "date-time",
|
|
32267
|
+
type: "string"
|
|
32268
|
+
},
|
|
32269
|
+
message: {
|
|
32270
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
32271
|
+
type: "string"
|
|
32272
|
+
},
|
|
32273
|
+
warning_code: {
|
|
32274
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
32275
|
+
enum: ["being_deleted"],
|
|
32276
|
+
type: "string"
|
|
32277
|
+
}
|
|
32278
|
+
},
|
|
32279
|
+
required: [
|
|
32280
|
+
"created_at",
|
|
32281
|
+
"message",
|
|
32282
|
+
"warning_code"
|
|
32283
|
+
],
|
|
32284
|
+
type: "object"
|
|
32285
|
+
}
|
|
32286
|
+
]
|
|
32287
|
+
},
|
|
32288
|
+
type: "array"
|
|
32289
|
+
},
|
|
32290
|
+
workspace_id: {
|
|
32291
|
+
description: "ID of the Seam workspace associated with the Access Grant.",
|
|
32292
|
+
format: "uuid",
|
|
32293
|
+
type: "string"
|
|
32294
|
+
}
|
|
32295
|
+
},
|
|
32296
|
+
required: [
|
|
32297
|
+
"workspace_id",
|
|
32298
|
+
"access_grant_id",
|
|
32299
|
+
"user_identity_id",
|
|
32300
|
+
"location_ids",
|
|
32301
|
+
"space_ids",
|
|
32302
|
+
"requested_access_methods",
|
|
32303
|
+
"access_method_ids",
|
|
32304
|
+
"name",
|
|
32305
|
+
"display_name",
|
|
32306
|
+
"created_at",
|
|
32307
|
+
"starts_at",
|
|
32308
|
+
"ends_at",
|
|
32309
|
+
"warnings"
|
|
32310
|
+
],
|
|
32311
|
+
type: "object",
|
|
32312
|
+
"x-draft": "Early access.",
|
|
32313
|
+
"x-route-path": "/access_grants/unmanaged"
|
|
32314
|
+
},
|
|
32315
|
+
ok: { type: "boolean" }
|
|
32316
|
+
},
|
|
32317
|
+
required: ["access_grant", "ok"],
|
|
32008
32318
|
type: "object"
|
|
32009
32319
|
}
|
|
32010
32320
|
}
|
|
@@ -32020,26 +32330,44 @@ var openapi_default = {
|
|
|
32020
32330
|
{ api_key: [] },
|
|
32021
32331
|
{ client_session_with_customer: [] }
|
|
32022
32332
|
],
|
|
32023
|
-
summary: "/access_grants/
|
|
32333
|
+
summary: "/access_grants/unmanaged/get",
|
|
32024
32334
|
tags: [],
|
|
32025
32335
|
"x-draft": "Early access.",
|
|
32026
|
-
"x-fern-sdk-group-name": ["access_grants"],
|
|
32027
|
-
"x-fern-sdk-method-name": "
|
|
32028
|
-
"x-
|
|
32029
|
-
"x-
|
|
32336
|
+
"x-fern-sdk-group-name": ["access_grants", "unmanaged"],
|
|
32337
|
+
"x-fern-sdk-method-name": "get",
|
|
32338
|
+
"x-fern-sdk-return-value": "access_grant",
|
|
32339
|
+
"x-response-key": "access_grant",
|
|
32340
|
+
"x-title": "Get an Unmanaged Access Grant"
|
|
32030
32341
|
}
|
|
32031
32342
|
},
|
|
32032
|
-
"/
|
|
32033
|
-
|
|
32034
|
-
description: "
|
|
32035
|
-
operationId: "
|
|
32343
|
+
"/access_grants/unmanaged/list": {
|
|
32344
|
+
get: {
|
|
32345
|
+
description: "Gets unmanaged Access Grants (where is_managed = false).",
|
|
32346
|
+
operationId: "accessGrantsUnmanagedListGet",
|
|
32036
32347
|
parameters: [
|
|
32037
32348
|
{
|
|
32038
32349
|
in: "query",
|
|
32039
|
-
name: "
|
|
32040
|
-
required: true,
|
|
32350
|
+
name: "user_identity_id",
|
|
32041
32351
|
schema: {
|
|
32042
|
-
description: "ID of
|
|
32352
|
+
description: "ID of user identity by which you want to filter the list of unmanaged Access Grants.",
|
|
32353
|
+
format: "uuid",
|
|
32354
|
+
type: "string"
|
|
32355
|
+
}
|
|
32356
|
+
},
|
|
32357
|
+
{
|
|
32358
|
+
in: "query",
|
|
32359
|
+
name: "acs_system_id",
|
|
32360
|
+
schema: {
|
|
32361
|
+
description: "ID of the access system by which you want to filter the list of unmanaged Access Grants.",
|
|
32362
|
+
format: "uuid",
|
|
32363
|
+
type: "string"
|
|
32364
|
+
}
|
|
32365
|
+
},
|
|
32366
|
+
{
|
|
32367
|
+
in: "query",
|
|
32368
|
+
name: "acs_entrance_id",
|
|
32369
|
+
schema: {
|
|
32370
|
+
description: "ID of the entrance by which you want to filter the list of unmanaged Access Grants.",
|
|
32043
32371
|
format: "uuid",
|
|
32044
32372
|
type: "string"
|
|
32045
32373
|
}
|
|
@@ -32050,8 +32378,168 @@ var openapi_default = {
|
|
|
32050
32378
|
content: {
|
|
32051
32379
|
"application/json": {
|
|
32052
32380
|
schema: {
|
|
32053
|
-
properties: {
|
|
32054
|
-
|
|
32381
|
+
properties: {
|
|
32382
|
+
access_grants: {
|
|
32383
|
+
items: {
|
|
32384
|
+
description: "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.",
|
|
32385
|
+
properties: {
|
|
32386
|
+
access_grant_id: {
|
|
32387
|
+
description: "ID of the Access Grant.",
|
|
32388
|
+
format: "uuid",
|
|
32389
|
+
type: "string"
|
|
32390
|
+
},
|
|
32391
|
+
access_method_ids: {
|
|
32392
|
+
description: "IDs of the access methods created for the Access Grant.",
|
|
32393
|
+
items: { format: "uuid", type: "string" },
|
|
32394
|
+
type: "array"
|
|
32395
|
+
},
|
|
32396
|
+
created_at: {
|
|
32397
|
+
description: "Date and time at which the Access Grant was created.",
|
|
32398
|
+
format: "date-time",
|
|
32399
|
+
type: "string"
|
|
32400
|
+
},
|
|
32401
|
+
display_name: {
|
|
32402
|
+
description: "Display name of the Access Grant.",
|
|
32403
|
+
type: "string"
|
|
32404
|
+
},
|
|
32405
|
+
ends_at: {
|
|
32406
|
+
description: "Date and time at which the Access Grant ends.",
|
|
32407
|
+
format: "date-time",
|
|
32408
|
+
nullable: true,
|
|
32409
|
+
type: "string"
|
|
32410
|
+
},
|
|
32411
|
+
location_ids: {
|
|
32412
|
+
deprecated: true,
|
|
32413
|
+
items: { format: "uuid", type: "string" },
|
|
32414
|
+
type: "array",
|
|
32415
|
+
"x-deprecated": "Use `space_ids`."
|
|
32416
|
+
},
|
|
32417
|
+
name: {
|
|
32418
|
+
description: "Name of the Access Grant. If not provided, the display name will be computed.",
|
|
32419
|
+
nullable: true,
|
|
32420
|
+
type: "string"
|
|
32421
|
+
},
|
|
32422
|
+
requested_access_methods: {
|
|
32423
|
+
description: "Access methods that the user requested for the Access Grant.",
|
|
32424
|
+
items: {
|
|
32425
|
+
properties: {
|
|
32426
|
+
code: {
|
|
32427
|
+
description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
32428
|
+
maxLength: 9,
|
|
32429
|
+
minLength: 4,
|
|
32430
|
+
pattern: "^\\d+$",
|
|
32431
|
+
type: "string"
|
|
32432
|
+
},
|
|
32433
|
+
created_access_method_ids: {
|
|
32434
|
+
description: "IDs of the access methods created for the requested access method.",
|
|
32435
|
+
items: { format: "uuid", type: "string" },
|
|
32436
|
+
type: "array"
|
|
32437
|
+
},
|
|
32438
|
+
created_at: {
|
|
32439
|
+
description: "Date and time at which the requested access method was added to the Access Grant.",
|
|
32440
|
+
format: "date-time",
|
|
32441
|
+
type: "string"
|
|
32442
|
+
},
|
|
32443
|
+
display_name: {
|
|
32444
|
+
description: "Display name of the access method.",
|
|
32445
|
+
type: "string"
|
|
32446
|
+
},
|
|
32447
|
+
mode: {
|
|
32448
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32449
|
+
enum: ["code", "card", "mobile_key"],
|
|
32450
|
+
type: "string"
|
|
32451
|
+
}
|
|
32452
|
+
},
|
|
32453
|
+
required: [
|
|
32454
|
+
"display_name",
|
|
32455
|
+
"mode",
|
|
32456
|
+
"created_at",
|
|
32457
|
+
"created_access_method_ids"
|
|
32458
|
+
],
|
|
32459
|
+
type: "object"
|
|
32460
|
+
},
|
|
32461
|
+
type: "array"
|
|
32462
|
+
},
|
|
32463
|
+
space_ids: {
|
|
32464
|
+
description: "IDs of the spaces to which the Access Grant gives access.",
|
|
32465
|
+
items: { format: "uuid", type: "string" },
|
|
32466
|
+
type: "array"
|
|
32467
|
+
},
|
|
32468
|
+
starts_at: {
|
|
32469
|
+
description: "Date and time at which the Access Grant starts.",
|
|
32470
|
+
format: "date-time",
|
|
32471
|
+
type: "string"
|
|
32472
|
+
},
|
|
32473
|
+
user_identity_id: {
|
|
32474
|
+
description: "ID of user identity to which the Access Grant gives access.",
|
|
32475
|
+
format: "uuid",
|
|
32476
|
+
type: "string"
|
|
32477
|
+
},
|
|
32478
|
+
warnings: {
|
|
32479
|
+
description: "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32480
|
+
items: {
|
|
32481
|
+
description: "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32482
|
+
discriminator: { propertyName: "warning_code" },
|
|
32483
|
+
oneOf: [
|
|
32484
|
+
{
|
|
32485
|
+
description: "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.",
|
|
32486
|
+
properties: {
|
|
32487
|
+
created_at: {
|
|
32488
|
+
description: "Date and time at which Seam created the warning.",
|
|
32489
|
+
format: "date-time",
|
|
32490
|
+
type: "string"
|
|
32491
|
+
},
|
|
32492
|
+
message: {
|
|
32493
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
32494
|
+
type: "string"
|
|
32495
|
+
},
|
|
32496
|
+
warning_code: {
|
|
32497
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
32498
|
+
enum: ["being_deleted"],
|
|
32499
|
+
type: "string"
|
|
32500
|
+
}
|
|
32501
|
+
},
|
|
32502
|
+
required: [
|
|
32503
|
+
"created_at",
|
|
32504
|
+
"message",
|
|
32505
|
+
"warning_code"
|
|
32506
|
+
],
|
|
32507
|
+
type: "object"
|
|
32508
|
+
}
|
|
32509
|
+
]
|
|
32510
|
+
},
|
|
32511
|
+
type: "array"
|
|
32512
|
+
},
|
|
32513
|
+
workspace_id: {
|
|
32514
|
+
description: "ID of the Seam workspace associated with the Access Grant.",
|
|
32515
|
+
format: "uuid",
|
|
32516
|
+
type: "string"
|
|
32517
|
+
}
|
|
32518
|
+
},
|
|
32519
|
+
required: [
|
|
32520
|
+
"workspace_id",
|
|
32521
|
+
"access_grant_id",
|
|
32522
|
+
"user_identity_id",
|
|
32523
|
+
"location_ids",
|
|
32524
|
+
"space_ids",
|
|
32525
|
+
"requested_access_methods",
|
|
32526
|
+
"access_method_ids",
|
|
32527
|
+
"name",
|
|
32528
|
+
"display_name",
|
|
32529
|
+
"created_at",
|
|
32530
|
+
"starts_at",
|
|
32531
|
+
"ends_at",
|
|
32532
|
+
"warnings"
|
|
32533
|
+
],
|
|
32534
|
+
type: "object",
|
|
32535
|
+
"x-draft": "Early access.",
|
|
32536
|
+
"x-route-path": "/access_grants/unmanaged"
|
|
32537
|
+
},
|
|
32538
|
+
type: "array"
|
|
32539
|
+
},
|
|
32540
|
+
ok: { type: "boolean" }
|
|
32541
|
+
},
|
|
32542
|
+
required: ["access_grants", "ok"],
|
|
32055
32543
|
type: "object"
|
|
32056
32544
|
}
|
|
32057
32545
|
}
|
|
@@ -32064,87 +32552,42 @@ var openapi_default = {
|
|
|
32064
32552
|
security: [
|
|
32065
32553
|
{ pat_with_workspace: [] },
|
|
32066
32554
|
{ console_session_with_workspace: [] },
|
|
32067
|
-
{ api_key: [] }
|
|
32555
|
+
{ api_key: [] },
|
|
32556
|
+
{ client_session_with_customer: [] }
|
|
32068
32557
|
],
|
|
32069
|
-
summary: "/
|
|
32558
|
+
summary: "/access_grants/unmanaged/list",
|
|
32070
32559
|
tags: [],
|
|
32071
32560
|
"x-draft": "Early access.",
|
|
32072
|
-
"x-fern-sdk-group-name": ["
|
|
32073
|
-
"x-fern-sdk-method-name": "
|
|
32074
|
-
"x-
|
|
32075
|
-
"x-
|
|
32561
|
+
"x-fern-sdk-group-name": ["access_grants", "unmanaged"],
|
|
32562
|
+
"x-fern-sdk-method-name": "list",
|
|
32563
|
+
"x-fern-sdk-return-value": "access_grants",
|
|
32564
|
+
"x-response-key": "access_grants",
|
|
32565
|
+
"x-title": "List Unmanaged Access Grants"
|
|
32076
32566
|
},
|
|
32077
32567
|
post: {
|
|
32078
|
-
description: "
|
|
32079
|
-
operationId: "
|
|
32568
|
+
description: "Gets unmanaged Access Grants (where is_managed = false).",
|
|
32569
|
+
operationId: "accessGrantsUnmanagedListPost",
|
|
32080
32570
|
requestBody: {
|
|
32081
32571
|
content: {
|
|
32082
32572
|
"application/json": {
|
|
32083
32573
|
schema: {
|
|
32084
32574
|
properties: {
|
|
32085
|
-
|
|
32086
|
-
description: "ID of
|
|
32575
|
+
acs_entrance_id: {
|
|
32576
|
+
description: "ID of the entrance by which you want to filter the list of unmanaged Access Grants.",
|
|
32087
32577
|
format: "uuid",
|
|
32088
32578
|
type: "string"
|
|
32089
|
-
}
|
|
32090
|
-
|
|
32091
|
-
|
|
32092
|
-
type: "object"
|
|
32093
|
-
}
|
|
32094
|
-
}
|
|
32095
|
-
}
|
|
32096
|
-
},
|
|
32097
|
-
responses: {
|
|
32098
|
-
200: {
|
|
32099
|
-
content: {
|
|
32100
|
-
"application/json": {
|
|
32101
|
-
schema: {
|
|
32102
|
-
properties: { ok: { type: "boolean" } },
|
|
32103
|
-
required: ["ok"],
|
|
32104
|
-
type: "object"
|
|
32105
|
-
}
|
|
32106
|
-
}
|
|
32107
|
-
},
|
|
32108
|
-
description: "OK"
|
|
32109
|
-
},
|
|
32110
|
-
400: { description: "Bad Request" },
|
|
32111
|
-
401: { description: "Unauthorized" }
|
|
32112
|
-
},
|
|
32113
|
-
security: [
|
|
32114
|
-
{ pat_with_workspace: [] },
|
|
32115
|
-
{ console_session_with_workspace: [] },
|
|
32116
|
-
{ api_key: [] }
|
|
32117
|
-
],
|
|
32118
|
-
summary: "/access_methods/delete",
|
|
32119
|
-
tags: [],
|
|
32120
|
-
"x-draft": "Early access.",
|
|
32121
|
-
"x-fern-sdk-group-name": ["access_methods"],
|
|
32122
|
-
"x-fern-sdk-method-name": "delete",
|
|
32123
|
-
"x-response-key": null,
|
|
32124
|
-
"x-title": "Delete an Access Method"
|
|
32125
|
-
}
|
|
32126
|
-
},
|
|
32127
|
-
"/access_methods/encode": {
|
|
32128
|
-
post: {
|
|
32129
|
-
description: "Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
32130
|
-
operationId: "accessMethodsEncodePost",
|
|
32131
|
-
requestBody: {
|
|
32132
|
-
content: {
|
|
32133
|
-
"application/json": {
|
|
32134
|
-
schema: {
|
|
32135
|
-
properties: {
|
|
32136
|
-
access_method_id: {
|
|
32137
|
-
description: "ID of the `access_method` to encode onto a card.",
|
|
32579
|
+
},
|
|
32580
|
+
acs_system_id: {
|
|
32581
|
+
description: "ID of the access system by which you want to filter the list of unmanaged Access Grants.",
|
|
32138
32582
|
format: "uuid",
|
|
32139
32583
|
type: "string"
|
|
32140
32584
|
},
|
|
32141
|
-
|
|
32142
|
-
description: "ID of
|
|
32585
|
+
user_identity_id: {
|
|
32586
|
+
description: "ID of user identity by which you want to filter the list of unmanaged Access Grants.",
|
|
32143
32587
|
format: "uuid",
|
|
32144
32588
|
type: "string"
|
|
32145
32589
|
}
|
|
32146
32590
|
},
|
|
32147
|
-
required: ["acs_encoder_id", "access_method_id"],
|
|
32148
32591
|
type: "object"
|
|
32149
32592
|
}
|
|
32150
32593
|
}
|
|
@@ -32156,24 +32599,471 @@ var openapi_default = {
|
|
|
32156
32599
|
"application/json": {
|
|
32157
32600
|
schema: {
|
|
32158
32601
|
properties: {
|
|
32159
|
-
|
|
32160
|
-
|
|
32161
|
-
|
|
32162
|
-
|
|
32163
|
-
|
|
32164
|
-
|
|
32165
|
-
|
|
32166
|
-
|
|
32167
|
-
|
|
32168
|
-
|
|
32169
|
-
|
|
32170
|
-
|
|
32171
|
-
|
|
32172
|
-
|
|
32173
|
-
|
|
32174
|
-
|
|
32175
|
-
|
|
32176
|
-
|
|
32602
|
+
access_grants: {
|
|
32603
|
+
items: {
|
|
32604
|
+
description: "Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.",
|
|
32605
|
+
properties: {
|
|
32606
|
+
access_grant_id: {
|
|
32607
|
+
description: "ID of the Access Grant.",
|
|
32608
|
+
format: "uuid",
|
|
32609
|
+
type: "string"
|
|
32610
|
+
},
|
|
32611
|
+
access_method_ids: {
|
|
32612
|
+
description: "IDs of the access methods created for the Access Grant.",
|
|
32613
|
+
items: { format: "uuid", type: "string" },
|
|
32614
|
+
type: "array"
|
|
32615
|
+
},
|
|
32616
|
+
created_at: {
|
|
32617
|
+
description: "Date and time at which the Access Grant was created.",
|
|
32618
|
+
format: "date-time",
|
|
32619
|
+
type: "string"
|
|
32620
|
+
},
|
|
32621
|
+
display_name: {
|
|
32622
|
+
description: "Display name of the Access Grant.",
|
|
32623
|
+
type: "string"
|
|
32624
|
+
},
|
|
32625
|
+
ends_at: {
|
|
32626
|
+
description: "Date and time at which the Access Grant ends.",
|
|
32627
|
+
format: "date-time",
|
|
32628
|
+
nullable: true,
|
|
32629
|
+
type: "string"
|
|
32630
|
+
},
|
|
32631
|
+
location_ids: {
|
|
32632
|
+
deprecated: true,
|
|
32633
|
+
items: { format: "uuid", type: "string" },
|
|
32634
|
+
type: "array",
|
|
32635
|
+
"x-deprecated": "Use `space_ids`."
|
|
32636
|
+
},
|
|
32637
|
+
name: {
|
|
32638
|
+
description: "Name of the Access Grant. If not provided, the display name will be computed.",
|
|
32639
|
+
nullable: true,
|
|
32640
|
+
type: "string"
|
|
32641
|
+
},
|
|
32642
|
+
requested_access_methods: {
|
|
32643
|
+
description: "Access methods that the user requested for the Access Grant.",
|
|
32644
|
+
items: {
|
|
32645
|
+
properties: {
|
|
32646
|
+
code: {
|
|
32647
|
+
description: "Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
32648
|
+
maxLength: 9,
|
|
32649
|
+
minLength: 4,
|
|
32650
|
+
pattern: "^\\d+$",
|
|
32651
|
+
type: "string"
|
|
32652
|
+
},
|
|
32653
|
+
created_access_method_ids: {
|
|
32654
|
+
description: "IDs of the access methods created for the requested access method.",
|
|
32655
|
+
items: { format: "uuid", type: "string" },
|
|
32656
|
+
type: "array"
|
|
32657
|
+
},
|
|
32658
|
+
created_at: {
|
|
32659
|
+
description: "Date and time at which the requested access method was added to the Access Grant.",
|
|
32660
|
+
format: "date-time",
|
|
32661
|
+
type: "string"
|
|
32662
|
+
},
|
|
32663
|
+
display_name: {
|
|
32664
|
+
description: "Display name of the access method.",
|
|
32665
|
+
type: "string"
|
|
32666
|
+
},
|
|
32667
|
+
mode: {
|
|
32668
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
32669
|
+
enum: ["code", "card", "mobile_key"],
|
|
32670
|
+
type: "string"
|
|
32671
|
+
}
|
|
32672
|
+
},
|
|
32673
|
+
required: [
|
|
32674
|
+
"display_name",
|
|
32675
|
+
"mode",
|
|
32676
|
+
"created_at",
|
|
32677
|
+
"created_access_method_ids"
|
|
32678
|
+
],
|
|
32679
|
+
type: "object"
|
|
32680
|
+
},
|
|
32681
|
+
type: "array"
|
|
32682
|
+
},
|
|
32683
|
+
space_ids: {
|
|
32684
|
+
description: "IDs of the spaces to which the Access Grant gives access.",
|
|
32685
|
+
items: { format: "uuid", type: "string" },
|
|
32686
|
+
type: "array"
|
|
32687
|
+
},
|
|
32688
|
+
starts_at: {
|
|
32689
|
+
description: "Date and time at which the Access Grant starts.",
|
|
32690
|
+
format: "date-time",
|
|
32691
|
+
type: "string"
|
|
32692
|
+
},
|
|
32693
|
+
user_identity_id: {
|
|
32694
|
+
description: "ID of user identity to which the Access Grant gives access.",
|
|
32695
|
+
format: "uuid",
|
|
32696
|
+
type: "string"
|
|
32697
|
+
},
|
|
32698
|
+
warnings: {
|
|
32699
|
+
description: "Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32700
|
+
items: {
|
|
32701
|
+
description: "Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).",
|
|
32702
|
+
discriminator: { propertyName: "warning_code" },
|
|
32703
|
+
oneOf: [
|
|
32704
|
+
{
|
|
32705
|
+
description: "Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.",
|
|
32706
|
+
properties: {
|
|
32707
|
+
created_at: {
|
|
32708
|
+
description: "Date and time at which Seam created the warning.",
|
|
32709
|
+
format: "date-time",
|
|
32710
|
+
type: "string"
|
|
32711
|
+
},
|
|
32712
|
+
message: {
|
|
32713
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
32714
|
+
type: "string"
|
|
32715
|
+
},
|
|
32716
|
+
warning_code: {
|
|
32717
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
32718
|
+
enum: ["being_deleted"],
|
|
32719
|
+
type: "string"
|
|
32720
|
+
}
|
|
32721
|
+
},
|
|
32722
|
+
required: [
|
|
32723
|
+
"created_at",
|
|
32724
|
+
"message",
|
|
32725
|
+
"warning_code"
|
|
32726
|
+
],
|
|
32727
|
+
type: "object"
|
|
32728
|
+
}
|
|
32729
|
+
]
|
|
32730
|
+
},
|
|
32731
|
+
type: "array"
|
|
32732
|
+
},
|
|
32733
|
+
workspace_id: {
|
|
32734
|
+
description: "ID of the Seam workspace associated with the Access Grant.",
|
|
32735
|
+
format: "uuid",
|
|
32736
|
+
type: "string"
|
|
32737
|
+
}
|
|
32738
|
+
},
|
|
32739
|
+
required: [
|
|
32740
|
+
"workspace_id",
|
|
32741
|
+
"access_grant_id",
|
|
32742
|
+
"user_identity_id",
|
|
32743
|
+
"location_ids",
|
|
32744
|
+
"space_ids",
|
|
32745
|
+
"requested_access_methods",
|
|
32746
|
+
"access_method_ids",
|
|
32747
|
+
"name",
|
|
32748
|
+
"display_name",
|
|
32749
|
+
"created_at",
|
|
32750
|
+
"starts_at",
|
|
32751
|
+
"ends_at",
|
|
32752
|
+
"warnings"
|
|
32753
|
+
],
|
|
32754
|
+
type: "object",
|
|
32755
|
+
"x-draft": "Early access.",
|
|
32756
|
+
"x-route-path": "/access_grants/unmanaged"
|
|
32757
|
+
},
|
|
32758
|
+
type: "array"
|
|
32759
|
+
},
|
|
32760
|
+
ok: { type: "boolean" }
|
|
32761
|
+
},
|
|
32762
|
+
required: ["access_grants", "ok"],
|
|
32763
|
+
type: "object"
|
|
32764
|
+
}
|
|
32765
|
+
}
|
|
32766
|
+
},
|
|
32767
|
+
description: "OK"
|
|
32768
|
+
},
|
|
32769
|
+
400: { description: "Bad Request" },
|
|
32770
|
+
401: { description: "Unauthorized" }
|
|
32771
|
+
},
|
|
32772
|
+
security: [
|
|
32773
|
+
{ pat_with_workspace: [] },
|
|
32774
|
+
{ console_session_with_workspace: [] },
|
|
32775
|
+
{ api_key: [] },
|
|
32776
|
+
{ client_session_with_customer: [] }
|
|
32777
|
+
],
|
|
32778
|
+
summary: "/access_grants/unmanaged/list",
|
|
32779
|
+
tags: [],
|
|
32780
|
+
"x-draft": "Early access.",
|
|
32781
|
+
"x-fern-sdk-group-name": ["access_grants", "unmanaged"],
|
|
32782
|
+
"x-fern-sdk-method-name": "list",
|
|
32783
|
+
"x-fern-sdk-return-value": "access_grants",
|
|
32784
|
+
"x-response-key": "access_grants",
|
|
32785
|
+
"x-title": "List Unmanaged Access Grants"
|
|
32786
|
+
}
|
|
32787
|
+
},
|
|
32788
|
+
"/access_grants/update": {
|
|
32789
|
+
patch: {
|
|
32790
|
+
description: "Updates an existing Access Grant's time window.",
|
|
32791
|
+
operationId: "accessGrantsUpdatePatch",
|
|
32792
|
+
requestBody: {
|
|
32793
|
+
content: {
|
|
32794
|
+
"application/json": {
|
|
32795
|
+
schema: {
|
|
32796
|
+
properties: {
|
|
32797
|
+
access_grant_id: {
|
|
32798
|
+
description: "ID of the Access Grant to update.",
|
|
32799
|
+
format: "uuid",
|
|
32800
|
+
type: "string"
|
|
32801
|
+
},
|
|
32802
|
+
ends_at: {
|
|
32803
|
+
description: "Date and time at which the validity of the grant 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`.",
|
|
32804
|
+
format: "date-time",
|
|
32805
|
+
nullable: true,
|
|
32806
|
+
type: "string"
|
|
32807
|
+
},
|
|
32808
|
+
name: {
|
|
32809
|
+
description: "Display name for the access grant.",
|
|
32810
|
+
nullable: true,
|
|
32811
|
+
type: "string"
|
|
32812
|
+
},
|
|
32813
|
+
starts_at: {
|
|
32814
|
+
description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
32815
|
+
format: "date-time",
|
|
32816
|
+
type: "string"
|
|
32817
|
+
}
|
|
32818
|
+
},
|
|
32819
|
+
required: ["access_grant_id"],
|
|
32820
|
+
type: "object"
|
|
32821
|
+
}
|
|
32822
|
+
}
|
|
32823
|
+
}
|
|
32824
|
+
},
|
|
32825
|
+
responses: {
|
|
32826
|
+
200: {
|
|
32827
|
+
content: {
|
|
32828
|
+
"application/json": {
|
|
32829
|
+
schema: {
|
|
32830
|
+
properties: { ok: { type: "boolean" } },
|
|
32831
|
+
required: ["ok"],
|
|
32832
|
+
type: "object"
|
|
32833
|
+
}
|
|
32834
|
+
}
|
|
32835
|
+
},
|
|
32836
|
+
description: "OK"
|
|
32837
|
+
},
|
|
32838
|
+
400: { description: "Bad Request" },
|
|
32839
|
+
401: { description: "Unauthorized" }
|
|
32840
|
+
},
|
|
32841
|
+
security: [
|
|
32842
|
+
{ pat_with_workspace: [] },
|
|
32843
|
+
{ console_session_with_workspace: [] },
|
|
32844
|
+
{ api_key: [] },
|
|
32845
|
+
{ client_session_with_customer: [] }
|
|
32846
|
+
],
|
|
32847
|
+
summary: "/access_grants/update",
|
|
32848
|
+
tags: [],
|
|
32849
|
+
"x-draft": "Early access.",
|
|
32850
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
32851
|
+
"x-fern-sdk-method-name": "update",
|
|
32852
|
+
"x-response-key": null,
|
|
32853
|
+
"x-title": "Update an Access Grant"
|
|
32854
|
+
},
|
|
32855
|
+
post: {
|
|
32856
|
+
description: "Updates an existing Access Grant's time window.",
|
|
32857
|
+
operationId: "accessGrantsUpdatePost",
|
|
32858
|
+
requestBody: {
|
|
32859
|
+
content: {
|
|
32860
|
+
"application/json": {
|
|
32861
|
+
schema: {
|
|
32862
|
+
properties: {
|
|
32863
|
+
access_grant_id: {
|
|
32864
|
+
description: "ID of the Access Grant to update.",
|
|
32865
|
+
format: "uuid",
|
|
32866
|
+
type: "string"
|
|
32867
|
+
},
|
|
32868
|
+
ends_at: {
|
|
32869
|
+
description: "Date and time at which the validity of the grant 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`.",
|
|
32870
|
+
format: "date-time",
|
|
32871
|
+
nullable: true,
|
|
32872
|
+
type: "string"
|
|
32873
|
+
},
|
|
32874
|
+
name: {
|
|
32875
|
+
description: "Display name for the access grant.",
|
|
32876
|
+
nullable: true,
|
|
32877
|
+
type: "string"
|
|
32878
|
+
},
|
|
32879
|
+
starts_at: {
|
|
32880
|
+
description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
32881
|
+
format: "date-time",
|
|
32882
|
+
type: "string"
|
|
32883
|
+
}
|
|
32884
|
+
},
|
|
32885
|
+
required: ["access_grant_id"],
|
|
32886
|
+
type: "object"
|
|
32887
|
+
}
|
|
32888
|
+
}
|
|
32889
|
+
}
|
|
32890
|
+
},
|
|
32891
|
+
responses: {
|
|
32892
|
+
200: {
|
|
32893
|
+
content: {
|
|
32894
|
+
"application/json": {
|
|
32895
|
+
schema: {
|
|
32896
|
+
properties: { ok: { type: "boolean" } },
|
|
32897
|
+
required: ["ok"],
|
|
32898
|
+
type: "object"
|
|
32899
|
+
}
|
|
32900
|
+
}
|
|
32901
|
+
},
|
|
32902
|
+
description: "OK"
|
|
32903
|
+
},
|
|
32904
|
+
400: { description: "Bad Request" },
|
|
32905
|
+
401: { description: "Unauthorized" }
|
|
32906
|
+
},
|
|
32907
|
+
security: [
|
|
32908
|
+
{ pat_with_workspace: [] },
|
|
32909
|
+
{ console_session_with_workspace: [] },
|
|
32910
|
+
{ api_key: [] },
|
|
32911
|
+
{ client_session_with_customer: [] }
|
|
32912
|
+
],
|
|
32913
|
+
summary: "/access_grants/update",
|
|
32914
|
+
tags: [],
|
|
32915
|
+
"x-draft": "Early access.",
|
|
32916
|
+
"x-fern-sdk-group-name": ["access_grants"],
|
|
32917
|
+
"x-fern-sdk-method-name": "update",
|
|
32918
|
+
"x-response-key": null,
|
|
32919
|
+
"x-title": "Update an Access Grant"
|
|
32920
|
+
}
|
|
32921
|
+
},
|
|
32922
|
+
"/access_methods/delete": {
|
|
32923
|
+
delete: {
|
|
32924
|
+
description: "Deletes an access method.",
|
|
32925
|
+
operationId: "accessMethodsDeleteDelete",
|
|
32926
|
+
parameters: [
|
|
32927
|
+
{
|
|
32928
|
+
in: "query",
|
|
32929
|
+
name: "access_method_id",
|
|
32930
|
+
required: true,
|
|
32931
|
+
schema: {
|
|
32932
|
+
description: "ID of access method to get.",
|
|
32933
|
+
format: "uuid",
|
|
32934
|
+
type: "string"
|
|
32935
|
+
}
|
|
32936
|
+
}
|
|
32937
|
+
],
|
|
32938
|
+
responses: {
|
|
32939
|
+
200: {
|
|
32940
|
+
content: {
|
|
32941
|
+
"application/json": {
|
|
32942
|
+
schema: {
|
|
32943
|
+
properties: { ok: { type: "boolean" } },
|
|
32944
|
+
required: ["ok"],
|
|
32945
|
+
type: "object"
|
|
32946
|
+
}
|
|
32947
|
+
}
|
|
32948
|
+
},
|
|
32949
|
+
description: "OK"
|
|
32950
|
+
},
|
|
32951
|
+
400: { description: "Bad Request" },
|
|
32952
|
+
401: { description: "Unauthorized" }
|
|
32953
|
+
},
|
|
32954
|
+
security: [
|
|
32955
|
+
{ pat_with_workspace: [] },
|
|
32956
|
+
{ console_session_with_workspace: [] },
|
|
32957
|
+
{ api_key: [] }
|
|
32958
|
+
],
|
|
32959
|
+
summary: "/access_methods/delete",
|
|
32960
|
+
tags: [],
|
|
32961
|
+
"x-draft": "Early access.",
|
|
32962
|
+
"x-fern-sdk-group-name": ["access_methods"],
|
|
32963
|
+
"x-fern-sdk-method-name": "delete",
|
|
32964
|
+
"x-response-key": null,
|
|
32965
|
+
"x-title": "Delete an Access Method"
|
|
32966
|
+
},
|
|
32967
|
+
post: {
|
|
32968
|
+
description: "Deletes an access method.",
|
|
32969
|
+
operationId: "accessMethodsDeletePost",
|
|
32970
|
+
requestBody: {
|
|
32971
|
+
content: {
|
|
32972
|
+
"application/json": {
|
|
32973
|
+
schema: {
|
|
32974
|
+
properties: {
|
|
32975
|
+
access_method_id: {
|
|
32976
|
+
description: "ID of access method to get.",
|
|
32977
|
+
format: "uuid",
|
|
32978
|
+
type: "string"
|
|
32979
|
+
}
|
|
32980
|
+
},
|
|
32981
|
+
required: ["access_method_id"],
|
|
32982
|
+
type: "object"
|
|
32983
|
+
}
|
|
32984
|
+
}
|
|
32985
|
+
}
|
|
32986
|
+
},
|
|
32987
|
+
responses: {
|
|
32988
|
+
200: {
|
|
32989
|
+
content: {
|
|
32990
|
+
"application/json": {
|
|
32991
|
+
schema: {
|
|
32992
|
+
properties: { ok: { type: "boolean" } },
|
|
32993
|
+
required: ["ok"],
|
|
32994
|
+
type: "object"
|
|
32995
|
+
}
|
|
32996
|
+
}
|
|
32997
|
+
},
|
|
32998
|
+
description: "OK"
|
|
32999
|
+
},
|
|
33000
|
+
400: { description: "Bad Request" },
|
|
33001
|
+
401: { description: "Unauthorized" }
|
|
33002
|
+
},
|
|
33003
|
+
security: [
|
|
33004
|
+
{ pat_with_workspace: [] },
|
|
33005
|
+
{ console_session_with_workspace: [] },
|
|
33006
|
+
{ api_key: [] }
|
|
33007
|
+
],
|
|
33008
|
+
summary: "/access_methods/delete",
|
|
33009
|
+
tags: [],
|
|
33010
|
+
"x-draft": "Early access.",
|
|
33011
|
+
"x-fern-sdk-group-name": ["access_methods"],
|
|
33012
|
+
"x-fern-sdk-method-name": "delete",
|
|
33013
|
+
"x-response-key": null,
|
|
33014
|
+
"x-title": "Delete an Access Method"
|
|
33015
|
+
}
|
|
33016
|
+
},
|
|
33017
|
+
"/access_methods/encode": {
|
|
33018
|
+
post: {
|
|
33019
|
+
description: "Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).",
|
|
33020
|
+
operationId: "accessMethodsEncodePost",
|
|
33021
|
+
requestBody: {
|
|
33022
|
+
content: {
|
|
33023
|
+
"application/json": {
|
|
33024
|
+
schema: {
|
|
33025
|
+
properties: {
|
|
33026
|
+
access_method_id: {
|
|
33027
|
+
description: "ID of the `access_method` to encode onto a card.",
|
|
33028
|
+
format: "uuid",
|
|
33029
|
+
type: "string"
|
|
33030
|
+
},
|
|
33031
|
+
acs_encoder_id: {
|
|
33032
|
+
description: "ID of the `acs_encoder` to use to encode the `access_method`.",
|
|
33033
|
+
format: "uuid",
|
|
33034
|
+
type: "string"
|
|
33035
|
+
}
|
|
33036
|
+
},
|
|
33037
|
+
required: ["acs_encoder_id", "access_method_id"],
|
|
33038
|
+
type: "object"
|
|
33039
|
+
}
|
|
33040
|
+
}
|
|
33041
|
+
}
|
|
33042
|
+
},
|
|
33043
|
+
responses: {
|
|
33044
|
+
200: {
|
|
33045
|
+
content: {
|
|
33046
|
+
"application/json": {
|
|
33047
|
+
schema: {
|
|
33048
|
+
properties: {
|
|
33049
|
+
action_attempt: {
|
|
33050
|
+
$ref: "#/components/schemas/action_attempt"
|
|
33051
|
+
},
|
|
33052
|
+
ok: { type: "boolean" }
|
|
33053
|
+
},
|
|
33054
|
+
required: ["action_attempt", "ok"],
|
|
33055
|
+
type: "object"
|
|
33056
|
+
}
|
|
33057
|
+
}
|
|
33058
|
+
},
|
|
33059
|
+
description: "OK"
|
|
33060
|
+
},
|
|
33061
|
+
400: { description: "Bad Request" },
|
|
33062
|
+
401: { description: "Unauthorized" }
|
|
33063
|
+
},
|
|
33064
|
+
security: [
|
|
33065
|
+
{ pat_with_workspace: [] },
|
|
33066
|
+
{ console_session_with_workspace: [] },
|
|
32177
33067
|
{ api_key: [] }
|
|
32178
33068
|
],
|
|
32179
33069
|
summary: "/access_methods/encode",
|
|
@@ -32924,137 +33814,19 @@ var openapi_default = {
|
|
|
32924
33814
|
"x-title": "List Access Methods"
|
|
32925
33815
|
}
|
|
32926
33816
|
},
|
|
32927
|
-
"/
|
|
32928
|
-
|
|
32929
|
-
description: "
|
|
32930
|
-
operationId: "
|
|
32931
|
-
|
|
32932
|
-
|
|
32933
|
-
"
|
|
32934
|
-
|
|
32935
|
-
|
|
32936
|
-
|
|
32937
|
-
|
|
32938
|
-
|
|
32939
|
-
|
|
32940
|
-
},
|
|
32941
|
-
acs_user_id: {
|
|
32942
|
-
description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
|
|
32943
|
-
format: "uuid",
|
|
32944
|
-
type: "string"
|
|
32945
|
-
},
|
|
32946
|
-
user_identity_id: {
|
|
32947
|
-
description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
32948
|
-
format: "uuid",
|
|
32949
|
-
type: "string"
|
|
32950
|
-
}
|
|
32951
|
-
},
|
|
32952
|
-
required: ["acs_access_group_id"],
|
|
32953
|
-
type: "object"
|
|
32954
|
-
}
|
|
32955
|
-
}
|
|
32956
|
-
}
|
|
32957
|
-
},
|
|
32958
|
-
responses: {
|
|
32959
|
-
200: {
|
|
32960
|
-
content: {
|
|
32961
|
-
"application/json": {
|
|
32962
|
-
schema: {
|
|
32963
|
-
properties: { ok: { type: "boolean" } },
|
|
32964
|
-
required: ["ok"],
|
|
32965
|
-
type: "object"
|
|
32966
|
-
}
|
|
32967
|
-
}
|
|
32968
|
-
},
|
|
32969
|
-
description: "OK"
|
|
32970
|
-
},
|
|
32971
|
-
400: { description: "Bad Request" },
|
|
32972
|
-
401: { description: "Unauthorized" }
|
|
32973
|
-
},
|
|
32974
|
-
security: [
|
|
32975
|
-
{ pat_with_workspace: [] },
|
|
32976
|
-
{ console_session_with_workspace: [] },
|
|
32977
|
-
{ api_key: [] }
|
|
32978
|
-
],
|
|
32979
|
-
summary: "/acs/access_groups/add_user",
|
|
32980
|
-
tags: ["/acs"],
|
|
32981
|
-
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
32982
|
-
"x-fern-sdk-method-name": "add_user",
|
|
32983
|
-
"x-response-key": null,
|
|
32984
|
-
"x-title": "Add an ACS User to an Access Group"
|
|
32985
|
-
},
|
|
32986
|
-
put: {
|
|
32987
|
-
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
32988
|
-
operationId: "acsAccessGroupsAddUserPut",
|
|
32989
|
-
requestBody: {
|
|
32990
|
-
content: {
|
|
32991
|
-
"application/json": {
|
|
32992
|
-
schema: {
|
|
32993
|
-
properties: {
|
|
32994
|
-
acs_access_group_id: {
|
|
32995
|
-
description: "ID of the access group to which you want to add an access system user.",
|
|
32996
|
-
format: "uuid",
|
|
32997
|
-
type: "string"
|
|
32998
|
-
},
|
|
32999
|
-
acs_user_id: {
|
|
33000
|
-
description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
|
|
33001
|
-
format: "uuid",
|
|
33002
|
-
type: "string"
|
|
33003
|
-
},
|
|
33004
|
-
user_identity_id: {
|
|
33005
|
-
description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
33006
|
-
format: "uuid",
|
|
33007
|
-
type: "string"
|
|
33008
|
-
}
|
|
33009
|
-
},
|
|
33010
|
-
required: ["acs_access_group_id"],
|
|
33011
|
-
type: "object"
|
|
33012
|
-
}
|
|
33013
|
-
}
|
|
33014
|
-
}
|
|
33015
|
-
},
|
|
33016
|
-
responses: {
|
|
33017
|
-
200: {
|
|
33018
|
-
content: {
|
|
33019
|
-
"application/json": {
|
|
33020
|
-
schema: {
|
|
33021
|
-
properties: { ok: { type: "boolean" } },
|
|
33022
|
-
required: ["ok"],
|
|
33023
|
-
type: "object"
|
|
33024
|
-
}
|
|
33025
|
-
}
|
|
33026
|
-
},
|
|
33027
|
-
description: "OK"
|
|
33028
|
-
},
|
|
33029
|
-
400: { description: "Bad Request" },
|
|
33030
|
-
401: { description: "Unauthorized" }
|
|
33031
|
-
},
|
|
33032
|
-
security: [
|
|
33033
|
-
{ pat_with_workspace: [] },
|
|
33034
|
-
{ console_session_with_workspace: [] },
|
|
33035
|
-
{ api_key: [] }
|
|
33036
|
-
],
|
|
33037
|
-
summary: "/acs/access_groups/add_user",
|
|
33038
|
-
tags: ["/acs"],
|
|
33039
|
-
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
33040
|
-
"x-fern-sdk-method-name": "add_user",
|
|
33041
|
-
"x-response-key": null,
|
|
33042
|
-
"x-title": "Add an ACS User to an Access Group"
|
|
33043
|
-
}
|
|
33044
|
-
},
|
|
33045
|
-
"/acs/access_groups/get": {
|
|
33046
|
-
get: {
|
|
33047
|
-
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
33048
|
-
operationId: "acsAccessGroupsGetGet",
|
|
33049
|
-
parameters: [
|
|
33050
|
-
{
|
|
33051
|
-
in: "query",
|
|
33052
|
-
name: "acs_access_group_id",
|
|
33053
|
-
required: true,
|
|
33054
|
-
schema: {
|
|
33055
|
-
description: "ID of the access group that you want to get.",
|
|
33056
|
-
format: "uuid",
|
|
33057
|
-
type: "string"
|
|
33817
|
+
"/access_methods/unmanaged/get": {
|
|
33818
|
+
get: {
|
|
33819
|
+
description: "Gets an unmanaged access method (where is_managed = false).",
|
|
33820
|
+
operationId: "accessMethodsUnmanagedGetGet",
|
|
33821
|
+
parameters: [
|
|
33822
|
+
{
|
|
33823
|
+
in: "query",
|
|
33824
|
+
name: "access_method_id",
|
|
33825
|
+
required: true,
|
|
33826
|
+
schema: {
|
|
33827
|
+
description: "ID of unmanaged access method to get.",
|
|
33828
|
+
format: "uuid",
|
|
33829
|
+
type: "string"
|
|
33058
33830
|
}
|
|
33059
33831
|
}
|
|
33060
33832
|
],
|
|
@@ -33064,12 +33836,105 @@ var openapi_default = {
|
|
|
33064
33836
|
"application/json": {
|
|
33065
33837
|
schema: {
|
|
33066
33838
|
properties: {
|
|
33067
|
-
|
|
33068
|
-
|
|
33839
|
+
access_method: {
|
|
33840
|
+
description: "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.",
|
|
33841
|
+
properties: {
|
|
33842
|
+
access_method_id: {
|
|
33843
|
+
description: "ID of the access method.",
|
|
33844
|
+
format: "uuid",
|
|
33845
|
+
type: "string"
|
|
33846
|
+
},
|
|
33847
|
+
code: {
|
|
33848
|
+
description: "The actual PIN code for code access methods.",
|
|
33849
|
+
nullable: true,
|
|
33850
|
+
type: "string"
|
|
33851
|
+
},
|
|
33852
|
+
created_at: {
|
|
33853
|
+
description: "Date and time at which the access method was created.",
|
|
33854
|
+
format: "date-time",
|
|
33855
|
+
type: "string"
|
|
33856
|
+
},
|
|
33857
|
+
display_name: {
|
|
33858
|
+
description: "Display name of the access method.",
|
|
33859
|
+
type: "string"
|
|
33860
|
+
},
|
|
33861
|
+
is_encoding_required: {
|
|
33862
|
+
description: "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.",
|
|
33863
|
+
type: "boolean"
|
|
33864
|
+
},
|
|
33865
|
+
is_issued: {
|
|
33866
|
+
description: "Indicates whether the access method has been issued.",
|
|
33867
|
+
type: "boolean"
|
|
33868
|
+
},
|
|
33869
|
+
issued_at: {
|
|
33870
|
+
description: "Date and time at which the access method was issued.",
|
|
33871
|
+
format: "date-time",
|
|
33872
|
+
nullable: true,
|
|
33873
|
+
type: "string"
|
|
33874
|
+
},
|
|
33875
|
+
mode: {
|
|
33876
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
33877
|
+
enum: ["code", "card", "mobile_key"],
|
|
33878
|
+
type: "string"
|
|
33879
|
+
},
|
|
33880
|
+
warnings: {
|
|
33881
|
+
description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
33882
|
+
items: {
|
|
33883
|
+
description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
33884
|
+
discriminator: { propertyName: "warning_code" },
|
|
33885
|
+
oneOf: [
|
|
33886
|
+
{
|
|
33887
|
+
description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
|
|
33888
|
+
properties: {
|
|
33889
|
+
created_at: {
|
|
33890
|
+
description: "Date and time at which Seam created the warning.",
|
|
33891
|
+
format: "date-time",
|
|
33892
|
+
type: "string"
|
|
33893
|
+
},
|
|
33894
|
+
message: {
|
|
33895
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
33896
|
+
type: "string"
|
|
33897
|
+
},
|
|
33898
|
+
warning_code: {
|
|
33899
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
33900
|
+
enum: ["being_deleted"],
|
|
33901
|
+
type: "string"
|
|
33902
|
+
}
|
|
33903
|
+
},
|
|
33904
|
+
required: [
|
|
33905
|
+
"created_at",
|
|
33906
|
+
"message",
|
|
33907
|
+
"warning_code"
|
|
33908
|
+
],
|
|
33909
|
+
type: "object"
|
|
33910
|
+
}
|
|
33911
|
+
]
|
|
33912
|
+
},
|
|
33913
|
+
type: "array"
|
|
33914
|
+
},
|
|
33915
|
+
workspace_id: {
|
|
33916
|
+
description: "ID of the Seam workspace associated with the access method.",
|
|
33917
|
+
format: "uuid",
|
|
33918
|
+
type: "string"
|
|
33919
|
+
}
|
|
33920
|
+
},
|
|
33921
|
+
required: [
|
|
33922
|
+
"workspace_id",
|
|
33923
|
+
"access_method_id",
|
|
33924
|
+
"display_name",
|
|
33925
|
+
"mode",
|
|
33926
|
+
"created_at",
|
|
33927
|
+
"issued_at",
|
|
33928
|
+
"is_issued",
|
|
33929
|
+
"warnings"
|
|
33930
|
+
],
|
|
33931
|
+
type: "object",
|
|
33932
|
+
"x-draft": "Early access.",
|
|
33933
|
+
"x-route-path": "/access_methods/unmanaged"
|
|
33069
33934
|
},
|
|
33070
33935
|
ok: { type: "boolean" }
|
|
33071
33936
|
},
|
|
33072
|
-
required: ["
|
|
33937
|
+
required: ["access_method", "ok"],
|
|
33073
33938
|
type: "object"
|
|
33074
33939
|
}
|
|
33075
33940
|
}
|
|
@@ -33084,29 +33949,30 @@ var openapi_default = {
|
|
|
33084
33949
|
{ console_session_with_workspace: [] },
|
|
33085
33950
|
{ api_key: [] }
|
|
33086
33951
|
],
|
|
33087
|
-
summary: "/
|
|
33088
|
-
tags: [
|
|
33089
|
-
"x-
|
|
33952
|
+
summary: "/access_methods/unmanaged/get",
|
|
33953
|
+
tags: [],
|
|
33954
|
+
"x-draft": "Early access.",
|
|
33955
|
+
"x-fern-sdk-group-name": ["access_methods", "unmanaged"],
|
|
33090
33956
|
"x-fern-sdk-method-name": "get",
|
|
33091
|
-
"x-fern-sdk-return-value": "
|
|
33092
|
-
"x-response-key": "
|
|
33093
|
-
"x-title": "Get an Access
|
|
33957
|
+
"x-fern-sdk-return-value": "access_method",
|
|
33958
|
+
"x-response-key": "access_method",
|
|
33959
|
+
"x-title": "Get an Unmanaged Access Method"
|
|
33094
33960
|
},
|
|
33095
33961
|
post: {
|
|
33096
|
-
description: "
|
|
33097
|
-
operationId: "
|
|
33962
|
+
description: "Gets an unmanaged access method (where is_managed = false).",
|
|
33963
|
+
operationId: "accessMethodsUnmanagedGetPost",
|
|
33098
33964
|
requestBody: {
|
|
33099
33965
|
content: {
|
|
33100
33966
|
"application/json": {
|
|
33101
33967
|
schema: {
|
|
33102
33968
|
properties: {
|
|
33103
|
-
|
|
33104
|
-
description: "ID of
|
|
33969
|
+
access_method_id: {
|
|
33970
|
+
description: "ID of unmanaged access method to get.",
|
|
33105
33971
|
format: "uuid",
|
|
33106
33972
|
type: "string"
|
|
33107
33973
|
}
|
|
33108
33974
|
},
|
|
33109
|
-
required: ["
|
|
33975
|
+
required: ["access_method_id"],
|
|
33110
33976
|
type: "object"
|
|
33111
33977
|
}
|
|
33112
33978
|
}
|
|
@@ -33118,12 +33984,105 @@ var openapi_default = {
|
|
|
33118
33984
|
"application/json": {
|
|
33119
33985
|
schema: {
|
|
33120
33986
|
properties: {
|
|
33121
|
-
|
|
33122
|
-
|
|
33987
|
+
access_method: {
|
|
33988
|
+
description: "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.",
|
|
33989
|
+
properties: {
|
|
33990
|
+
access_method_id: {
|
|
33991
|
+
description: "ID of the access method.",
|
|
33992
|
+
format: "uuid",
|
|
33993
|
+
type: "string"
|
|
33994
|
+
},
|
|
33995
|
+
code: {
|
|
33996
|
+
description: "The actual PIN code for code access methods.",
|
|
33997
|
+
nullable: true,
|
|
33998
|
+
type: "string"
|
|
33999
|
+
},
|
|
34000
|
+
created_at: {
|
|
34001
|
+
description: "Date and time at which the access method was created.",
|
|
34002
|
+
format: "date-time",
|
|
34003
|
+
type: "string"
|
|
34004
|
+
},
|
|
34005
|
+
display_name: {
|
|
34006
|
+
description: "Display name of the access method.",
|
|
34007
|
+
type: "string"
|
|
34008
|
+
},
|
|
34009
|
+
is_encoding_required: {
|
|
34010
|
+
description: "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.",
|
|
34011
|
+
type: "boolean"
|
|
34012
|
+
},
|
|
34013
|
+
is_issued: {
|
|
34014
|
+
description: "Indicates whether the access method has been issued.",
|
|
34015
|
+
type: "boolean"
|
|
34016
|
+
},
|
|
34017
|
+
issued_at: {
|
|
34018
|
+
description: "Date and time at which the access method was issued.",
|
|
34019
|
+
format: "date-time",
|
|
34020
|
+
nullable: true,
|
|
34021
|
+
type: "string"
|
|
34022
|
+
},
|
|
34023
|
+
mode: {
|
|
34024
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
34025
|
+
enum: ["code", "card", "mobile_key"],
|
|
34026
|
+
type: "string"
|
|
34027
|
+
},
|
|
34028
|
+
warnings: {
|
|
34029
|
+
description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
34030
|
+
items: {
|
|
34031
|
+
description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
34032
|
+
discriminator: { propertyName: "warning_code" },
|
|
34033
|
+
oneOf: [
|
|
34034
|
+
{
|
|
34035
|
+
description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
|
|
34036
|
+
properties: {
|
|
34037
|
+
created_at: {
|
|
34038
|
+
description: "Date and time at which Seam created the warning.",
|
|
34039
|
+
format: "date-time",
|
|
34040
|
+
type: "string"
|
|
34041
|
+
},
|
|
34042
|
+
message: {
|
|
34043
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
34044
|
+
type: "string"
|
|
34045
|
+
},
|
|
34046
|
+
warning_code: {
|
|
34047
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
34048
|
+
enum: ["being_deleted"],
|
|
34049
|
+
type: "string"
|
|
34050
|
+
}
|
|
34051
|
+
},
|
|
34052
|
+
required: [
|
|
34053
|
+
"created_at",
|
|
34054
|
+
"message",
|
|
34055
|
+
"warning_code"
|
|
34056
|
+
],
|
|
34057
|
+
type: "object"
|
|
34058
|
+
}
|
|
34059
|
+
]
|
|
34060
|
+
},
|
|
34061
|
+
type: "array"
|
|
34062
|
+
},
|
|
34063
|
+
workspace_id: {
|
|
34064
|
+
description: "ID of the Seam workspace associated with the access method.",
|
|
34065
|
+
format: "uuid",
|
|
34066
|
+
type: "string"
|
|
34067
|
+
}
|
|
34068
|
+
},
|
|
34069
|
+
required: [
|
|
34070
|
+
"workspace_id",
|
|
34071
|
+
"access_method_id",
|
|
34072
|
+
"display_name",
|
|
34073
|
+
"mode",
|
|
34074
|
+
"created_at",
|
|
34075
|
+
"issued_at",
|
|
34076
|
+
"is_issued",
|
|
34077
|
+
"warnings"
|
|
34078
|
+
],
|
|
34079
|
+
type: "object",
|
|
34080
|
+
"x-draft": "Early access.",
|
|
34081
|
+
"x-route-path": "/access_methods/unmanaged"
|
|
33123
34082
|
},
|
|
33124
34083
|
ok: { type: "boolean" }
|
|
33125
34084
|
},
|
|
33126
|
-
required: ["
|
|
34085
|
+
required: ["access_method", "ok"],
|
|
33127
34086
|
type: "object"
|
|
33128
34087
|
}
|
|
33129
34088
|
}
|
|
@@ -33138,43 +34097,57 @@ var openapi_default = {
|
|
|
33138
34097
|
{ console_session_with_workspace: [] },
|
|
33139
34098
|
{ api_key: [] }
|
|
33140
34099
|
],
|
|
33141
|
-
summary: "/
|
|
33142
|
-
tags: [
|
|
33143
|
-
"x-
|
|
34100
|
+
summary: "/access_methods/unmanaged/get",
|
|
34101
|
+
tags: [],
|
|
34102
|
+
"x-draft": "Early access.",
|
|
34103
|
+
"x-fern-sdk-group-name": ["access_methods", "unmanaged"],
|
|
33144
34104
|
"x-fern-sdk-method-name": "get",
|
|
33145
|
-
"x-fern-sdk-return-value": "
|
|
33146
|
-
"x-response-key": "
|
|
33147
|
-
"x-title": "Get an Access
|
|
34105
|
+
"x-fern-sdk-return-value": "access_method",
|
|
34106
|
+
"x-response-key": "access_method",
|
|
34107
|
+
"x-title": "Get an Unmanaged Access Method"
|
|
33148
34108
|
}
|
|
33149
34109
|
},
|
|
33150
|
-
"/
|
|
34110
|
+
"/access_methods/unmanaged/list": {
|
|
33151
34111
|
get: {
|
|
33152
|
-
description: "
|
|
33153
|
-
operationId: "
|
|
34112
|
+
description: "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.",
|
|
34113
|
+
operationId: "accessMethodsUnmanagedListGet",
|
|
33154
34114
|
parameters: [
|
|
33155
34115
|
{
|
|
33156
34116
|
in: "query",
|
|
33157
|
-
name: "
|
|
34117
|
+
name: "access_grant_id",
|
|
34118
|
+
required: true,
|
|
33158
34119
|
schema: {
|
|
33159
|
-
description: "ID of
|
|
34120
|
+
description: "ID of Access Grant to list unmanaged access methods for.",
|
|
33160
34121
|
format: "uuid",
|
|
33161
34122
|
type: "string"
|
|
33162
34123
|
}
|
|
33163
34124
|
},
|
|
33164
34125
|
{
|
|
33165
34126
|
in: "query",
|
|
33166
|
-
name: "
|
|
34127
|
+
name: "device_id",
|
|
34128
|
+
required: false,
|
|
33167
34129
|
schema: {
|
|
33168
|
-
description: "ID of the
|
|
34130
|
+
description: "ID of the device for which you want to retrieve all unmanaged access methods.",
|
|
33169
34131
|
format: "uuid",
|
|
33170
34132
|
type: "string"
|
|
33171
34133
|
}
|
|
33172
34134
|
},
|
|
33173
34135
|
{
|
|
33174
34136
|
in: "query",
|
|
33175
|
-
name: "
|
|
34137
|
+
name: "acs_entrance_id",
|
|
34138
|
+
required: false,
|
|
33176
34139
|
schema: {
|
|
33177
|
-
description: "ID of the
|
|
34140
|
+
description: "ID of the entrance for which you want to retrieve all unmanaged access methods.",
|
|
34141
|
+
format: "uuid",
|
|
34142
|
+
type: "string"
|
|
34143
|
+
}
|
|
34144
|
+
},
|
|
34145
|
+
{
|
|
34146
|
+
in: "query",
|
|
34147
|
+
name: "space_id",
|
|
34148
|
+
required: false,
|
|
34149
|
+
schema: {
|
|
34150
|
+
description: "ID of the space for which you want to retrieve all unmanaged access methods.",
|
|
33178
34151
|
format: "uuid",
|
|
33179
34152
|
type: "string"
|
|
33180
34153
|
}
|
|
@@ -33186,13 +34159,108 @@ var openapi_default = {
|
|
|
33186
34159
|
"application/json": {
|
|
33187
34160
|
schema: {
|
|
33188
34161
|
properties: {
|
|
33189
|
-
|
|
33190
|
-
items: {
|
|
34162
|
+
access_methods: {
|
|
34163
|
+
items: {
|
|
34164
|
+
description: "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.",
|
|
34165
|
+
properties: {
|
|
34166
|
+
access_method_id: {
|
|
34167
|
+
description: "ID of the access method.",
|
|
34168
|
+
format: "uuid",
|
|
34169
|
+
type: "string"
|
|
34170
|
+
},
|
|
34171
|
+
code: {
|
|
34172
|
+
description: "The actual PIN code for code access methods.",
|
|
34173
|
+
nullable: true,
|
|
34174
|
+
type: "string"
|
|
34175
|
+
},
|
|
34176
|
+
created_at: {
|
|
34177
|
+
description: "Date and time at which the access method was created.",
|
|
34178
|
+
format: "date-time",
|
|
34179
|
+
type: "string"
|
|
34180
|
+
},
|
|
34181
|
+
display_name: {
|
|
34182
|
+
description: "Display name of the access method.",
|
|
34183
|
+
type: "string"
|
|
34184
|
+
},
|
|
34185
|
+
is_encoding_required: {
|
|
34186
|
+
description: "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.",
|
|
34187
|
+
type: "boolean"
|
|
34188
|
+
},
|
|
34189
|
+
is_issued: {
|
|
34190
|
+
description: "Indicates whether the access method has been issued.",
|
|
34191
|
+
type: "boolean"
|
|
34192
|
+
},
|
|
34193
|
+
issued_at: {
|
|
34194
|
+
description: "Date and time at which the access method was issued.",
|
|
34195
|
+
format: "date-time",
|
|
34196
|
+
nullable: true,
|
|
34197
|
+
type: "string"
|
|
34198
|
+
},
|
|
34199
|
+
mode: {
|
|
34200
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
34201
|
+
enum: ["code", "card", "mobile_key"],
|
|
34202
|
+
type: "string"
|
|
34203
|
+
},
|
|
34204
|
+
warnings: {
|
|
34205
|
+
description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
34206
|
+
items: {
|
|
34207
|
+
description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
34208
|
+
discriminator: { propertyName: "warning_code" },
|
|
34209
|
+
oneOf: [
|
|
34210
|
+
{
|
|
34211
|
+
description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
|
|
34212
|
+
properties: {
|
|
34213
|
+
created_at: {
|
|
34214
|
+
description: "Date and time at which Seam created the warning.",
|
|
34215
|
+
format: "date-time",
|
|
34216
|
+
type: "string"
|
|
34217
|
+
},
|
|
34218
|
+
message: {
|
|
34219
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
34220
|
+
type: "string"
|
|
34221
|
+
},
|
|
34222
|
+
warning_code: {
|
|
34223
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
34224
|
+
enum: ["being_deleted"],
|
|
34225
|
+
type: "string"
|
|
34226
|
+
}
|
|
34227
|
+
},
|
|
34228
|
+
required: [
|
|
34229
|
+
"created_at",
|
|
34230
|
+
"message",
|
|
34231
|
+
"warning_code"
|
|
34232
|
+
],
|
|
34233
|
+
type: "object"
|
|
34234
|
+
}
|
|
34235
|
+
]
|
|
34236
|
+
},
|
|
34237
|
+
type: "array"
|
|
34238
|
+
},
|
|
34239
|
+
workspace_id: {
|
|
34240
|
+
description: "ID of the Seam workspace associated with the access method.",
|
|
34241
|
+
format: "uuid",
|
|
34242
|
+
type: "string"
|
|
34243
|
+
}
|
|
34244
|
+
},
|
|
34245
|
+
required: [
|
|
34246
|
+
"workspace_id",
|
|
34247
|
+
"access_method_id",
|
|
34248
|
+
"display_name",
|
|
34249
|
+
"mode",
|
|
34250
|
+
"created_at",
|
|
34251
|
+
"issued_at",
|
|
34252
|
+
"is_issued",
|
|
34253
|
+
"warnings"
|
|
34254
|
+
],
|
|
34255
|
+
type: "object",
|
|
34256
|
+
"x-draft": "Early access.",
|
|
34257
|
+
"x-route-path": "/access_methods/unmanaged"
|
|
34258
|
+
},
|
|
33191
34259
|
type: "array"
|
|
33192
34260
|
},
|
|
33193
34261
|
ok: { type: "boolean" }
|
|
33194
34262
|
},
|
|
33195
|
-
required: ["
|
|
34263
|
+
required: ["access_methods", "ok"],
|
|
33196
34264
|
type: "object"
|
|
33197
34265
|
}
|
|
33198
34266
|
}
|
|
@@ -33207,38 +34275,45 @@ var openapi_default = {
|
|
|
33207
34275
|
{ console_session_with_workspace: [] },
|
|
33208
34276
|
{ api_key: [] }
|
|
33209
34277
|
],
|
|
33210
|
-
summary: "/
|
|
33211
|
-
tags: [
|
|
33212
|
-
"x-
|
|
34278
|
+
summary: "/access_methods/unmanaged/list",
|
|
34279
|
+
tags: [],
|
|
34280
|
+
"x-draft": "Early access.",
|
|
34281
|
+
"x-fern-sdk-group-name": ["access_methods", "unmanaged"],
|
|
33213
34282
|
"x-fern-sdk-method-name": "list",
|
|
33214
|
-
"x-fern-sdk-return-value": "
|
|
33215
|
-
"x-response-key": "
|
|
33216
|
-
"x-title": "List Access
|
|
34283
|
+
"x-fern-sdk-return-value": "access_methods",
|
|
34284
|
+
"x-response-key": "access_methods",
|
|
34285
|
+
"x-title": "List Unmanaged Access Methods"
|
|
33217
34286
|
},
|
|
33218
34287
|
post: {
|
|
33219
|
-
description: "
|
|
33220
|
-
operationId: "
|
|
34288
|
+
description: "Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.",
|
|
34289
|
+
operationId: "accessMethodsUnmanagedListPost",
|
|
33221
34290
|
requestBody: {
|
|
33222
34291
|
content: {
|
|
33223
34292
|
"application/json": {
|
|
33224
34293
|
schema: {
|
|
33225
34294
|
properties: {
|
|
33226
|
-
|
|
33227
|
-
description: "ID of
|
|
34295
|
+
access_grant_id: {
|
|
34296
|
+
description: "ID of Access Grant to list unmanaged access methods for.",
|
|
33228
34297
|
format: "uuid",
|
|
33229
34298
|
type: "string"
|
|
33230
34299
|
},
|
|
33231
|
-
|
|
33232
|
-
description: "ID of the
|
|
34300
|
+
acs_entrance_id: {
|
|
34301
|
+
description: "ID of the entrance for which you want to retrieve all unmanaged access methods.",
|
|
33233
34302
|
format: "uuid",
|
|
33234
34303
|
type: "string"
|
|
33235
34304
|
},
|
|
33236
|
-
|
|
33237
|
-
description: "ID of the
|
|
34305
|
+
device_id: {
|
|
34306
|
+
description: "ID of the device for which you want to retrieve all unmanaged access methods.",
|
|
34307
|
+
format: "uuid",
|
|
34308
|
+
type: "string"
|
|
34309
|
+
},
|
|
34310
|
+
space_id: {
|
|
34311
|
+
description: "ID of the space for which you want to retrieve all unmanaged access methods.",
|
|
33238
34312
|
format: "uuid",
|
|
33239
34313
|
type: "string"
|
|
33240
34314
|
}
|
|
33241
34315
|
},
|
|
34316
|
+
required: ["access_grant_id"],
|
|
33242
34317
|
type: "object"
|
|
33243
34318
|
}
|
|
33244
34319
|
}
|
|
@@ -33250,13 +34325,108 @@ var openapi_default = {
|
|
|
33250
34325
|
"application/json": {
|
|
33251
34326
|
schema: {
|
|
33252
34327
|
properties: {
|
|
33253
|
-
|
|
33254
|
-
items: {
|
|
34328
|
+
access_methods: {
|
|
34329
|
+
items: {
|
|
34330
|
+
description: "Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.",
|
|
34331
|
+
properties: {
|
|
34332
|
+
access_method_id: {
|
|
34333
|
+
description: "ID of the access method.",
|
|
34334
|
+
format: "uuid",
|
|
34335
|
+
type: "string"
|
|
34336
|
+
},
|
|
34337
|
+
code: {
|
|
34338
|
+
description: "The actual PIN code for code access methods.",
|
|
34339
|
+
nullable: true,
|
|
34340
|
+
type: "string"
|
|
34341
|
+
},
|
|
34342
|
+
created_at: {
|
|
34343
|
+
description: "Date and time at which the access method was created.",
|
|
34344
|
+
format: "date-time",
|
|
34345
|
+
type: "string"
|
|
34346
|
+
},
|
|
34347
|
+
display_name: {
|
|
34348
|
+
description: "Display name of the access method.",
|
|
34349
|
+
type: "string"
|
|
34350
|
+
},
|
|
34351
|
+
is_encoding_required: {
|
|
34352
|
+
description: "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.",
|
|
34353
|
+
type: "boolean"
|
|
34354
|
+
},
|
|
34355
|
+
is_issued: {
|
|
34356
|
+
description: "Indicates whether the access method has been issued.",
|
|
34357
|
+
type: "boolean"
|
|
34358
|
+
},
|
|
34359
|
+
issued_at: {
|
|
34360
|
+
description: "Date and time at which the access method was issued.",
|
|
34361
|
+
format: "date-time",
|
|
34362
|
+
nullable: true,
|
|
34363
|
+
type: "string"
|
|
34364
|
+
},
|
|
34365
|
+
mode: {
|
|
34366
|
+
description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
|
|
34367
|
+
enum: ["code", "card", "mobile_key"],
|
|
34368
|
+
type: "string"
|
|
34369
|
+
},
|
|
34370
|
+
warnings: {
|
|
34371
|
+
description: "Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
34372
|
+
items: {
|
|
34373
|
+
description: "Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).",
|
|
34374
|
+
discriminator: { propertyName: "warning_code" },
|
|
34375
|
+
oneOf: [
|
|
34376
|
+
{
|
|
34377
|
+
description: "Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.",
|
|
34378
|
+
properties: {
|
|
34379
|
+
created_at: {
|
|
34380
|
+
description: "Date and time at which Seam created the warning.",
|
|
34381
|
+
format: "date-time",
|
|
34382
|
+
type: "string"
|
|
34383
|
+
},
|
|
34384
|
+
message: {
|
|
34385
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
34386
|
+
type: "string"
|
|
34387
|
+
},
|
|
34388
|
+
warning_code: {
|
|
34389
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
34390
|
+
enum: ["being_deleted"],
|
|
34391
|
+
type: "string"
|
|
34392
|
+
}
|
|
34393
|
+
},
|
|
34394
|
+
required: [
|
|
34395
|
+
"created_at",
|
|
34396
|
+
"message",
|
|
34397
|
+
"warning_code"
|
|
34398
|
+
],
|
|
34399
|
+
type: "object"
|
|
34400
|
+
}
|
|
34401
|
+
]
|
|
34402
|
+
},
|
|
34403
|
+
type: "array"
|
|
34404
|
+
},
|
|
34405
|
+
workspace_id: {
|
|
34406
|
+
description: "ID of the Seam workspace associated with the access method.",
|
|
34407
|
+
format: "uuid",
|
|
34408
|
+
type: "string"
|
|
34409
|
+
}
|
|
34410
|
+
},
|
|
34411
|
+
required: [
|
|
34412
|
+
"workspace_id",
|
|
34413
|
+
"access_method_id",
|
|
34414
|
+
"display_name",
|
|
34415
|
+
"mode",
|
|
34416
|
+
"created_at",
|
|
34417
|
+
"issued_at",
|
|
34418
|
+
"is_issued",
|
|
34419
|
+
"warnings"
|
|
34420
|
+
],
|
|
34421
|
+
type: "object",
|
|
34422
|
+
"x-draft": "Early access.",
|
|
34423
|
+
"x-route-path": "/access_methods/unmanaged"
|
|
34424
|
+
},
|
|
33255
34425
|
type: "array"
|
|
33256
34426
|
},
|
|
33257
34427
|
ok: { type: "boolean" }
|
|
33258
34428
|
},
|
|
33259
|
-
required: ["
|
|
34429
|
+
required: ["access_methods", "ok"],
|
|
33260
34430
|
type: "object"
|
|
33261
34431
|
}
|
|
33262
34432
|
}
|
|
@@ -33271,44 +34441,54 @@ var openapi_default = {
|
|
|
33271
34441
|
{ console_session_with_workspace: [] },
|
|
33272
34442
|
{ api_key: [] }
|
|
33273
34443
|
],
|
|
33274
|
-
summary: "/
|
|
33275
|
-
tags: [
|
|
33276
|
-
"x-
|
|
34444
|
+
summary: "/access_methods/unmanaged/list",
|
|
34445
|
+
tags: [],
|
|
34446
|
+
"x-draft": "Early access.",
|
|
34447
|
+
"x-fern-sdk-group-name": ["access_methods", "unmanaged"],
|
|
33277
34448
|
"x-fern-sdk-method-name": "list",
|
|
33278
|
-
"x-fern-sdk-return-value": "
|
|
33279
|
-
"x-response-key": "
|
|
33280
|
-
"x-title": "List Access
|
|
34449
|
+
"x-fern-sdk-return-value": "access_methods",
|
|
34450
|
+
"x-response-key": "access_methods",
|
|
34451
|
+
"x-title": "List Unmanaged Access Methods"
|
|
33281
34452
|
}
|
|
33282
34453
|
},
|
|
33283
|
-
"/acs/access_groups/
|
|
33284
|
-
|
|
33285
|
-
description: "
|
|
33286
|
-
operationId: "
|
|
33287
|
-
|
|
33288
|
-
{
|
|
33289
|
-
|
|
33290
|
-
|
|
33291
|
-
|
|
33292
|
-
|
|
33293
|
-
|
|
33294
|
-
|
|
33295
|
-
|
|
34454
|
+
"/acs/access_groups/add_user": {
|
|
34455
|
+
post: {
|
|
34456
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34457
|
+
operationId: "acsAccessGroupsAddUserPost",
|
|
34458
|
+
requestBody: {
|
|
34459
|
+
content: {
|
|
34460
|
+
"application/json": {
|
|
34461
|
+
schema: {
|
|
34462
|
+
properties: {
|
|
34463
|
+
acs_access_group_id: {
|
|
34464
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
34465
|
+
format: "uuid",
|
|
34466
|
+
type: "string"
|
|
34467
|
+
},
|
|
34468
|
+
acs_user_id: {
|
|
34469
|
+
description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
|
|
34470
|
+
format: "uuid",
|
|
34471
|
+
type: "string"
|
|
34472
|
+
},
|
|
34473
|
+
user_identity_id: {
|
|
34474
|
+
description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
34475
|
+
format: "uuid",
|
|
34476
|
+
type: "string"
|
|
34477
|
+
}
|
|
34478
|
+
},
|
|
34479
|
+
required: ["acs_access_group_id"],
|
|
34480
|
+
type: "object"
|
|
34481
|
+
}
|
|
33296
34482
|
}
|
|
33297
34483
|
}
|
|
33298
|
-
|
|
34484
|
+
},
|
|
33299
34485
|
responses: {
|
|
33300
34486
|
200: {
|
|
33301
34487
|
content: {
|
|
33302
34488
|
"application/json": {
|
|
33303
34489
|
schema: {
|
|
33304
|
-
properties: {
|
|
33305
|
-
|
|
33306
|
-
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
33307
|
-
type: "array"
|
|
33308
|
-
},
|
|
33309
|
-
ok: { type: "boolean" }
|
|
33310
|
-
},
|
|
33311
|
-
required: ["acs_entrances", "ok"],
|
|
34490
|
+
properties: { ok: { type: "boolean" } },
|
|
34491
|
+
required: ["ok"],
|
|
33312
34492
|
type: "object"
|
|
33313
34493
|
}
|
|
33314
34494
|
}
|
|
@@ -33319,28 +34499,37 @@ var openapi_default = {
|
|
|
33319
34499
|
401: { description: "Unauthorized" }
|
|
33320
34500
|
},
|
|
33321
34501
|
security: [
|
|
33322
|
-
{ api_key: [] },
|
|
33323
34502
|
{ pat_with_workspace: [] },
|
|
33324
|
-
{ console_session_with_workspace: [] }
|
|
34503
|
+
{ console_session_with_workspace: [] },
|
|
34504
|
+
{ api_key: [] }
|
|
33325
34505
|
],
|
|
33326
|
-
summary: "/acs/access_groups/
|
|
34506
|
+
summary: "/acs/access_groups/add_user",
|
|
33327
34507
|
tags: ["/acs"],
|
|
33328
34508
|
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
33329
|
-
"x-fern-sdk-method-name": "
|
|
33330
|
-
"x-
|
|
33331
|
-
"x-
|
|
33332
|
-
"x-title": "List Entrances Accessible to an Access Group"
|
|
34509
|
+
"x-fern-sdk-method-name": "add_user",
|
|
34510
|
+
"x-response-key": null,
|
|
34511
|
+
"x-title": "Add an ACS User to an Access Group"
|
|
33333
34512
|
},
|
|
33334
|
-
|
|
33335
|
-
description: "
|
|
33336
|
-
operationId: "
|
|
34513
|
+
put: {
|
|
34514
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34515
|
+
operationId: "acsAccessGroupsAddUserPut",
|
|
33337
34516
|
requestBody: {
|
|
33338
34517
|
content: {
|
|
33339
34518
|
"application/json": {
|
|
33340
34519
|
schema: {
|
|
33341
34520
|
properties: {
|
|
33342
34521
|
acs_access_group_id: {
|
|
33343
|
-
description: "ID of the access group
|
|
34522
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
34523
|
+
format: "uuid",
|
|
34524
|
+
type: "string"
|
|
34525
|
+
},
|
|
34526
|
+
acs_user_id: {
|
|
34527
|
+
description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
|
|
34528
|
+
format: "uuid",
|
|
34529
|
+
type: "string"
|
|
34530
|
+
},
|
|
34531
|
+
user_identity_id: {
|
|
34532
|
+
description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
33344
34533
|
format: "uuid",
|
|
33345
34534
|
type: "string"
|
|
33346
34535
|
}
|
|
@@ -33356,14 +34545,8 @@ var openapi_default = {
|
|
|
33356
34545
|
content: {
|
|
33357
34546
|
"application/json": {
|
|
33358
34547
|
schema: {
|
|
33359
|
-
properties: {
|
|
33360
|
-
|
|
33361
|
-
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
33362
|
-
type: "array"
|
|
33363
|
-
},
|
|
33364
|
-
ok: { type: "boolean" }
|
|
33365
|
-
},
|
|
33366
|
-
required: ["acs_entrances", "ok"],
|
|
34548
|
+
properties: { ok: { type: "boolean" } },
|
|
34549
|
+
required: ["ok"],
|
|
33367
34550
|
type: "object"
|
|
33368
34551
|
}
|
|
33369
34552
|
}
|
|
@@ -33374,22 +34557,366 @@ var openapi_default = {
|
|
|
33374
34557
|
401: { description: "Unauthorized" }
|
|
33375
34558
|
},
|
|
33376
34559
|
security: [
|
|
33377
|
-
{ api_key: [] },
|
|
33378
34560
|
{ pat_with_workspace: [] },
|
|
33379
|
-
{ console_session_with_workspace: [] }
|
|
34561
|
+
{ console_session_with_workspace: [] },
|
|
34562
|
+
{ api_key: [] }
|
|
33380
34563
|
],
|
|
33381
|
-
summary: "/acs/access_groups/
|
|
34564
|
+
summary: "/acs/access_groups/add_user",
|
|
33382
34565
|
tags: ["/acs"],
|
|
33383
34566
|
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
33384
|
-
"x-fern-sdk-method-name": "
|
|
33385
|
-
"x-
|
|
33386
|
-
"x-
|
|
33387
|
-
"x-title": "List Entrances Accessible to an Access Group"
|
|
34567
|
+
"x-fern-sdk-method-name": "add_user",
|
|
34568
|
+
"x-response-key": null,
|
|
34569
|
+
"x-title": "Add an ACS User to an Access Group"
|
|
33388
34570
|
}
|
|
33389
34571
|
},
|
|
33390
|
-
"/acs/access_groups/
|
|
34572
|
+
"/acs/access_groups/get": {
|
|
33391
34573
|
get: {
|
|
33392
|
-
description: "Returns a
|
|
34574
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34575
|
+
operationId: "acsAccessGroupsGetGet",
|
|
34576
|
+
parameters: [
|
|
34577
|
+
{
|
|
34578
|
+
in: "query",
|
|
34579
|
+
name: "acs_access_group_id",
|
|
34580
|
+
required: true,
|
|
34581
|
+
schema: {
|
|
34582
|
+
description: "ID of the access group that you want to get.",
|
|
34583
|
+
format: "uuid",
|
|
34584
|
+
type: "string"
|
|
34585
|
+
}
|
|
34586
|
+
}
|
|
34587
|
+
],
|
|
34588
|
+
responses: {
|
|
34589
|
+
200: {
|
|
34590
|
+
content: {
|
|
34591
|
+
"application/json": {
|
|
34592
|
+
schema: {
|
|
34593
|
+
properties: {
|
|
34594
|
+
acs_access_group: {
|
|
34595
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
34596
|
+
},
|
|
34597
|
+
ok: { type: "boolean" }
|
|
34598
|
+
},
|
|
34599
|
+
required: ["acs_access_group", "ok"],
|
|
34600
|
+
type: "object"
|
|
34601
|
+
}
|
|
34602
|
+
}
|
|
34603
|
+
},
|
|
34604
|
+
description: "OK"
|
|
34605
|
+
},
|
|
34606
|
+
400: { description: "Bad Request" },
|
|
34607
|
+
401: { description: "Unauthorized" }
|
|
34608
|
+
},
|
|
34609
|
+
security: [
|
|
34610
|
+
{ pat_with_workspace: [] },
|
|
34611
|
+
{ console_session_with_workspace: [] },
|
|
34612
|
+
{ api_key: [] }
|
|
34613
|
+
],
|
|
34614
|
+
summary: "/acs/access_groups/get",
|
|
34615
|
+
tags: ["/acs"],
|
|
34616
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
34617
|
+
"x-fern-sdk-method-name": "get",
|
|
34618
|
+
"x-fern-sdk-return-value": "acs_access_group",
|
|
34619
|
+
"x-response-key": "acs_access_group",
|
|
34620
|
+
"x-title": "Get an Access Group"
|
|
34621
|
+
},
|
|
34622
|
+
post: {
|
|
34623
|
+
description: "Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34624
|
+
operationId: "acsAccessGroupsGetPost",
|
|
34625
|
+
requestBody: {
|
|
34626
|
+
content: {
|
|
34627
|
+
"application/json": {
|
|
34628
|
+
schema: {
|
|
34629
|
+
properties: {
|
|
34630
|
+
acs_access_group_id: {
|
|
34631
|
+
description: "ID of the access group that you want to get.",
|
|
34632
|
+
format: "uuid",
|
|
34633
|
+
type: "string"
|
|
34634
|
+
}
|
|
34635
|
+
},
|
|
34636
|
+
required: ["acs_access_group_id"],
|
|
34637
|
+
type: "object"
|
|
34638
|
+
}
|
|
34639
|
+
}
|
|
34640
|
+
}
|
|
34641
|
+
},
|
|
34642
|
+
responses: {
|
|
34643
|
+
200: {
|
|
34644
|
+
content: {
|
|
34645
|
+
"application/json": {
|
|
34646
|
+
schema: {
|
|
34647
|
+
properties: {
|
|
34648
|
+
acs_access_group: {
|
|
34649
|
+
$ref: "#/components/schemas/acs_access_group"
|
|
34650
|
+
},
|
|
34651
|
+
ok: { type: "boolean" }
|
|
34652
|
+
},
|
|
34653
|
+
required: ["acs_access_group", "ok"],
|
|
34654
|
+
type: "object"
|
|
34655
|
+
}
|
|
34656
|
+
}
|
|
34657
|
+
},
|
|
34658
|
+
description: "OK"
|
|
34659
|
+
},
|
|
34660
|
+
400: { description: "Bad Request" },
|
|
34661
|
+
401: { description: "Unauthorized" }
|
|
34662
|
+
},
|
|
34663
|
+
security: [
|
|
34664
|
+
{ pat_with_workspace: [] },
|
|
34665
|
+
{ console_session_with_workspace: [] },
|
|
34666
|
+
{ api_key: [] }
|
|
34667
|
+
],
|
|
34668
|
+
summary: "/acs/access_groups/get",
|
|
34669
|
+
tags: ["/acs"],
|
|
34670
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
34671
|
+
"x-fern-sdk-method-name": "get",
|
|
34672
|
+
"x-fern-sdk-return-value": "acs_access_group",
|
|
34673
|
+
"x-response-key": "acs_access_group",
|
|
34674
|
+
"x-title": "Get an Access Group"
|
|
34675
|
+
}
|
|
34676
|
+
},
|
|
34677
|
+
"/acs/access_groups/list": {
|
|
34678
|
+
get: {
|
|
34679
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34680
|
+
operationId: "acsAccessGroupsListGet",
|
|
34681
|
+
parameters: [
|
|
34682
|
+
{
|
|
34683
|
+
in: "query",
|
|
34684
|
+
name: "acs_system_id",
|
|
34685
|
+
schema: {
|
|
34686
|
+
description: "ID of the access system for which you want to retrieve all access groups.",
|
|
34687
|
+
format: "uuid",
|
|
34688
|
+
type: "string"
|
|
34689
|
+
}
|
|
34690
|
+
},
|
|
34691
|
+
{
|
|
34692
|
+
in: "query",
|
|
34693
|
+
name: "acs_user_id",
|
|
34694
|
+
schema: {
|
|
34695
|
+
description: "ID of the access system user for which you want to retrieve all access groups.",
|
|
34696
|
+
format: "uuid",
|
|
34697
|
+
type: "string"
|
|
34698
|
+
}
|
|
34699
|
+
},
|
|
34700
|
+
{
|
|
34701
|
+
in: "query",
|
|
34702
|
+
name: "user_identity_id",
|
|
34703
|
+
schema: {
|
|
34704
|
+
description: "ID of the user identity for which you want to retrieve all access groups.",
|
|
34705
|
+
format: "uuid",
|
|
34706
|
+
type: "string"
|
|
34707
|
+
}
|
|
34708
|
+
}
|
|
34709
|
+
],
|
|
34710
|
+
responses: {
|
|
34711
|
+
200: {
|
|
34712
|
+
content: {
|
|
34713
|
+
"application/json": {
|
|
34714
|
+
schema: {
|
|
34715
|
+
properties: {
|
|
34716
|
+
acs_access_groups: {
|
|
34717
|
+
items: { $ref: "#/components/schemas/acs_access_group" },
|
|
34718
|
+
type: "array"
|
|
34719
|
+
},
|
|
34720
|
+
ok: { type: "boolean" }
|
|
34721
|
+
},
|
|
34722
|
+
required: ["acs_access_groups", "ok"],
|
|
34723
|
+
type: "object"
|
|
34724
|
+
}
|
|
34725
|
+
}
|
|
34726
|
+
},
|
|
34727
|
+
description: "OK"
|
|
34728
|
+
},
|
|
34729
|
+
400: { description: "Bad Request" },
|
|
34730
|
+
401: { description: "Unauthorized" }
|
|
34731
|
+
},
|
|
34732
|
+
security: [
|
|
34733
|
+
{ pat_with_workspace: [] },
|
|
34734
|
+
{ console_session_with_workspace: [] },
|
|
34735
|
+
{ api_key: [] }
|
|
34736
|
+
],
|
|
34737
|
+
summary: "/acs/access_groups/list",
|
|
34738
|
+
tags: ["/acs"],
|
|
34739
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
34740
|
+
"x-fern-sdk-method-name": "list",
|
|
34741
|
+
"x-fern-sdk-return-value": "acs_access_groups",
|
|
34742
|
+
"x-response-key": "acs_access_groups",
|
|
34743
|
+
"x-title": "List Access Groups"
|
|
34744
|
+
},
|
|
34745
|
+
post: {
|
|
34746
|
+
description: "Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34747
|
+
operationId: "acsAccessGroupsListPost",
|
|
34748
|
+
requestBody: {
|
|
34749
|
+
content: {
|
|
34750
|
+
"application/json": {
|
|
34751
|
+
schema: {
|
|
34752
|
+
properties: {
|
|
34753
|
+
acs_system_id: {
|
|
34754
|
+
description: "ID of the access system for which you want to retrieve all access groups.",
|
|
34755
|
+
format: "uuid",
|
|
34756
|
+
type: "string"
|
|
34757
|
+
},
|
|
34758
|
+
acs_user_id: {
|
|
34759
|
+
description: "ID of the access system user for which you want to retrieve all access groups.",
|
|
34760
|
+
format: "uuid",
|
|
34761
|
+
type: "string"
|
|
34762
|
+
},
|
|
34763
|
+
user_identity_id: {
|
|
34764
|
+
description: "ID of the user identity for which you want to retrieve all access groups.",
|
|
34765
|
+
format: "uuid",
|
|
34766
|
+
type: "string"
|
|
34767
|
+
}
|
|
34768
|
+
},
|
|
34769
|
+
type: "object"
|
|
34770
|
+
}
|
|
34771
|
+
}
|
|
34772
|
+
}
|
|
34773
|
+
},
|
|
34774
|
+
responses: {
|
|
34775
|
+
200: {
|
|
34776
|
+
content: {
|
|
34777
|
+
"application/json": {
|
|
34778
|
+
schema: {
|
|
34779
|
+
properties: {
|
|
34780
|
+
acs_access_groups: {
|
|
34781
|
+
items: { $ref: "#/components/schemas/acs_access_group" },
|
|
34782
|
+
type: "array"
|
|
34783
|
+
},
|
|
34784
|
+
ok: { type: "boolean" }
|
|
34785
|
+
},
|
|
34786
|
+
required: ["acs_access_groups", "ok"],
|
|
34787
|
+
type: "object"
|
|
34788
|
+
}
|
|
34789
|
+
}
|
|
34790
|
+
},
|
|
34791
|
+
description: "OK"
|
|
34792
|
+
},
|
|
34793
|
+
400: { description: "Bad Request" },
|
|
34794
|
+
401: { description: "Unauthorized" }
|
|
34795
|
+
},
|
|
34796
|
+
security: [
|
|
34797
|
+
{ pat_with_workspace: [] },
|
|
34798
|
+
{ console_session_with_workspace: [] },
|
|
34799
|
+
{ api_key: [] }
|
|
34800
|
+
],
|
|
34801
|
+
summary: "/acs/access_groups/list",
|
|
34802
|
+
tags: ["/acs"],
|
|
34803
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
34804
|
+
"x-fern-sdk-method-name": "list",
|
|
34805
|
+
"x-fern-sdk-return-value": "acs_access_groups",
|
|
34806
|
+
"x-response-key": "acs_access_groups",
|
|
34807
|
+
"x-title": "List Access Groups"
|
|
34808
|
+
}
|
|
34809
|
+
},
|
|
34810
|
+
"/acs/access_groups/list_accessible_entrances": {
|
|
34811
|
+
get: {
|
|
34812
|
+
description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34813
|
+
operationId: "acsAccessGroupsListAccessibleEntrancesGet",
|
|
34814
|
+
parameters: [
|
|
34815
|
+
{
|
|
34816
|
+
in: "query",
|
|
34817
|
+
name: "acs_access_group_id",
|
|
34818
|
+
required: true,
|
|
34819
|
+
schema: {
|
|
34820
|
+
description: "ID of the access group for which you want to retrieve all accessible entrances.",
|
|
34821
|
+
format: "uuid",
|
|
34822
|
+
type: "string"
|
|
34823
|
+
}
|
|
34824
|
+
}
|
|
34825
|
+
],
|
|
34826
|
+
responses: {
|
|
34827
|
+
200: {
|
|
34828
|
+
content: {
|
|
34829
|
+
"application/json": {
|
|
34830
|
+
schema: {
|
|
34831
|
+
properties: {
|
|
34832
|
+
acs_entrances: {
|
|
34833
|
+
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
34834
|
+
type: "array"
|
|
34835
|
+
},
|
|
34836
|
+
ok: { type: "boolean" }
|
|
34837
|
+
},
|
|
34838
|
+
required: ["acs_entrances", "ok"],
|
|
34839
|
+
type: "object"
|
|
34840
|
+
}
|
|
34841
|
+
}
|
|
34842
|
+
},
|
|
34843
|
+
description: "OK"
|
|
34844
|
+
},
|
|
34845
|
+
400: { description: "Bad Request" },
|
|
34846
|
+
401: { description: "Unauthorized" }
|
|
34847
|
+
},
|
|
34848
|
+
security: [
|
|
34849
|
+
{ api_key: [] },
|
|
34850
|
+
{ pat_with_workspace: [] },
|
|
34851
|
+
{ console_session_with_workspace: [] }
|
|
34852
|
+
],
|
|
34853
|
+
summary: "/acs/access_groups/list_accessible_entrances",
|
|
34854
|
+
tags: ["/acs"],
|
|
34855
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
34856
|
+
"x-fern-sdk-method-name": "list_accessible_entrances",
|
|
34857
|
+
"x-fern-sdk-return-value": "acs_entrances",
|
|
34858
|
+
"x-response-key": "acs_entrances",
|
|
34859
|
+
"x-title": "List Entrances Accessible to an Access Group"
|
|
34860
|
+
},
|
|
34861
|
+
post: {
|
|
34862
|
+
description: "Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
34863
|
+
operationId: "acsAccessGroupsListAccessibleEntrancesPost",
|
|
34864
|
+
requestBody: {
|
|
34865
|
+
content: {
|
|
34866
|
+
"application/json": {
|
|
34867
|
+
schema: {
|
|
34868
|
+
properties: {
|
|
34869
|
+
acs_access_group_id: {
|
|
34870
|
+
description: "ID of the access group for which you want to retrieve all accessible entrances.",
|
|
34871
|
+
format: "uuid",
|
|
34872
|
+
type: "string"
|
|
34873
|
+
}
|
|
34874
|
+
},
|
|
34875
|
+
required: ["acs_access_group_id"],
|
|
34876
|
+
type: "object"
|
|
34877
|
+
}
|
|
34878
|
+
}
|
|
34879
|
+
}
|
|
34880
|
+
},
|
|
34881
|
+
responses: {
|
|
34882
|
+
200: {
|
|
34883
|
+
content: {
|
|
34884
|
+
"application/json": {
|
|
34885
|
+
schema: {
|
|
34886
|
+
properties: {
|
|
34887
|
+
acs_entrances: {
|
|
34888
|
+
items: { $ref: "#/components/schemas/acs_entrance" },
|
|
34889
|
+
type: "array"
|
|
34890
|
+
},
|
|
34891
|
+
ok: { type: "boolean" }
|
|
34892
|
+
},
|
|
34893
|
+
required: ["acs_entrances", "ok"],
|
|
34894
|
+
type: "object"
|
|
34895
|
+
}
|
|
34896
|
+
}
|
|
34897
|
+
},
|
|
34898
|
+
description: "OK"
|
|
34899
|
+
},
|
|
34900
|
+
400: { description: "Bad Request" },
|
|
34901
|
+
401: { description: "Unauthorized" }
|
|
34902
|
+
},
|
|
34903
|
+
security: [
|
|
34904
|
+
{ api_key: [] },
|
|
34905
|
+
{ pat_with_workspace: [] },
|
|
34906
|
+
{ console_session_with_workspace: [] }
|
|
34907
|
+
],
|
|
34908
|
+
summary: "/acs/access_groups/list_accessible_entrances",
|
|
34909
|
+
tags: ["/acs"],
|
|
34910
|
+
"x-fern-sdk-group-name": ["acs", "access_groups"],
|
|
34911
|
+
"x-fern-sdk-method-name": "list_accessible_entrances",
|
|
34912
|
+
"x-fern-sdk-return-value": "acs_entrances",
|
|
34913
|
+
"x-response-key": "acs_entrances",
|
|
34914
|
+
"x-title": "List Entrances Accessible to an Access Group"
|
|
34915
|
+
}
|
|
34916
|
+
},
|
|
34917
|
+
"/acs/access_groups/list_users": {
|
|
34918
|
+
get: {
|
|
34919
|
+
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
33393
34920
|
operationId: "acsAccessGroupsListUsersGet",
|
|
33394
34921
|
parameters: [
|
|
33395
34922
|
{
|
|
@@ -59658,6 +61185,872 @@ var openapi_default = {
|
|
|
59658
61185
|
"x-title": "Revoke Access to a Device from a User Identity"
|
|
59659
61186
|
}
|
|
59660
61187
|
},
|
|
61188
|
+
"/user_identities/unmanaged/get": {
|
|
61189
|
+
get: {
|
|
61190
|
+
description: "Returns a specified unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).",
|
|
61191
|
+
operationId: "userIdentitiesUnmanagedGetGet",
|
|
61192
|
+
parameters: [
|
|
61193
|
+
{
|
|
61194
|
+
in: "query",
|
|
61195
|
+
name: "user_identity_id",
|
|
61196
|
+
required: true,
|
|
61197
|
+
schema: {
|
|
61198
|
+
description: "ID of the unmanaged user identity that you want to get.",
|
|
61199
|
+
format: "uuid",
|
|
61200
|
+
type: "string"
|
|
61201
|
+
}
|
|
61202
|
+
}
|
|
61203
|
+
],
|
|
61204
|
+
responses: {
|
|
61205
|
+
200: {
|
|
61206
|
+
content: {
|
|
61207
|
+
"application/json": {
|
|
61208
|
+
schema: {
|
|
61209
|
+
properties: {
|
|
61210
|
+
ok: { type: "boolean" },
|
|
61211
|
+
user_identity: {
|
|
61212
|
+
description: "Represents an unmanaged user identity. Unmanaged user identities do not have keys.",
|
|
61213
|
+
properties: {
|
|
61214
|
+
acs_user_ids: {
|
|
61215
|
+
description: "Array of access system user IDs associated with the user identity.",
|
|
61216
|
+
items: { format: "uuid", type: "string" },
|
|
61217
|
+
type: "array"
|
|
61218
|
+
},
|
|
61219
|
+
created_at: {
|
|
61220
|
+
description: "Date and time at which the user identity was created.",
|
|
61221
|
+
format: "date-time",
|
|
61222
|
+
type: "string"
|
|
61223
|
+
},
|
|
61224
|
+
display_name: { minLength: 1, type: "string" },
|
|
61225
|
+
email_address: {
|
|
61226
|
+
description: "Unique email address for the user identity.",
|
|
61227
|
+
format: "email",
|
|
61228
|
+
nullable: true,
|
|
61229
|
+
type: "string"
|
|
61230
|
+
},
|
|
61231
|
+
errors: {
|
|
61232
|
+
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.',
|
|
61233
|
+
items: {
|
|
61234
|
+
description: "Errors associated with the user identity.",
|
|
61235
|
+
discriminator: { propertyName: "error_code" },
|
|
61236
|
+
oneOf: [
|
|
61237
|
+
{
|
|
61238
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
61239
|
+
properties: {
|
|
61240
|
+
acs_system_id: {
|
|
61241
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
61242
|
+
format: "uuid",
|
|
61243
|
+
type: "string"
|
|
61244
|
+
},
|
|
61245
|
+
acs_user_id: {
|
|
61246
|
+
description: "ID of the access system user that has an issue.",
|
|
61247
|
+
format: "uuid",
|
|
61248
|
+
type: "string"
|
|
61249
|
+
},
|
|
61250
|
+
created_at: {
|
|
61251
|
+
description: "Date and time at which Seam created the error.",
|
|
61252
|
+
format: "date-time",
|
|
61253
|
+
type: "string"
|
|
61254
|
+
},
|
|
61255
|
+
error_code: {
|
|
61256
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
61257
|
+
enum: ["issue_with_acs_user"],
|
|
61258
|
+
type: "string"
|
|
61259
|
+
},
|
|
61260
|
+
message: {
|
|
61261
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
61262
|
+
type: "string"
|
|
61263
|
+
}
|
|
61264
|
+
},
|
|
61265
|
+
required: [
|
|
61266
|
+
"created_at",
|
|
61267
|
+
"message",
|
|
61268
|
+
"error_code",
|
|
61269
|
+
"acs_user_id",
|
|
61270
|
+
"acs_system_id"
|
|
61271
|
+
],
|
|
61272
|
+
type: "object"
|
|
61273
|
+
}
|
|
61274
|
+
]
|
|
61275
|
+
},
|
|
61276
|
+
type: "array"
|
|
61277
|
+
},
|
|
61278
|
+
full_name: {
|
|
61279
|
+
minLength: 1,
|
|
61280
|
+
nullable: true,
|
|
61281
|
+
type: "string"
|
|
61282
|
+
},
|
|
61283
|
+
phone_number: {
|
|
61284
|
+
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
61285
|
+
nullable: true,
|
|
61286
|
+
type: "string"
|
|
61287
|
+
},
|
|
61288
|
+
user_identity_id: {
|
|
61289
|
+
description: "ID of the user identity.",
|
|
61290
|
+
format: "uuid",
|
|
61291
|
+
type: "string"
|
|
61292
|
+
},
|
|
61293
|
+
warnings: {
|
|
61294
|
+
description: '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.',
|
|
61295
|
+
items: {
|
|
61296
|
+
description: "Warnings associated with the user identity.",
|
|
61297
|
+
discriminator: { propertyName: "warning_code" },
|
|
61298
|
+
oneOf: [
|
|
61299
|
+
{
|
|
61300
|
+
description: "Indicates that the user identity is currently being deleted.",
|
|
61301
|
+
properties: {
|
|
61302
|
+
created_at: {
|
|
61303
|
+
description: "Date and time at which Seam created the warning.",
|
|
61304
|
+
format: "date-time",
|
|
61305
|
+
type: "string"
|
|
61306
|
+
},
|
|
61307
|
+
message: {
|
|
61308
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61309
|
+
type: "string"
|
|
61310
|
+
},
|
|
61311
|
+
warning_code: {
|
|
61312
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61313
|
+
enum: ["being_deleted"],
|
|
61314
|
+
type: "string"
|
|
61315
|
+
}
|
|
61316
|
+
},
|
|
61317
|
+
required: [
|
|
61318
|
+
"created_at",
|
|
61319
|
+
"message",
|
|
61320
|
+
"warning_code"
|
|
61321
|
+
],
|
|
61322
|
+
type: "object"
|
|
61323
|
+
},
|
|
61324
|
+
{
|
|
61325
|
+
description: "Indicates that the ACS user's profile does not match the user identity's profile",
|
|
61326
|
+
properties: {
|
|
61327
|
+
created_at: {
|
|
61328
|
+
description: "Date and time at which Seam created the warning.",
|
|
61329
|
+
format: "date-time",
|
|
61330
|
+
type: "string"
|
|
61331
|
+
},
|
|
61332
|
+
message: {
|
|
61333
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61334
|
+
type: "string"
|
|
61335
|
+
},
|
|
61336
|
+
warning_code: {
|
|
61337
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61338
|
+
enum: [
|
|
61339
|
+
"acs_user_profile_does_not_match_user_identity"
|
|
61340
|
+
],
|
|
61341
|
+
type: "string"
|
|
61342
|
+
}
|
|
61343
|
+
},
|
|
61344
|
+
required: [
|
|
61345
|
+
"created_at",
|
|
61346
|
+
"message",
|
|
61347
|
+
"warning_code"
|
|
61348
|
+
],
|
|
61349
|
+
type: "object"
|
|
61350
|
+
}
|
|
61351
|
+
]
|
|
61352
|
+
},
|
|
61353
|
+
type: "array"
|
|
61354
|
+
},
|
|
61355
|
+
workspace_id: {
|
|
61356
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
|
|
61357
|
+
format: "uuid",
|
|
61358
|
+
type: "string"
|
|
61359
|
+
}
|
|
61360
|
+
},
|
|
61361
|
+
required: [
|
|
61362
|
+
"user_identity_id",
|
|
61363
|
+
"email_address",
|
|
61364
|
+
"phone_number",
|
|
61365
|
+
"display_name",
|
|
61366
|
+
"full_name",
|
|
61367
|
+
"created_at",
|
|
61368
|
+
"workspace_id",
|
|
61369
|
+
"errors",
|
|
61370
|
+
"warnings",
|
|
61371
|
+
"acs_user_ids"
|
|
61372
|
+
],
|
|
61373
|
+
type: "object",
|
|
61374
|
+
"x-draft": "Early access.",
|
|
61375
|
+
"x-route-path": "/user_identities/unmanaged"
|
|
61376
|
+
}
|
|
61377
|
+
},
|
|
61378
|
+
required: ["user_identity", "ok"],
|
|
61379
|
+
type: "object"
|
|
61380
|
+
}
|
|
61381
|
+
}
|
|
61382
|
+
},
|
|
61383
|
+
description: "OK"
|
|
61384
|
+
},
|
|
61385
|
+
400: { description: "Bad Request" },
|
|
61386
|
+
401: { description: "Unauthorized" }
|
|
61387
|
+
},
|
|
61388
|
+
security: [
|
|
61389
|
+
{ api_key: [] },
|
|
61390
|
+
{ pat_with_workspace: [] },
|
|
61391
|
+
{ console_session_with_workspace: [] }
|
|
61392
|
+
],
|
|
61393
|
+
summary: "/user_identities/unmanaged/get",
|
|
61394
|
+
tags: ["/user_identities"],
|
|
61395
|
+
"x-fern-sdk-group-name": ["user_identities", "unmanaged"],
|
|
61396
|
+
"x-fern-sdk-method-name": "get",
|
|
61397
|
+
"x-fern-sdk-return-value": "user_identity",
|
|
61398
|
+
"x-response-key": "user_identity",
|
|
61399
|
+
"x-title": "Get an Unmanaged User Identity"
|
|
61400
|
+
},
|
|
61401
|
+
post: {
|
|
61402
|
+
description: "Returns a specified unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).",
|
|
61403
|
+
operationId: "userIdentitiesUnmanagedGetPost",
|
|
61404
|
+
requestBody: {
|
|
61405
|
+
content: {
|
|
61406
|
+
"application/json": {
|
|
61407
|
+
schema: {
|
|
61408
|
+
properties: {
|
|
61409
|
+
user_identity_id: {
|
|
61410
|
+
description: "ID of the unmanaged user identity that you want to get.",
|
|
61411
|
+
format: "uuid",
|
|
61412
|
+
type: "string"
|
|
61413
|
+
}
|
|
61414
|
+
},
|
|
61415
|
+
required: ["user_identity_id"],
|
|
61416
|
+
type: "object"
|
|
61417
|
+
}
|
|
61418
|
+
}
|
|
61419
|
+
}
|
|
61420
|
+
},
|
|
61421
|
+
responses: {
|
|
61422
|
+
200: {
|
|
61423
|
+
content: {
|
|
61424
|
+
"application/json": {
|
|
61425
|
+
schema: {
|
|
61426
|
+
properties: {
|
|
61427
|
+
ok: { type: "boolean" },
|
|
61428
|
+
user_identity: {
|
|
61429
|
+
description: "Represents an unmanaged user identity. Unmanaged user identities do not have keys.",
|
|
61430
|
+
properties: {
|
|
61431
|
+
acs_user_ids: {
|
|
61432
|
+
description: "Array of access system user IDs associated with the user identity.",
|
|
61433
|
+
items: { format: "uuid", type: "string" },
|
|
61434
|
+
type: "array"
|
|
61435
|
+
},
|
|
61436
|
+
created_at: {
|
|
61437
|
+
description: "Date and time at which the user identity was created.",
|
|
61438
|
+
format: "date-time",
|
|
61439
|
+
type: "string"
|
|
61440
|
+
},
|
|
61441
|
+
display_name: { minLength: 1, type: "string" },
|
|
61442
|
+
email_address: {
|
|
61443
|
+
description: "Unique email address for the user identity.",
|
|
61444
|
+
format: "email",
|
|
61445
|
+
nullable: true,
|
|
61446
|
+
type: "string"
|
|
61447
|
+
},
|
|
61448
|
+
errors: {
|
|
61449
|
+
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.',
|
|
61450
|
+
items: {
|
|
61451
|
+
description: "Errors associated with the user identity.",
|
|
61452
|
+
discriminator: { propertyName: "error_code" },
|
|
61453
|
+
oneOf: [
|
|
61454
|
+
{
|
|
61455
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
61456
|
+
properties: {
|
|
61457
|
+
acs_system_id: {
|
|
61458
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
61459
|
+
format: "uuid",
|
|
61460
|
+
type: "string"
|
|
61461
|
+
},
|
|
61462
|
+
acs_user_id: {
|
|
61463
|
+
description: "ID of the access system user that has an issue.",
|
|
61464
|
+
format: "uuid",
|
|
61465
|
+
type: "string"
|
|
61466
|
+
},
|
|
61467
|
+
created_at: {
|
|
61468
|
+
description: "Date and time at which Seam created the error.",
|
|
61469
|
+
format: "date-time",
|
|
61470
|
+
type: "string"
|
|
61471
|
+
},
|
|
61472
|
+
error_code: {
|
|
61473
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
61474
|
+
enum: ["issue_with_acs_user"],
|
|
61475
|
+
type: "string"
|
|
61476
|
+
},
|
|
61477
|
+
message: {
|
|
61478
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
61479
|
+
type: "string"
|
|
61480
|
+
}
|
|
61481
|
+
},
|
|
61482
|
+
required: [
|
|
61483
|
+
"created_at",
|
|
61484
|
+
"message",
|
|
61485
|
+
"error_code",
|
|
61486
|
+
"acs_user_id",
|
|
61487
|
+
"acs_system_id"
|
|
61488
|
+
],
|
|
61489
|
+
type: "object"
|
|
61490
|
+
}
|
|
61491
|
+
]
|
|
61492
|
+
},
|
|
61493
|
+
type: "array"
|
|
61494
|
+
},
|
|
61495
|
+
full_name: {
|
|
61496
|
+
minLength: 1,
|
|
61497
|
+
nullable: true,
|
|
61498
|
+
type: "string"
|
|
61499
|
+
},
|
|
61500
|
+
phone_number: {
|
|
61501
|
+
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
61502
|
+
nullable: true,
|
|
61503
|
+
type: "string"
|
|
61504
|
+
},
|
|
61505
|
+
user_identity_id: {
|
|
61506
|
+
description: "ID of the user identity.",
|
|
61507
|
+
format: "uuid",
|
|
61508
|
+
type: "string"
|
|
61509
|
+
},
|
|
61510
|
+
warnings: {
|
|
61511
|
+
description: '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.',
|
|
61512
|
+
items: {
|
|
61513
|
+
description: "Warnings associated with the user identity.",
|
|
61514
|
+
discriminator: { propertyName: "warning_code" },
|
|
61515
|
+
oneOf: [
|
|
61516
|
+
{
|
|
61517
|
+
description: "Indicates that the user identity is currently being deleted.",
|
|
61518
|
+
properties: {
|
|
61519
|
+
created_at: {
|
|
61520
|
+
description: "Date and time at which Seam created the warning.",
|
|
61521
|
+
format: "date-time",
|
|
61522
|
+
type: "string"
|
|
61523
|
+
},
|
|
61524
|
+
message: {
|
|
61525
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61526
|
+
type: "string"
|
|
61527
|
+
},
|
|
61528
|
+
warning_code: {
|
|
61529
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61530
|
+
enum: ["being_deleted"],
|
|
61531
|
+
type: "string"
|
|
61532
|
+
}
|
|
61533
|
+
},
|
|
61534
|
+
required: [
|
|
61535
|
+
"created_at",
|
|
61536
|
+
"message",
|
|
61537
|
+
"warning_code"
|
|
61538
|
+
],
|
|
61539
|
+
type: "object"
|
|
61540
|
+
},
|
|
61541
|
+
{
|
|
61542
|
+
description: "Indicates that the ACS user's profile does not match the user identity's profile",
|
|
61543
|
+
properties: {
|
|
61544
|
+
created_at: {
|
|
61545
|
+
description: "Date and time at which Seam created the warning.",
|
|
61546
|
+
format: "date-time",
|
|
61547
|
+
type: "string"
|
|
61548
|
+
},
|
|
61549
|
+
message: {
|
|
61550
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61551
|
+
type: "string"
|
|
61552
|
+
},
|
|
61553
|
+
warning_code: {
|
|
61554
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61555
|
+
enum: [
|
|
61556
|
+
"acs_user_profile_does_not_match_user_identity"
|
|
61557
|
+
],
|
|
61558
|
+
type: "string"
|
|
61559
|
+
}
|
|
61560
|
+
},
|
|
61561
|
+
required: [
|
|
61562
|
+
"created_at",
|
|
61563
|
+
"message",
|
|
61564
|
+
"warning_code"
|
|
61565
|
+
],
|
|
61566
|
+
type: "object"
|
|
61567
|
+
}
|
|
61568
|
+
]
|
|
61569
|
+
},
|
|
61570
|
+
type: "array"
|
|
61571
|
+
},
|
|
61572
|
+
workspace_id: {
|
|
61573
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
|
|
61574
|
+
format: "uuid",
|
|
61575
|
+
type: "string"
|
|
61576
|
+
}
|
|
61577
|
+
},
|
|
61578
|
+
required: [
|
|
61579
|
+
"user_identity_id",
|
|
61580
|
+
"email_address",
|
|
61581
|
+
"phone_number",
|
|
61582
|
+
"display_name",
|
|
61583
|
+
"full_name",
|
|
61584
|
+
"created_at",
|
|
61585
|
+
"workspace_id",
|
|
61586
|
+
"errors",
|
|
61587
|
+
"warnings",
|
|
61588
|
+
"acs_user_ids"
|
|
61589
|
+
],
|
|
61590
|
+
type: "object",
|
|
61591
|
+
"x-draft": "Early access.",
|
|
61592
|
+
"x-route-path": "/user_identities/unmanaged"
|
|
61593
|
+
}
|
|
61594
|
+
},
|
|
61595
|
+
required: ["user_identity", "ok"],
|
|
61596
|
+
type: "object"
|
|
61597
|
+
}
|
|
61598
|
+
}
|
|
61599
|
+
},
|
|
61600
|
+
description: "OK"
|
|
61601
|
+
},
|
|
61602
|
+
400: { description: "Bad Request" },
|
|
61603
|
+
401: { description: "Unauthorized" }
|
|
61604
|
+
},
|
|
61605
|
+
security: [
|
|
61606
|
+
{ api_key: [] },
|
|
61607
|
+
{ pat_with_workspace: [] },
|
|
61608
|
+
{ console_session_with_workspace: [] }
|
|
61609
|
+
],
|
|
61610
|
+
summary: "/user_identities/unmanaged/get",
|
|
61611
|
+
tags: ["/user_identities"],
|
|
61612
|
+
"x-fern-sdk-group-name": ["user_identities", "unmanaged"],
|
|
61613
|
+
"x-fern-sdk-method-name": "get",
|
|
61614
|
+
"x-fern-sdk-return-value": "user_identity",
|
|
61615
|
+
"x-response-key": "user_identity",
|
|
61616
|
+
"x-title": "Get an Unmanaged User Identity"
|
|
61617
|
+
}
|
|
61618
|
+
},
|
|
61619
|
+
"/user_identities/unmanaged/list": {
|
|
61620
|
+
get: {
|
|
61621
|
+
description: "Returns a list of all unmanaged [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).",
|
|
61622
|
+
operationId: "userIdentitiesUnmanagedListGet",
|
|
61623
|
+
parameters: [
|
|
61624
|
+
{
|
|
61625
|
+
in: "query",
|
|
61626
|
+
name: "search",
|
|
61627
|
+
schema: {
|
|
61628
|
+
description: "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.",
|
|
61629
|
+
type: "string"
|
|
61630
|
+
}
|
|
61631
|
+
}
|
|
61632
|
+
],
|
|
61633
|
+
responses: {
|
|
61634
|
+
200: {
|
|
61635
|
+
content: {
|
|
61636
|
+
"application/json": {
|
|
61637
|
+
schema: {
|
|
61638
|
+
properties: {
|
|
61639
|
+
ok: { type: "boolean" },
|
|
61640
|
+
user_identities: {
|
|
61641
|
+
items: {
|
|
61642
|
+
description: "Represents an unmanaged user identity. Unmanaged user identities do not have keys.",
|
|
61643
|
+
properties: {
|
|
61644
|
+
acs_user_ids: {
|
|
61645
|
+
description: "Array of access system user IDs associated with the user identity.",
|
|
61646
|
+
items: { format: "uuid", type: "string" },
|
|
61647
|
+
type: "array"
|
|
61648
|
+
},
|
|
61649
|
+
created_at: {
|
|
61650
|
+
description: "Date and time at which the user identity was created.",
|
|
61651
|
+
format: "date-time",
|
|
61652
|
+
type: "string"
|
|
61653
|
+
},
|
|
61654
|
+
display_name: { minLength: 1, type: "string" },
|
|
61655
|
+
email_address: {
|
|
61656
|
+
description: "Unique email address for the user identity.",
|
|
61657
|
+
format: "email",
|
|
61658
|
+
nullable: true,
|
|
61659
|
+
type: "string"
|
|
61660
|
+
},
|
|
61661
|
+
errors: {
|
|
61662
|
+
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.',
|
|
61663
|
+
items: {
|
|
61664
|
+
description: "Errors associated with the user identity.",
|
|
61665
|
+
discriminator: { propertyName: "error_code" },
|
|
61666
|
+
oneOf: [
|
|
61667
|
+
{
|
|
61668
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
61669
|
+
properties: {
|
|
61670
|
+
acs_system_id: {
|
|
61671
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
61672
|
+
format: "uuid",
|
|
61673
|
+
type: "string"
|
|
61674
|
+
},
|
|
61675
|
+
acs_user_id: {
|
|
61676
|
+
description: "ID of the access system user that has an issue.",
|
|
61677
|
+
format: "uuid",
|
|
61678
|
+
type: "string"
|
|
61679
|
+
},
|
|
61680
|
+
created_at: {
|
|
61681
|
+
description: "Date and time at which Seam created the error.",
|
|
61682
|
+
format: "date-time",
|
|
61683
|
+
type: "string"
|
|
61684
|
+
},
|
|
61685
|
+
error_code: {
|
|
61686
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
61687
|
+
enum: ["issue_with_acs_user"],
|
|
61688
|
+
type: "string"
|
|
61689
|
+
},
|
|
61690
|
+
message: {
|
|
61691
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
61692
|
+
type: "string"
|
|
61693
|
+
}
|
|
61694
|
+
},
|
|
61695
|
+
required: [
|
|
61696
|
+
"created_at",
|
|
61697
|
+
"message",
|
|
61698
|
+
"error_code",
|
|
61699
|
+
"acs_user_id",
|
|
61700
|
+
"acs_system_id"
|
|
61701
|
+
],
|
|
61702
|
+
type: "object"
|
|
61703
|
+
}
|
|
61704
|
+
]
|
|
61705
|
+
},
|
|
61706
|
+
type: "array"
|
|
61707
|
+
},
|
|
61708
|
+
full_name: {
|
|
61709
|
+
minLength: 1,
|
|
61710
|
+
nullable: true,
|
|
61711
|
+
type: "string"
|
|
61712
|
+
},
|
|
61713
|
+
phone_number: {
|
|
61714
|
+
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
61715
|
+
nullable: true,
|
|
61716
|
+
type: "string"
|
|
61717
|
+
},
|
|
61718
|
+
user_identity_id: {
|
|
61719
|
+
description: "ID of the user identity.",
|
|
61720
|
+
format: "uuid",
|
|
61721
|
+
type: "string"
|
|
61722
|
+
},
|
|
61723
|
+
warnings: {
|
|
61724
|
+
description: '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.',
|
|
61725
|
+
items: {
|
|
61726
|
+
description: "Warnings associated with the user identity.",
|
|
61727
|
+
discriminator: { propertyName: "warning_code" },
|
|
61728
|
+
oneOf: [
|
|
61729
|
+
{
|
|
61730
|
+
description: "Indicates that the user identity is currently being deleted.",
|
|
61731
|
+
properties: {
|
|
61732
|
+
created_at: {
|
|
61733
|
+
description: "Date and time at which Seam created the warning.",
|
|
61734
|
+
format: "date-time",
|
|
61735
|
+
type: "string"
|
|
61736
|
+
},
|
|
61737
|
+
message: {
|
|
61738
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61739
|
+
type: "string"
|
|
61740
|
+
},
|
|
61741
|
+
warning_code: {
|
|
61742
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61743
|
+
enum: ["being_deleted"],
|
|
61744
|
+
type: "string"
|
|
61745
|
+
}
|
|
61746
|
+
},
|
|
61747
|
+
required: [
|
|
61748
|
+
"created_at",
|
|
61749
|
+
"message",
|
|
61750
|
+
"warning_code"
|
|
61751
|
+
],
|
|
61752
|
+
type: "object"
|
|
61753
|
+
},
|
|
61754
|
+
{
|
|
61755
|
+
description: "Indicates that the ACS user's profile does not match the user identity's profile",
|
|
61756
|
+
properties: {
|
|
61757
|
+
created_at: {
|
|
61758
|
+
description: "Date and time at which Seam created the warning.",
|
|
61759
|
+
format: "date-time",
|
|
61760
|
+
type: "string"
|
|
61761
|
+
},
|
|
61762
|
+
message: {
|
|
61763
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61764
|
+
type: "string"
|
|
61765
|
+
},
|
|
61766
|
+
warning_code: {
|
|
61767
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61768
|
+
enum: [
|
|
61769
|
+
"acs_user_profile_does_not_match_user_identity"
|
|
61770
|
+
],
|
|
61771
|
+
type: "string"
|
|
61772
|
+
}
|
|
61773
|
+
},
|
|
61774
|
+
required: [
|
|
61775
|
+
"created_at",
|
|
61776
|
+
"message",
|
|
61777
|
+
"warning_code"
|
|
61778
|
+
],
|
|
61779
|
+
type: "object"
|
|
61780
|
+
}
|
|
61781
|
+
]
|
|
61782
|
+
},
|
|
61783
|
+
type: "array"
|
|
61784
|
+
},
|
|
61785
|
+
workspace_id: {
|
|
61786
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
|
|
61787
|
+
format: "uuid",
|
|
61788
|
+
type: "string"
|
|
61789
|
+
}
|
|
61790
|
+
},
|
|
61791
|
+
required: [
|
|
61792
|
+
"user_identity_id",
|
|
61793
|
+
"email_address",
|
|
61794
|
+
"phone_number",
|
|
61795
|
+
"display_name",
|
|
61796
|
+
"full_name",
|
|
61797
|
+
"created_at",
|
|
61798
|
+
"workspace_id",
|
|
61799
|
+
"errors",
|
|
61800
|
+
"warnings",
|
|
61801
|
+
"acs_user_ids"
|
|
61802
|
+
],
|
|
61803
|
+
type: "object",
|
|
61804
|
+
"x-draft": "Early access.",
|
|
61805
|
+
"x-route-path": "/user_identities/unmanaged"
|
|
61806
|
+
},
|
|
61807
|
+
type: "array"
|
|
61808
|
+
}
|
|
61809
|
+
},
|
|
61810
|
+
required: ["user_identities", "ok"],
|
|
61811
|
+
type: "object"
|
|
61812
|
+
}
|
|
61813
|
+
}
|
|
61814
|
+
},
|
|
61815
|
+
description: "OK"
|
|
61816
|
+
},
|
|
61817
|
+
400: { description: "Bad Request" },
|
|
61818
|
+
401: { description: "Unauthorized" }
|
|
61819
|
+
},
|
|
61820
|
+
security: [
|
|
61821
|
+
{ api_key: [] },
|
|
61822
|
+
{ client_session: [] },
|
|
61823
|
+
{ pat_with_workspace: [] },
|
|
61824
|
+
{ console_session_with_workspace: [] }
|
|
61825
|
+
],
|
|
61826
|
+
summary: "/user_identities/unmanaged/list",
|
|
61827
|
+
tags: ["/user_identities"],
|
|
61828
|
+
"x-fern-sdk-group-name": ["user_identities", "unmanaged"],
|
|
61829
|
+
"x-fern-sdk-method-name": "list",
|
|
61830
|
+
"x-fern-sdk-return-value": "user_identities",
|
|
61831
|
+
"x-response-key": "user_identities",
|
|
61832
|
+
"x-title": "List Unmanaged User Identities"
|
|
61833
|
+
},
|
|
61834
|
+
post: {
|
|
61835
|
+
description: "Returns a list of all unmanaged [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).",
|
|
61836
|
+
operationId: "userIdentitiesUnmanagedListPost",
|
|
61837
|
+
requestBody: {
|
|
61838
|
+
content: {
|
|
61839
|
+
"application/json": {
|
|
61840
|
+
schema: {
|
|
61841
|
+
properties: {
|
|
61842
|
+
search: {
|
|
61843
|
+
description: "String for which to search. Filters returned unmanaged user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.",
|
|
61844
|
+
type: "string"
|
|
61845
|
+
}
|
|
61846
|
+
},
|
|
61847
|
+
type: "object"
|
|
61848
|
+
}
|
|
61849
|
+
}
|
|
61850
|
+
}
|
|
61851
|
+
},
|
|
61852
|
+
responses: {
|
|
61853
|
+
200: {
|
|
61854
|
+
content: {
|
|
61855
|
+
"application/json": {
|
|
61856
|
+
schema: {
|
|
61857
|
+
properties: {
|
|
61858
|
+
ok: { type: "boolean" },
|
|
61859
|
+
user_identities: {
|
|
61860
|
+
items: {
|
|
61861
|
+
description: "Represents an unmanaged user identity. Unmanaged user identities do not have keys.",
|
|
61862
|
+
properties: {
|
|
61863
|
+
acs_user_ids: {
|
|
61864
|
+
description: "Array of access system user IDs associated with the user identity.",
|
|
61865
|
+
items: { format: "uuid", type: "string" },
|
|
61866
|
+
type: "array"
|
|
61867
|
+
},
|
|
61868
|
+
created_at: {
|
|
61869
|
+
description: "Date and time at which the user identity was created.",
|
|
61870
|
+
format: "date-time",
|
|
61871
|
+
type: "string"
|
|
61872
|
+
},
|
|
61873
|
+
display_name: { minLength: 1, type: "string" },
|
|
61874
|
+
email_address: {
|
|
61875
|
+
description: "Unique email address for the user identity.",
|
|
61876
|
+
format: "email",
|
|
61877
|
+
nullable: true,
|
|
61878
|
+
type: "string"
|
|
61879
|
+
},
|
|
61880
|
+
errors: {
|
|
61881
|
+
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.',
|
|
61882
|
+
items: {
|
|
61883
|
+
description: "Errors associated with the user identity.",
|
|
61884
|
+
discriminator: { propertyName: "error_code" },
|
|
61885
|
+
oneOf: [
|
|
61886
|
+
{
|
|
61887
|
+
description: "Indicates that there is an issue with an access system user associated with this user identity.",
|
|
61888
|
+
properties: {
|
|
61889
|
+
acs_system_id: {
|
|
61890
|
+
description: "ID of the access system that the user identity is associated with.",
|
|
61891
|
+
format: "uuid",
|
|
61892
|
+
type: "string"
|
|
61893
|
+
},
|
|
61894
|
+
acs_user_id: {
|
|
61895
|
+
description: "ID of the access system user that has an issue.",
|
|
61896
|
+
format: "uuid",
|
|
61897
|
+
type: "string"
|
|
61898
|
+
},
|
|
61899
|
+
created_at: {
|
|
61900
|
+
description: "Date and time at which Seam created the error.",
|
|
61901
|
+
format: "date-time",
|
|
61902
|
+
type: "string"
|
|
61903
|
+
},
|
|
61904
|
+
error_code: {
|
|
61905
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
61906
|
+
enum: ["issue_with_acs_user"],
|
|
61907
|
+
type: "string"
|
|
61908
|
+
},
|
|
61909
|
+
message: {
|
|
61910
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
61911
|
+
type: "string"
|
|
61912
|
+
}
|
|
61913
|
+
},
|
|
61914
|
+
required: [
|
|
61915
|
+
"created_at",
|
|
61916
|
+
"message",
|
|
61917
|
+
"error_code",
|
|
61918
|
+
"acs_user_id",
|
|
61919
|
+
"acs_system_id"
|
|
61920
|
+
],
|
|
61921
|
+
type: "object"
|
|
61922
|
+
}
|
|
61923
|
+
]
|
|
61924
|
+
},
|
|
61925
|
+
type: "array"
|
|
61926
|
+
},
|
|
61927
|
+
full_name: {
|
|
61928
|
+
minLength: 1,
|
|
61929
|
+
nullable: true,
|
|
61930
|
+
type: "string"
|
|
61931
|
+
},
|
|
61932
|
+
phone_number: {
|
|
61933
|
+
description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
|
|
61934
|
+
nullable: true,
|
|
61935
|
+
type: "string"
|
|
61936
|
+
},
|
|
61937
|
+
user_identity_id: {
|
|
61938
|
+
description: "ID of the user identity.",
|
|
61939
|
+
format: "uuid",
|
|
61940
|
+
type: "string"
|
|
61941
|
+
},
|
|
61942
|
+
warnings: {
|
|
61943
|
+
description: '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.',
|
|
61944
|
+
items: {
|
|
61945
|
+
description: "Warnings associated with the user identity.",
|
|
61946
|
+
discriminator: { propertyName: "warning_code" },
|
|
61947
|
+
oneOf: [
|
|
61948
|
+
{
|
|
61949
|
+
description: "Indicates that the user identity is currently being deleted.",
|
|
61950
|
+
properties: {
|
|
61951
|
+
created_at: {
|
|
61952
|
+
description: "Date and time at which Seam created the warning.",
|
|
61953
|
+
format: "date-time",
|
|
61954
|
+
type: "string"
|
|
61955
|
+
},
|
|
61956
|
+
message: {
|
|
61957
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61958
|
+
type: "string"
|
|
61959
|
+
},
|
|
61960
|
+
warning_code: {
|
|
61961
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61962
|
+
enum: ["being_deleted"],
|
|
61963
|
+
type: "string"
|
|
61964
|
+
}
|
|
61965
|
+
},
|
|
61966
|
+
required: [
|
|
61967
|
+
"created_at",
|
|
61968
|
+
"message",
|
|
61969
|
+
"warning_code"
|
|
61970
|
+
],
|
|
61971
|
+
type: "object"
|
|
61972
|
+
},
|
|
61973
|
+
{
|
|
61974
|
+
description: "Indicates that the ACS user's profile does not match the user identity's profile",
|
|
61975
|
+
properties: {
|
|
61976
|
+
created_at: {
|
|
61977
|
+
description: "Date and time at which Seam created the warning.",
|
|
61978
|
+
format: "date-time",
|
|
61979
|
+
type: "string"
|
|
61980
|
+
},
|
|
61981
|
+
message: {
|
|
61982
|
+
description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
|
|
61983
|
+
type: "string"
|
|
61984
|
+
},
|
|
61985
|
+
warning_code: {
|
|
61986
|
+
description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
|
|
61987
|
+
enum: [
|
|
61988
|
+
"acs_user_profile_does_not_match_user_identity"
|
|
61989
|
+
],
|
|
61990
|
+
type: "string"
|
|
61991
|
+
}
|
|
61992
|
+
},
|
|
61993
|
+
required: [
|
|
61994
|
+
"created_at",
|
|
61995
|
+
"message",
|
|
61996
|
+
"warning_code"
|
|
61997
|
+
],
|
|
61998
|
+
type: "object"
|
|
61999
|
+
}
|
|
62000
|
+
]
|
|
62001
|
+
},
|
|
62002
|
+
type: "array"
|
|
62003
|
+
},
|
|
62004
|
+
workspace_id: {
|
|
62005
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
|
|
62006
|
+
format: "uuid",
|
|
62007
|
+
type: "string"
|
|
62008
|
+
}
|
|
62009
|
+
},
|
|
62010
|
+
required: [
|
|
62011
|
+
"user_identity_id",
|
|
62012
|
+
"email_address",
|
|
62013
|
+
"phone_number",
|
|
62014
|
+
"display_name",
|
|
62015
|
+
"full_name",
|
|
62016
|
+
"created_at",
|
|
62017
|
+
"workspace_id",
|
|
62018
|
+
"errors",
|
|
62019
|
+
"warnings",
|
|
62020
|
+
"acs_user_ids"
|
|
62021
|
+
],
|
|
62022
|
+
type: "object",
|
|
62023
|
+
"x-draft": "Early access.",
|
|
62024
|
+
"x-route-path": "/user_identities/unmanaged"
|
|
62025
|
+
},
|
|
62026
|
+
type: "array"
|
|
62027
|
+
}
|
|
62028
|
+
},
|
|
62029
|
+
required: ["user_identities", "ok"],
|
|
62030
|
+
type: "object"
|
|
62031
|
+
}
|
|
62032
|
+
}
|
|
62033
|
+
},
|
|
62034
|
+
description: "OK"
|
|
62035
|
+
},
|
|
62036
|
+
400: { description: "Bad Request" },
|
|
62037
|
+
401: { description: "Unauthorized" }
|
|
62038
|
+
},
|
|
62039
|
+
security: [
|
|
62040
|
+
{ api_key: [] },
|
|
62041
|
+
{ client_session: [] },
|
|
62042
|
+
{ pat_with_workspace: [] },
|
|
62043
|
+
{ console_session_with_workspace: [] }
|
|
62044
|
+
],
|
|
62045
|
+
summary: "/user_identities/unmanaged/list",
|
|
62046
|
+
tags: ["/user_identities"],
|
|
62047
|
+
"x-fern-sdk-group-name": ["user_identities", "unmanaged"],
|
|
62048
|
+
"x-fern-sdk-method-name": "list",
|
|
62049
|
+
"x-fern-sdk-return-value": "user_identities",
|
|
62050
|
+
"x-response-key": "user_identities",
|
|
62051
|
+
"x-title": "List Unmanaged User Identities"
|
|
62052
|
+
}
|
|
62053
|
+
},
|
|
59661
62054
|
"/user_identities/update": {
|
|
59662
62055
|
patch: {
|
|
59663
62056
|
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).",
|