@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
|
@@ -29106,52 +29106,208 @@ export default {
|
|
|
29106
29106
|
'x-title': 'List Access Grants',
|
|
29107
29107
|
},
|
|
29108
29108
|
},
|
|
29109
|
-
'/access_grants/
|
|
29110
|
-
|
|
29111
|
-
description:
|
|
29112
|
-
|
|
29113
|
-
|
|
29114
|
-
|
|
29115
|
-
|
|
29116
|
-
|
|
29117
|
-
|
|
29118
|
-
|
|
29119
|
-
|
|
29120
|
-
|
|
29121
|
-
|
|
29122
|
-
|
|
29123
|
-
ends_at: {
|
|
29124
|
-
description:
|
|
29125
|
-
'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`.',
|
|
29126
|
-
format: 'date-time',
|
|
29127
|
-
nullable: true,
|
|
29128
|
-
type: 'string',
|
|
29129
|
-
},
|
|
29130
|
-
name: {
|
|
29131
|
-
description: 'Display name for the access grant.',
|
|
29132
|
-
nullable: true,
|
|
29133
|
-
type: 'string',
|
|
29134
|
-
},
|
|
29135
|
-
starts_at: {
|
|
29136
|
-
description:
|
|
29137
|
-
'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.',
|
|
29138
|
-
format: 'date-time',
|
|
29139
|
-
type: 'string',
|
|
29140
|
-
},
|
|
29141
|
-
},
|
|
29142
|
-
required: ['access_grant_id'],
|
|
29143
|
-
type: 'object',
|
|
29144
|
-
},
|
|
29109
|
+
'/access_grants/unmanaged/get': {
|
|
29110
|
+
get: {
|
|
29111
|
+
description:
|
|
29112
|
+
'Get an unmanaged Access Grant (where is_managed = false).',
|
|
29113
|
+
operationId: 'accessGrantsUnmanagedGetGet',
|
|
29114
|
+
parameters: [
|
|
29115
|
+
{
|
|
29116
|
+
in: 'query',
|
|
29117
|
+
name: 'access_grant_id',
|
|
29118
|
+
required: true,
|
|
29119
|
+
schema: {
|
|
29120
|
+
description: 'ID of unmanaged Access Grant to get.',
|
|
29121
|
+
format: 'uuid',
|
|
29122
|
+
type: 'string',
|
|
29145
29123
|
},
|
|
29146
29124
|
},
|
|
29147
|
-
|
|
29125
|
+
],
|
|
29148
29126
|
responses: {
|
|
29149
29127
|
200: {
|
|
29150
29128
|
content: {
|
|
29151
29129
|
'application/json': {
|
|
29152
29130
|
schema: {
|
|
29153
|
-
properties: {
|
|
29154
|
-
|
|
29131
|
+
properties: {
|
|
29132
|
+
access_grant: {
|
|
29133
|
+
description:
|
|
29134
|
+
'Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.',
|
|
29135
|
+
properties: {
|
|
29136
|
+
access_grant_id: {
|
|
29137
|
+
description: 'ID of the Access Grant.',
|
|
29138
|
+
format: 'uuid',
|
|
29139
|
+
type: 'string',
|
|
29140
|
+
},
|
|
29141
|
+
access_method_ids: {
|
|
29142
|
+
description:
|
|
29143
|
+
'IDs of the access methods created for the Access Grant.',
|
|
29144
|
+
items: { format: 'uuid', type: 'string' },
|
|
29145
|
+
type: 'array',
|
|
29146
|
+
},
|
|
29147
|
+
created_at: {
|
|
29148
|
+
description:
|
|
29149
|
+
'Date and time at which the Access Grant was created.',
|
|
29150
|
+
format: 'date-time',
|
|
29151
|
+
type: 'string',
|
|
29152
|
+
},
|
|
29153
|
+
display_name: {
|
|
29154
|
+
description: 'Display name of the Access Grant.',
|
|
29155
|
+
type: 'string',
|
|
29156
|
+
},
|
|
29157
|
+
ends_at: {
|
|
29158
|
+
description:
|
|
29159
|
+
'Date and time at which the Access Grant ends.',
|
|
29160
|
+
format: 'date-time',
|
|
29161
|
+
nullable: true,
|
|
29162
|
+
type: 'string',
|
|
29163
|
+
},
|
|
29164
|
+
location_ids: {
|
|
29165
|
+
deprecated: true,
|
|
29166
|
+
items: { format: 'uuid', type: 'string' },
|
|
29167
|
+
type: 'array',
|
|
29168
|
+
'x-deprecated': 'Use `space_ids`.',
|
|
29169
|
+
},
|
|
29170
|
+
name: {
|
|
29171
|
+
description:
|
|
29172
|
+
'Name of the Access Grant. If not provided, the display name will be computed.',
|
|
29173
|
+
nullable: true,
|
|
29174
|
+
type: 'string',
|
|
29175
|
+
},
|
|
29176
|
+
requested_access_methods: {
|
|
29177
|
+
description:
|
|
29178
|
+
'Access methods that the user requested for the Access Grant.',
|
|
29179
|
+
items: {
|
|
29180
|
+
properties: {
|
|
29181
|
+
code: {
|
|
29182
|
+
description:
|
|
29183
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
29184
|
+
maxLength: 9,
|
|
29185
|
+
minLength: 4,
|
|
29186
|
+
pattern: '^\\d+$',
|
|
29187
|
+
type: 'string',
|
|
29188
|
+
},
|
|
29189
|
+
created_access_method_ids: {
|
|
29190
|
+
description:
|
|
29191
|
+
'IDs of the access methods created for the requested access method.',
|
|
29192
|
+
items: { format: 'uuid', type: 'string' },
|
|
29193
|
+
type: 'array',
|
|
29194
|
+
},
|
|
29195
|
+
created_at: {
|
|
29196
|
+
description:
|
|
29197
|
+
'Date and time at which the requested access method was added to the Access Grant.',
|
|
29198
|
+
format: 'date-time',
|
|
29199
|
+
type: 'string',
|
|
29200
|
+
},
|
|
29201
|
+
display_name: {
|
|
29202
|
+
description:
|
|
29203
|
+
'Display name of the access method.',
|
|
29204
|
+
type: 'string',
|
|
29205
|
+
},
|
|
29206
|
+
mode: {
|
|
29207
|
+
description:
|
|
29208
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
29209
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
29210
|
+
type: 'string',
|
|
29211
|
+
},
|
|
29212
|
+
},
|
|
29213
|
+
required: [
|
|
29214
|
+
'display_name',
|
|
29215
|
+
'mode',
|
|
29216
|
+
'created_at',
|
|
29217
|
+
'created_access_method_ids',
|
|
29218
|
+
],
|
|
29219
|
+
type: 'object',
|
|
29220
|
+
},
|
|
29221
|
+
type: 'array',
|
|
29222
|
+
},
|
|
29223
|
+
space_ids: {
|
|
29224
|
+
description:
|
|
29225
|
+
'IDs of the spaces to which the Access Grant gives access.',
|
|
29226
|
+
items: { format: 'uuid', type: 'string' },
|
|
29227
|
+
type: 'array',
|
|
29228
|
+
},
|
|
29229
|
+
starts_at: {
|
|
29230
|
+
description:
|
|
29231
|
+
'Date and time at which the Access Grant starts.',
|
|
29232
|
+
format: 'date-time',
|
|
29233
|
+
type: 'string',
|
|
29234
|
+
},
|
|
29235
|
+
user_identity_id: {
|
|
29236
|
+
description:
|
|
29237
|
+
'ID of user identity to which the Access Grant gives access.',
|
|
29238
|
+
format: 'uuid',
|
|
29239
|
+
type: 'string',
|
|
29240
|
+
},
|
|
29241
|
+
warnings: {
|
|
29242
|
+
description:
|
|
29243
|
+
'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29244
|
+
items: {
|
|
29245
|
+
description:
|
|
29246
|
+
'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29247
|
+
discriminator: { propertyName: 'warning_code' },
|
|
29248
|
+
oneOf: [
|
|
29249
|
+
{
|
|
29250
|
+
description:
|
|
29251
|
+
'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
|
|
29252
|
+
properties: {
|
|
29253
|
+
created_at: {
|
|
29254
|
+
description:
|
|
29255
|
+
'Date and time at which Seam created the warning.',
|
|
29256
|
+
format: 'date-time',
|
|
29257
|
+
type: 'string',
|
|
29258
|
+
},
|
|
29259
|
+
message: {
|
|
29260
|
+
description:
|
|
29261
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29262
|
+
type: 'string',
|
|
29263
|
+
},
|
|
29264
|
+
warning_code: {
|
|
29265
|
+
description:
|
|
29266
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29267
|
+
enum: ['being_deleted'],
|
|
29268
|
+
type: 'string',
|
|
29269
|
+
},
|
|
29270
|
+
},
|
|
29271
|
+
required: [
|
|
29272
|
+
'created_at',
|
|
29273
|
+
'message',
|
|
29274
|
+
'warning_code',
|
|
29275
|
+
],
|
|
29276
|
+
type: 'object',
|
|
29277
|
+
},
|
|
29278
|
+
],
|
|
29279
|
+
},
|
|
29280
|
+
type: 'array',
|
|
29281
|
+
},
|
|
29282
|
+
workspace_id: {
|
|
29283
|
+
description:
|
|
29284
|
+
'ID of the Seam workspace associated with the Access Grant.',
|
|
29285
|
+
format: 'uuid',
|
|
29286
|
+
type: 'string',
|
|
29287
|
+
},
|
|
29288
|
+
},
|
|
29289
|
+
required: [
|
|
29290
|
+
'workspace_id',
|
|
29291
|
+
'access_grant_id',
|
|
29292
|
+
'user_identity_id',
|
|
29293
|
+
'location_ids',
|
|
29294
|
+
'space_ids',
|
|
29295
|
+
'requested_access_methods',
|
|
29296
|
+
'access_method_ids',
|
|
29297
|
+
'name',
|
|
29298
|
+
'display_name',
|
|
29299
|
+
'created_at',
|
|
29300
|
+
'starts_at',
|
|
29301
|
+
'ends_at',
|
|
29302
|
+
'warnings',
|
|
29303
|
+
],
|
|
29304
|
+
type: 'object',
|
|
29305
|
+
'x-draft': 'Early access.',
|
|
29306
|
+
'x-route-path': '/access_grants/unmanaged',
|
|
29307
|
+
},
|
|
29308
|
+
ok: { type: 'boolean' },
|
|
29309
|
+
},
|
|
29310
|
+
required: ['access_grant', 'ok'],
|
|
29155
29311
|
type: 'object',
|
|
29156
29312
|
},
|
|
29157
29313
|
},
|
|
@@ -29167,45 +29323,29 @@ export default {
|
|
|
29167
29323
|
{ api_key: [] },
|
|
29168
29324
|
{ client_session_with_customer: [] },
|
|
29169
29325
|
],
|
|
29170
|
-
summary: '/access_grants/
|
|
29326
|
+
summary: '/access_grants/unmanaged/get',
|
|
29171
29327
|
tags: [],
|
|
29172
29328
|
'x-draft': 'Early access.',
|
|
29173
|
-
'x-fern-sdk-group-name': ['access_grants'],
|
|
29174
|
-
'x-fern-sdk-method-name': '
|
|
29175
|
-
'x-
|
|
29176
|
-
'x-
|
|
29329
|
+
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
29330
|
+
'x-fern-sdk-method-name': 'get',
|
|
29331
|
+
'x-fern-sdk-return-value': 'access_grant',
|
|
29332
|
+
'x-response-key': 'access_grant',
|
|
29333
|
+
'x-title': 'Get an Unmanaged Access Grant',
|
|
29177
29334
|
},
|
|
29178
29335
|
post: {
|
|
29179
|
-
description:
|
|
29180
|
-
|
|
29336
|
+
description:
|
|
29337
|
+
'Get an unmanaged Access Grant (where is_managed = false).',
|
|
29338
|
+
operationId: 'accessGrantsUnmanagedGetPost',
|
|
29181
29339
|
requestBody: {
|
|
29182
29340
|
content: {
|
|
29183
29341
|
'application/json': {
|
|
29184
29342
|
schema: {
|
|
29185
29343
|
properties: {
|
|
29186
29344
|
access_grant_id: {
|
|
29187
|
-
description: 'ID of
|
|
29345
|
+
description: 'ID of unmanaged Access Grant to get.',
|
|
29188
29346
|
format: 'uuid',
|
|
29189
29347
|
type: 'string',
|
|
29190
29348
|
},
|
|
29191
|
-
ends_at: {
|
|
29192
|
-
description:
|
|
29193
|
-
'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`.',
|
|
29194
|
-
format: 'date-time',
|
|
29195
|
-
nullable: true,
|
|
29196
|
-
type: 'string',
|
|
29197
|
-
},
|
|
29198
|
-
name: {
|
|
29199
|
-
description: 'Display name for the access grant.',
|
|
29200
|
-
nullable: true,
|
|
29201
|
-
type: 'string',
|
|
29202
|
-
},
|
|
29203
|
-
starts_at: {
|
|
29204
|
-
description:
|
|
29205
|
-
'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.',
|
|
29206
|
-
format: 'date-time',
|
|
29207
|
-
type: 'string',
|
|
29208
|
-
},
|
|
29209
29349
|
},
|
|
29210
29350
|
required: ['access_grant_id'],
|
|
29211
29351
|
type: 'object',
|
|
@@ -29218,70 +29358,929 @@ export default {
|
|
|
29218
29358
|
content: {
|
|
29219
29359
|
'application/json': {
|
|
29220
29360
|
schema: {
|
|
29221
|
-
properties: {
|
|
29222
|
-
|
|
29223
|
-
|
|
29224
|
-
|
|
29225
|
-
|
|
29226
|
-
|
|
29227
|
-
|
|
29228
|
-
|
|
29229
|
-
|
|
29230
|
-
|
|
29231
|
-
|
|
29232
|
-
|
|
29233
|
-
|
|
29234
|
-
|
|
29235
|
-
|
|
29236
|
-
|
|
29237
|
-
|
|
29238
|
-
|
|
29239
|
-
|
|
29240
|
-
|
|
29241
|
-
|
|
29242
|
-
|
|
29243
|
-
|
|
29244
|
-
|
|
29245
|
-
|
|
29246
|
-
|
|
29247
|
-
|
|
29248
|
-
|
|
29249
|
-
|
|
29250
|
-
|
|
29251
|
-
|
|
29252
|
-
|
|
29253
|
-
|
|
29254
|
-
|
|
29255
|
-
|
|
29256
|
-
|
|
29257
|
-
|
|
29258
|
-
|
|
29259
|
-
|
|
29260
|
-
|
|
29261
|
-
|
|
29262
|
-
|
|
29263
|
-
|
|
29264
|
-
|
|
29265
|
-
|
|
29266
|
-
|
|
29267
|
-
|
|
29268
|
-
|
|
29269
|
-
|
|
29270
|
-
|
|
29271
|
-
|
|
29272
|
-
|
|
29273
|
-
|
|
29274
|
-
|
|
29275
|
-
|
|
29276
|
-
|
|
29277
|
-
|
|
29278
|
-
|
|
29279
|
-
|
|
29280
|
-
|
|
29281
|
-
|
|
29282
|
-
|
|
29283
|
-
|
|
29284
|
-
|
|
29361
|
+
properties: {
|
|
29362
|
+
access_grant: {
|
|
29363
|
+
description:
|
|
29364
|
+
'Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.',
|
|
29365
|
+
properties: {
|
|
29366
|
+
access_grant_id: {
|
|
29367
|
+
description: 'ID of the Access Grant.',
|
|
29368
|
+
format: 'uuid',
|
|
29369
|
+
type: 'string',
|
|
29370
|
+
},
|
|
29371
|
+
access_method_ids: {
|
|
29372
|
+
description:
|
|
29373
|
+
'IDs of the access methods created for the Access Grant.',
|
|
29374
|
+
items: { format: 'uuid', type: 'string' },
|
|
29375
|
+
type: 'array',
|
|
29376
|
+
},
|
|
29377
|
+
created_at: {
|
|
29378
|
+
description:
|
|
29379
|
+
'Date and time at which the Access Grant was created.',
|
|
29380
|
+
format: 'date-time',
|
|
29381
|
+
type: 'string',
|
|
29382
|
+
},
|
|
29383
|
+
display_name: {
|
|
29384
|
+
description: 'Display name of the Access Grant.',
|
|
29385
|
+
type: 'string',
|
|
29386
|
+
},
|
|
29387
|
+
ends_at: {
|
|
29388
|
+
description:
|
|
29389
|
+
'Date and time at which the Access Grant ends.',
|
|
29390
|
+
format: 'date-time',
|
|
29391
|
+
nullable: true,
|
|
29392
|
+
type: 'string',
|
|
29393
|
+
},
|
|
29394
|
+
location_ids: {
|
|
29395
|
+
deprecated: true,
|
|
29396
|
+
items: { format: 'uuid', type: 'string' },
|
|
29397
|
+
type: 'array',
|
|
29398
|
+
'x-deprecated': 'Use `space_ids`.',
|
|
29399
|
+
},
|
|
29400
|
+
name: {
|
|
29401
|
+
description:
|
|
29402
|
+
'Name of the Access Grant. If not provided, the display name will be computed.',
|
|
29403
|
+
nullable: true,
|
|
29404
|
+
type: 'string',
|
|
29405
|
+
},
|
|
29406
|
+
requested_access_methods: {
|
|
29407
|
+
description:
|
|
29408
|
+
'Access methods that the user requested for the Access Grant.',
|
|
29409
|
+
items: {
|
|
29410
|
+
properties: {
|
|
29411
|
+
code: {
|
|
29412
|
+
description:
|
|
29413
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
29414
|
+
maxLength: 9,
|
|
29415
|
+
minLength: 4,
|
|
29416
|
+
pattern: '^\\d+$',
|
|
29417
|
+
type: 'string',
|
|
29418
|
+
},
|
|
29419
|
+
created_access_method_ids: {
|
|
29420
|
+
description:
|
|
29421
|
+
'IDs of the access methods created for the requested access method.',
|
|
29422
|
+
items: { format: 'uuid', type: 'string' },
|
|
29423
|
+
type: 'array',
|
|
29424
|
+
},
|
|
29425
|
+
created_at: {
|
|
29426
|
+
description:
|
|
29427
|
+
'Date and time at which the requested access method was added to the Access Grant.',
|
|
29428
|
+
format: 'date-time',
|
|
29429
|
+
type: 'string',
|
|
29430
|
+
},
|
|
29431
|
+
display_name: {
|
|
29432
|
+
description:
|
|
29433
|
+
'Display name of the access method.',
|
|
29434
|
+
type: 'string',
|
|
29435
|
+
},
|
|
29436
|
+
mode: {
|
|
29437
|
+
description:
|
|
29438
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
29439
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
29440
|
+
type: 'string',
|
|
29441
|
+
},
|
|
29442
|
+
},
|
|
29443
|
+
required: [
|
|
29444
|
+
'display_name',
|
|
29445
|
+
'mode',
|
|
29446
|
+
'created_at',
|
|
29447
|
+
'created_access_method_ids',
|
|
29448
|
+
],
|
|
29449
|
+
type: 'object',
|
|
29450
|
+
},
|
|
29451
|
+
type: 'array',
|
|
29452
|
+
},
|
|
29453
|
+
space_ids: {
|
|
29454
|
+
description:
|
|
29455
|
+
'IDs of the spaces to which the Access Grant gives access.',
|
|
29456
|
+
items: { format: 'uuid', type: 'string' },
|
|
29457
|
+
type: 'array',
|
|
29458
|
+
},
|
|
29459
|
+
starts_at: {
|
|
29460
|
+
description:
|
|
29461
|
+
'Date and time at which the Access Grant starts.',
|
|
29462
|
+
format: 'date-time',
|
|
29463
|
+
type: 'string',
|
|
29464
|
+
},
|
|
29465
|
+
user_identity_id: {
|
|
29466
|
+
description:
|
|
29467
|
+
'ID of user identity to which the Access Grant gives access.',
|
|
29468
|
+
format: 'uuid',
|
|
29469
|
+
type: 'string',
|
|
29470
|
+
},
|
|
29471
|
+
warnings: {
|
|
29472
|
+
description:
|
|
29473
|
+
'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29474
|
+
items: {
|
|
29475
|
+
description:
|
|
29476
|
+
'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29477
|
+
discriminator: { propertyName: 'warning_code' },
|
|
29478
|
+
oneOf: [
|
|
29479
|
+
{
|
|
29480
|
+
description:
|
|
29481
|
+
'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
|
|
29482
|
+
properties: {
|
|
29483
|
+
created_at: {
|
|
29484
|
+
description:
|
|
29485
|
+
'Date and time at which Seam created the warning.',
|
|
29486
|
+
format: 'date-time',
|
|
29487
|
+
type: 'string',
|
|
29488
|
+
},
|
|
29489
|
+
message: {
|
|
29490
|
+
description:
|
|
29491
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29492
|
+
type: 'string',
|
|
29493
|
+
},
|
|
29494
|
+
warning_code: {
|
|
29495
|
+
description:
|
|
29496
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29497
|
+
enum: ['being_deleted'],
|
|
29498
|
+
type: 'string',
|
|
29499
|
+
},
|
|
29500
|
+
},
|
|
29501
|
+
required: [
|
|
29502
|
+
'created_at',
|
|
29503
|
+
'message',
|
|
29504
|
+
'warning_code',
|
|
29505
|
+
],
|
|
29506
|
+
type: 'object',
|
|
29507
|
+
},
|
|
29508
|
+
],
|
|
29509
|
+
},
|
|
29510
|
+
type: 'array',
|
|
29511
|
+
},
|
|
29512
|
+
workspace_id: {
|
|
29513
|
+
description:
|
|
29514
|
+
'ID of the Seam workspace associated with the Access Grant.',
|
|
29515
|
+
format: 'uuid',
|
|
29516
|
+
type: 'string',
|
|
29517
|
+
},
|
|
29518
|
+
},
|
|
29519
|
+
required: [
|
|
29520
|
+
'workspace_id',
|
|
29521
|
+
'access_grant_id',
|
|
29522
|
+
'user_identity_id',
|
|
29523
|
+
'location_ids',
|
|
29524
|
+
'space_ids',
|
|
29525
|
+
'requested_access_methods',
|
|
29526
|
+
'access_method_ids',
|
|
29527
|
+
'name',
|
|
29528
|
+
'display_name',
|
|
29529
|
+
'created_at',
|
|
29530
|
+
'starts_at',
|
|
29531
|
+
'ends_at',
|
|
29532
|
+
'warnings',
|
|
29533
|
+
],
|
|
29534
|
+
type: 'object',
|
|
29535
|
+
'x-draft': 'Early access.',
|
|
29536
|
+
'x-route-path': '/access_grants/unmanaged',
|
|
29537
|
+
},
|
|
29538
|
+
ok: { type: 'boolean' },
|
|
29539
|
+
},
|
|
29540
|
+
required: ['access_grant', 'ok'],
|
|
29541
|
+
type: 'object',
|
|
29542
|
+
},
|
|
29543
|
+
},
|
|
29544
|
+
},
|
|
29545
|
+
description: 'OK',
|
|
29546
|
+
},
|
|
29547
|
+
400: { description: 'Bad Request' },
|
|
29548
|
+
401: { description: 'Unauthorized' },
|
|
29549
|
+
},
|
|
29550
|
+
security: [
|
|
29551
|
+
{ pat_with_workspace: [] },
|
|
29552
|
+
{ console_session_with_workspace: [] },
|
|
29553
|
+
{ api_key: [] },
|
|
29554
|
+
{ client_session_with_customer: [] },
|
|
29555
|
+
],
|
|
29556
|
+
summary: '/access_grants/unmanaged/get',
|
|
29557
|
+
tags: [],
|
|
29558
|
+
'x-draft': 'Early access.',
|
|
29559
|
+
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
29560
|
+
'x-fern-sdk-method-name': 'get',
|
|
29561
|
+
'x-fern-sdk-return-value': 'access_grant',
|
|
29562
|
+
'x-response-key': 'access_grant',
|
|
29563
|
+
'x-title': 'Get an Unmanaged Access Grant',
|
|
29564
|
+
},
|
|
29565
|
+
},
|
|
29566
|
+
'/access_grants/unmanaged/list': {
|
|
29567
|
+
get: {
|
|
29568
|
+
description: 'Gets unmanaged Access Grants (where is_managed = false).',
|
|
29569
|
+
operationId: 'accessGrantsUnmanagedListGet',
|
|
29570
|
+
parameters: [
|
|
29571
|
+
{
|
|
29572
|
+
in: 'query',
|
|
29573
|
+
name: 'user_identity_id',
|
|
29574
|
+
schema: {
|
|
29575
|
+
description:
|
|
29576
|
+
'ID of user identity by which you want to filter the list of unmanaged Access Grants.',
|
|
29577
|
+
format: 'uuid',
|
|
29578
|
+
type: 'string',
|
|
29579
|
+
},
|
|
29580
|
+
},
|
|
29581
|
+
{
|
|
29582
|
+
in: 'query',
|
|
29583
|
+
name: 'acs_system_id',
|
|
29584
|
+
schema: {
|
|
29585
|
+
description:
|
|
29586
|
+
'ID of the access system by which you want to filter the list of unmanaged Access Grants.',
|
|
29587
|
+
format: 'uuid',
|
|
29588
|
+
type: 'string',
|
|
29589
|
+
},
|
|
29590
|
+
},
|
|
29591
|
+
{
|
|
29592
|
+
in: 'query',
|
|
29593
|
+
name: 'acs_entrance_id',
|
|
29594
|
+
schema: {
|
|
29595
|
+
description:
|
|
29596
|
+
'ID of the entrance by which you want to filter the list of unmanaged Access Grants.',
|
|
29597
|
+
format: 'uuid',
|
|
29598
|
+
type: 'string',
|
|
29599
|
+
},
|
|
29600
|
+
},
|
|
29601
|
+
],
|
|
29602
|
+
responses: {
|
|
29603
|
+
200: {
|
|
29604
|
+
content: {
|
|
29605
|
+
'application/json': {
|
|
29606
|
+
schema: {
|
|
29607
|
+
properties: {
|
|
29608
|
+
access_grants: {
|
|
29609
|
+
items: {
|
|
29610
|
+
description:
|
|
29611
|
+
'Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.',
|
|
29612
|
+
properties: {
|
|
29613
|
+
access_grant_id: {
|
|
29614
|
+
description: 'ID of the Access Grant.',
|
|
29615
|
+
format: 'uuid',
|
|
29616
|
+
type: 'string',
|
|
29617
|
+
},
|
|
29618
|
+
access_method_ids: {
|
|
29619
|
+
description:
|
|
29620
|
+
'IDs of the access methods created for the Access Grant.',
|
|
29621
|
+
items: { format: 'uuid', type: 'string' },
|
|
29622
|
+
type: 'array',
|
|
29623
|
+
},
|
|
29624
|
+
created_at: {
|
|
29625
|
+
description:
|
|
29626
|
+
'Date and time at which the Access Grant was created.',
|
|
29627
|
+
format: 'date-time',
|
|
29628
|
+
type: 'string',
|
|
29629
|
+
},
|
|
29630
|
+
display_name: {
|
|
29631
|
+
description: 'Display name of the Access Grant.',
|
|
29632
|
+
type: 'string',
|
|
29633
|
+
},
|
|
29634
|
+
ends_at: {
|
|
29635
|
+
description:
|
|
29636
|
+
'Date and time at which the Access Grant ends.',
|
|
29637
|
+
format: 'date-time',
|
|
29638
|
+
nullable: true,
|
|
29639
|
+
type: 'string',
|
|
29640
|
+
},
|
|
29641
|
+
location_ids: {
|
|
29642
|
+
deprecated: true,
|
|
29643
|
+
items: { format: 'uuid', type: 'string' },
|
|
29644
|
+
type: 'array',
|
|
29645
|
+
'x-deprecated': 'Use `space_ids`.',
|
|
29646
|
+
},
|
|
29647
|
+
name: {
|
|
29648
|
+
description:
|
|
29649
|
+
'Name of the Access Grant. If not provided, the display name will be computed.',
|
|
29650
|
+
nullable: true,
|
|
29651
|
+
type: 'string',
|
|
29652
|
+
},
|
|
29653
|
+
requested_access_methods: {
|
|
29654
|
+
description:
|
|
29655
|
+
'Access methods that the user requested for the Access Grant.',
|
|
29656
|
+
items: {
|
|
29657
|
+
properties: {
|
|
29658
|
+
code: {
|
|
29659
|
+
description:
|
|
29660
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
29661
|
+
maxLength: 9,
|
|
29662
|
+
minLength: 4,
|
|
29663
|
+
pattern: '^\\d+$',
|
|
29664
|
+
type: 'string',
|
|
29665
|
+
},
|
|
29666
|
+
created_access_method_ids: {
|
|
29667
|
+
description:
|
|
29668
|
+
'IDs of the access methods created for the requested access method.',
|
|
29669
|
+
items: { format: 'uuid', type: 'string' },
|
|
29670
|
+
type: 'array',
|
|
29671
|
+
},
|
|
29672
|
+
created_at: {
|
|
29673
|
+
description:
|
|
29674
|
+
'Date and time at which the requested access method was added to the Access Grant.',
|
|
29675
|
+
format: 'date-time',
|
|
29676
|
+
type: 'string',
|
|
29677
|
+
},
|
|
29678
|
+
display_name: {
|
|
29679
|
+
description:
|
|
29680
|
+
'Display name of the access method.',
|
|
29681
|
+
type: 'string',
|
|
29682
|
+
},
|
|
29683
|
+
mode: {
|
|
29684
|
+
description:
|
|
29685
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
29686
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
29687
|
+
type: 'string',
|
|
29688
|
+
},
|
|
29689
|
+
},
|
|
29690
|
+
required: [
|
|
29691
|
+
'display_name',
|
|
29692
|
+
'mode',
|
|
29693
|
+
'created_at',
|
|
29694
|
+
'created_access_method_ids',
|
|
29695
|
+
],
|
|
29696
|
+
type: 'object',
|
|
29697
|
+
},
|
|
29698
|
+
type: 'array',
|
|
29699
|
+
},
|
|
29700
|
+
space_ids: {
|
|
29701
|
+
description:
|
|
29702
|
+
'IDs of the spaces to which the Access Grant gives access.',
|
|
29703
|
+
items: { format: 'uuid', type: 'string' },
|
|
29704
|
+
type: 'array',
|
|
29705
|
+
},
|
|
29706
|
+
starts_at: {
|
|
29707
|
+
description:
|
|
29708
|
+
'Date and time at which the Access Grant starts.',
|
|
29709
|
+
format: 'date-time',
|
|
29710
|
+
type: 'string',
|
|
29711
|
+
},
|
|
29712
|
+
user_identity_id: {
|
|
29713
|
+
description:
|
|
29714
|
+
'ID of user identity to which the Access Grant gives access.',
|
|
29715
|
+
format: 'uuid',
|
|
29716
|
+
type: 'string',
|
|
29717
|
+
},
|
|
29718
|
+
warnings: {
|
|
29719
|
+
description:
|
|
29720
|
+
'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29721
|
+
items: {
|
|
29722
|
+
description:
|
|
29723
|
+
'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29724
|
+
discriminator: { propertyName: 'warning_code' },
|
|
29725
|
+
oneOf: [
|
|
29726
|
+
{
|
|
29727
|
+
description:
|
|
29728
|
+
'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
|
|
29729
|
+
properties: {
|
|
29730
|
+
created_at: {
|
|
29731
|
+
description:
|
|
29732
|
+
'Date and time at which Seam created the warning.',
|
|
29733
|
+
format: 'date-time',
|
|
29734
|
+
type: 'string',
|
|
29735
|
+
},
|
|
29736
|
+
message: {
|
|
29737
|
+
description:
|
|
29738
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29739
|
+
type: 'string',
|
|
29740
|
+
},
|
|
29741
|
+
warning_code: {
|
|
29742
|
+
description:
|
|
29743
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29744
|
+
enum: ['being_deleted'],
|
|
29745
|
+
type: 'string',
|
|
29746
|
+
},
|
|
29747
|
+
},
|
|
29748
|
+
required: [
|
|
29749
|
+
'created_at',
|
|
29750
|
+
'message',
|
|
29751
|
+
'warning_code',
|
|
29752
|
+
],
|
|
29753
|
+
type: 'object',
|
|
29754
|
+
},
|
|
29755
|
+
],
|
|
29756
|
+
},
|
|
29757
|
+
type: 'array',
|
|
29758
|
+
},
|
|
29759
|
+
workspace_id: {
|
|
29760
|
+
description:
|
|
29761
|
+
'ID of the Seam workspace associated with the Access Grant.',
|
|
29762
|
+
format: 'uuid',
|
|
29763
|
+
type: 'string',
|
|
29764
|
+
},
|
|
29765
|
+
},
|
|
29766
|
+
required: [
|
|
29767
|
+
'workspace_id',
|
|
29768
|
+
'access_grant_id',
|
|
29769
|
+
'user_identity_id',
|
|
29770
|
+
'location_ids',
|
|
29771
|
+
'space_ids',
|
|
29772
|
+
'requested_access_methods',
|
|
29773
|
+
'access_method_ids',
|
|
29774
|
+
'name',
|
|
29775
|
+
'display_name',
|
|
29776
|
+
'created_at',
|
|
29777
|
+
'starts_at',
|
|
29778
|
+
'ends_at',
|
|
29779
|
+
'warnings',
|
|
29780
|
+
],
|
|
29781
|
+
type: 'object',
|
|
29782
|
+
'x-draft': 'Early access.',
|
|
29783
|
+
'x-route-path': '/access_grants/unmanaged',
|
|
29784
|
+
},
|
|
29785
|
+
type: 'array',
|
|
29786
|
+
},
|
|
29787
|
+
ok: { type: 'boolean' },
|
|
29788
|
+
},
|
|
29789
|
+
required: ['access_grants', 'ok'],
|
|
29790
|
+
type: 'object',
|
|
29791
|
+
},
|
|
29792
|
+
},
|
|
29793
|
+
},
|
|
29794
|
+
description: 'OK',
|
|
29795
|
+
},
|
|
29796
|
+
400: { description: 'Bad Request' },
|
|
29797
|
+
401: { description: 'Unauthorized' },
|
|
29798
|
+
},
|
|
29799
|
+
security: [
|
|
29800
|
+
{ pat_with_workspace: [] },
|
|
29801
|
+
{ console_session_with_workspace: [] },
|
|
29802
|
+
{ api_key: [] },
|
|
29803
|
+
{ client_session_with_customer: [] },
|
|
29804
|
+
],
|
|
29805
|
+
summary: '/access_grants/unmanaged/list',
|
|
29806
|
+
tags: [],
|
|
29807
|
+
'x-draft': 'Early access.',
|
|
29808
|
+
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
29809
|
+
'x-fern-sdk-method-name': 'list',
|
|
29810
|
+
'x-fern-sdk-return-value': 'access_grants',
|
|
29811
|
+
'x-response-key': 'access_grants',
|
|
29812
|
+
'x-title': 'List Unmanaged Access Grants',
|
|
29813
|
+
},
|
|
29814
|
+
post: {
|
|
29815
|
+
description: 'Gets unmanaged Access Grants (where is_managed = false).',
|
|
29816
|
+
operationId: 'accessGrantsUnmanagedListPost',
|
|
29817
|
+
requestBody: {
|
|
29818
|
+
content: {
|
|
29819
|
+
'application/json': {
|
|
29820
|
+
schema: {
|
|
29821
|
+
properties: {
|
|
29822
|
+
acs_entrance_id: {
|
|
29823
|
+
description:
|
|
29824
|
+
'ID of the entrance by which you want to filter the list of unmanaged Access Grants.',
|
|
29825
|
+
format: 'uuid',
|
|
29826
|
+
type: 'string',
|
|
29827
|
+
},
|
|
29828
|
+
acs_system_id: {
|
|
29829
|
+
description:
|
|
29830
|
+
'ID of the access system by which you want to filter the list of unmanaged Access Grants.',
|
|
29831
|
+
format: 'uuid',
|
|
29832
|
+
type: 'string',
|
|
29833
|
+
},
|
|
29834
|
+
user_identity_id: {
|
|
29835
|
+
description:
|
|
29836
|
+
'ID of user identity by which you want to filter the list of unmanaged Access Grants.',
|
|
29837
|
+
format: 'uuid',
|
|
29838
|
+
type: 'string',
|
|
29839
|
+
},
|
|
29840
|
+
},
|
|
29841
|
+
type: 'object',
|
|
29842
|
+
},
|
|
29843
|
+
},
|
|
29844
|
+
},
|
|
29845
|
+
},
|
|
29846
|
+
responses: {
|
|
29847
|
+
200: {
|
|
29848
|
+
content: {
|
|
29849
|
+
'application/json': {
|
|
29850
|
+
schema: {
|
|
29851
|
+
properties: {
|
|
29852
|
+
access_grants: {
|
|
29853
|
+
items: {
|
|
29854
|
+
description:
|
|
29855
|
+
'Represents an unmanaged Access Grant. Unmanaged Access Grants do not have client sessions, instant keys, customization profiles, or keys.',
|
|
29856
|
+
properties: {
|
|
29857
|
+
access_grant_id: {
|
|
29858
|
+
description: 'ID of the Access Grant.',
|
|
29859
|
+
format: 'uuid',
|
|
29860
|
+
type: 'string',
|
|
29861
|
+
},
|
|
29862
|
+
access_method_ids: {
|
|
29863
|
+
description:
|
|
29864
|
+
'IDs of the access methods created for the Access Grant.',
|
|
29865
|
+
items: { format: 'uuid', type: 'string' },
|
|
29866
|
+
type: 'array',
|
|
29867
|
+
},
|
|
29868
|
+
created_at: {
|
|
29869
|
+
description:
|
|
29870
|
+
'Date and time at which the Access Grant was created.',
|
|
29871
|
+
format: 'date-time',
|
|
29872
|
+
type: 'string',
|
|
29873
|
+
},
|
|
29874
|
+
display_name: {
|
|
29875
|
+
description: 'Display name of the Access Grant.',
|
|
29876
|
+
type: 'string',
|
|
29877
|
+
},
|
|
29878
|
+
ends_at: {
|
|
29879
|
+
description:
|
|
29880
|
+
'Date and time at which the Access Grant ends.',
|
|
29881
|
+
format: 'date-time',
|
|
29882
|
+
nullable: true,
|
|
29883
|
+
type: 'string',
|
|
29884
|
+
},
|
|
29885
|
+
location_ids: {
|
|
29886
|
+
deprecated: true,
|
|
29887
|
+
items: { format: 'uuid', type: 'string' },
|
|
29888
|
+
type: 'array',
|
|
29889
|
+
'x-deprecated': 'Use `space_ids`.',
|
|
29890
|
+
},
|
|
29891
|
+
name: {
|
|
29892
|
+
description:
|
|
29893
|
+
'Name of the Access Grant. If not provided, the display name will be computed.',
|
|
29894
|
+
nullable: true,
|
|
29895
|
+
type: 'string',
|
|
29896
|
+
},
|
|
29897
|
+
requested_access_methods: {
|
|
29898
|
+
description:
|
|
29899
|
+
'Access methods that the user requested for the Access Grant.',
|
|
29900
|
+
items: {
|
|
29901
|
+
properties: {
|
|
29902
|
+
code: {
|
|
29903
|
+
description:
|
|
29904
|
+
"Specific PIN code to use for this access method. Only applicable when mode is 'code'.",
|
|
29905
|
+
maxLength: 9,
|
|
29906
|
+
minLength: 4,
|
|
29907
|
+
pattern: '^\\d+$',
|
|
29908
|
+
type: 'string',
|
|
29909
|
+
},
|
|
29910
|
+
created_access_method_ids: {
|
|
29911
|
+
description:
|
|
29912
|
+
'IDs of the access methods created for the requested access method.',
|
|
29913
|
+
items: { format: 'uuid', type: 'string' },
|
|
29914
|
+
type: 'array',
|
|
29915
|
+
},
|
|
29916
|
+
created_at: {
|
|
29917
|
+
description:
|
|
29918
|
+
'Date and time at which the requested access method was added to the Access Grant.',
|
|
29919
|
+
format: 'date-time',
|
|
29920
|
+
type: 'string',
|
|
29921
|
+
},
|
|
29922
|
+
display_name: {
|
|
29923
|
+
description:
|
|
29924
|
+
'Display name of the access method.',
|
|
29925
|
+
type: 'string',
|
|
29926
|
+
},
|
|
29927
|
+
mode: {
|
|
29928
|
+
description:
|
|
29929
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
29930
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
29931
|
+
type: 'string',
|
|
29932
|
+
},
|
|
29933
|
+
},
|
|
29934
|
+
required: [
|
|
29935
|
+
'display_name',
|
|
29936
|
+
'mode',
|
|
29937
|
+
'created_at',
|
|
29938
|
+
'created_access_method_ids',
|
|
29939
|
+
],
|
|
29940
|
+
type: 'object',
|
|
29941
|
+
},
|
|
29942
|
+
type: 'array',
|
|
29943
|
+
},
|
|
29944
|
+
space_ids: {
|
|
29945
|
+
description:
|
|
29946
|
+
'IDs of the spaces to which the Access Grant gives access.',
|
|
29947
|
+
items: { format: 'uuid', type: 'string' },
|
|
29948
|
+
type: 'array',
|
|
29949
|
+
},
|
|
29950
|
+
starts_at: {
|
|
29951
|
+
description:
|
|
29952
|
+
'Date and time at which the Access Grant starts.',
|
|
29953
|
+
format: 'date-time',
|
|
29954
|
+
type: 'string',
|
|
29955
|
+
},
|
|
29956
|
+
user_identity_id: {
|
|
29957
|
+
description:
|
|
29958
|
+
'ID of user identity to which the Access Grant gives access.',
|
|
29959
|
+
format: 'uuid',
|
|
29960
|
+
type: 'string',
|
|
29961
|
+
},
|
|
29962
|
+
warnings: {
|
|
29963
|
+
description:
|
|
29964
|
+
'Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29965
|
+
items: {
|
|
29966
|
+
description:
|
|
29967
|
+
'Warning associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants).',
|
|
29968
|
+
discriminator: { propertyName: 'warning_code' },
|
|
29969
|
+
oneOf: [
|
|
29970
|
+
{
|
|
29971
|
+
description:
|
|
29972
|
+
'Indicates that the [access grant](https://docs.seam.co/latest/capability-guides/access-grants) is being deleted.',
|
|
29973
|
+
properties: {
|
|
29974
|
+
created_at: {
|
|
29975
|
+
description:
|
|
29976
|
+
'Date and time at which Seam created the warning.',
|
|
29977
|
+
format: 'date-time',
|
|
29978
|
+
type: 'string',
|
|
29979
|
+
},
|
|
29980
|
+
message: {
|
|
29981
|
+
description:
|
|
29982
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29983
|
+
type: 'string',
|
|
29984
|
+
},
|
|
29985
|
+
warning_code: {
|
|
29986
|
+
description:
|
|
29987
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29988
|
+
enum: ['being_deleted'],
|
|
29989
|
+
type: 'string',
|
|
29990
|
+
},
|
|
29991
|
+
},
|
|
29992
|
+
required: [
|
|
29993
|
+
'created_at',
|
|
29994
|
+
'message',
|
|
29995
|
+
'warning_code',
|
|
29996
|
+
],
|
|
29997
|
+
type: 'object',
|
|
29998
|
+
},
|
|
29999
|
+
],
|
|
30000
|
+
},
|
|
30001
|
+
type: 'array',
|
|
30002
|
+
},
|
|
30003
|
+
workspace_id: {
|
|
30004
|
+
description:
|
|
30005
|
+
'ID of the Seam workspace associated with the Access Grant.',
|
|
30006
|
+
format: 'uuid',
|
|
30007
|
+
type: 'string',
|
|
30008
|
+
},
|
|
30009
|
+
},
|
|
30010
|
+
required: [
|
|
30011
|
+
'workspace_id',
|
|
30012
|
+
'access_grant_id',
|
|
30013
|
+
'user_identity_id',
|
|
30014
|
+
'location_ids',
|
|
30015
|
+
'space_ids',
|
|
30016
|
+
'requested_access_methods',
|
|
30017
|
+
'access_method_ids',
|
|
30018
|
+
'name',
|
|
30019
|
+
'display_name',
|
|
30020
|
+
'created_at',
|
|
30021
|
+
'starts_at',
|
|
30022
|
+
'ends_at',
|
|
30023
|
+
'warnings',
|
|
30024
|
+
],
|
|
30025
|
+
type: 'object',
|
|
30026
|
+
'x-draft': 'Early access.',
|
|
30027
|
+
'x-route-path': '/access_grants/unmanaged',
|
|
30028
|
+
},
|
|
30029
|
+
type: 'array',
|
|
30030
|
+
},
|
|
30031
|
+
ok: { type: 'boolean' },
|
|
30032
|
+
},
|
|
30033
|
+
required: ['access_grants', 'ok'],
|
|
30034
|
+
type: 'object',
|
|
30035
|
+
},
|
|
30036
|
+
},
|
|
30037
|
+
},
|
|
30038
|
+
description: 'OK',
|
|
30039
|
+
},
|
|
30040
|
+
400: { description: 'Bad Request' },
|
|
30041
|
+
401: { description: 'Unauthorized' },
|
|
30042
|
+
},
|
|
30043
|
+
security: [
|
|
30044
|
+
{ pat_with_workspace: [] },
|
|
30045
|
+
{ console_session_with_workspace: [] },
|
|
30046
|
+
{ api_key: [] },
|
|
30047
|
+
{ client_session_with_customer: [] },
|
|
30048
|
+
],
|
|
30049
|
+
summary: '/access_grants/unmanaged/list',
|
|
30050
|
+
tags: [],
|
|
30051
|
+
'x-draft': 'Early access.',
|
|
30052
|
+
'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
|
|
30053
|
+
'x-fern-sdk-method-name': 'list',
|
|
30054
|
+
'x-fern-sdk-return-value': 'access_grants',
|
|
30055
|
+
'x-response-key': 'access_grants',
|
|
30056
|
+
'x-title': 'List Unmanaged Access Grants',
|
|
30057
|
+
},
|
|
30058
|
+
},
|
|
30059
|
+
'/access_grants/update': {
|
|
30060
|
+
patch: {
|
|
30061
|
+
description: "Updates an existing Access Grant's time window.",
|
|
30062
|
+
operationId: 'accessGrantsUpdatePatch',
|
|
30063
|
+
requestBody: {
|
|
30064
|
+
content: {
|
|
30065
|
+
'application/json': {
|
|
30066
|
+
schema: {
|
|
30067
|
+
properties: {
|
|
30068
|
+
access_grant_id: {
|
|
30069
|
+
description: 'ID of the Access Grant to update.',
|
|
30070
|
+
format: 'uuid',
|
|
30071
|
+
type: 'string',
|
|
30072
|
+
},
|
|
30073
|
+
ends_at: {
|
|
30074
|
+
description:
|
|
30075
|
+
'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`.',
|
|
30076
|
+
format: 'date-time',
|
|
30077
|
+
nullable: true,
|
|
30078
|
+
type: 'string',
|
|
30079
|
+
},
|
|
30080
|
+
name: {
|
|
30081
|
+
description: 'Display name for the access grant.',
|
|
30082
|
+
nullable: true,
|
|
30083
|
+
type: 'string',
|
|
30084
|
+
},
|
|
30085
|
+
starts_at: {
|
|
30086
|
+
description:
|
|
30087
|
+
'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.',
|
|
30088
|
+
format: 'date-time',
|
|
30089
|
+
type: 'string',
|
|
30090
|
+
},
|
|
30091
|
+
},
|
|
30092
|
+
required: ['access_grant_id'],
|
|
30093
|
+
type: 'object',
|
|
30094
|
+
},
|
|
30095
|
+
},
|
|
30096
|
+
},
|
|
30097
|
+
},
|
|
30098
|
+
responses: {
|
|
30099
|
+
200: {
|
|
30100
|
+
content: {
|
|
30101
|
+
'application/json': {
|
|
30102
|
+
schema: {
|
|
30103
|
+
properties: { ok: { type: 'boolean' } },
|
|
30104
|
+
required: ['ok'],
|
|
30105
|
+
type: 'object',
|
|
30106
|
+
},
|
|
30107
|
+
},
|
|
30108
|
+
},
|
|
30109
|
+
description: 'OK',
|
|
30110
|
+
},
|
|
30111
|
+
400: { description: 'Bad Request' },
|
|
30112
|
+
401: { description: 'Unauthorized' },
|
|
30113
|
+
},
|
|
30114
|
+
security: [
|
|
30115
|
+
{ pat_with_workspace: [] },
|
|
30116
|
+
{ console_session_with_workspace: [] },
|
|
30117
|
+
{ api_key: [] },
|
|
30118
|
+
{ client_session_with_customer: [] },
|
|
30119
|
+
],
|
|
30120
|
+
summary: '/access_grants/update',
|
|
30121
|
+
tags: [],
|
|
30122
|
+
'x-draft': 'Early access.',
|
|
30123
|
+
'x-fern-sdk-group-name': ['access_grants'],
|
|
30124
|
+
'x-fern-sdk-method-name': 'update',
|
|
30125
|
+
'x-response-key': null,
|
|
30126
|
+
'x-title': 'Update an Access Grant',
|
|
30127
|
+
},
|
|
30128
|
+
post: {
|
|
30129
|
+
description: "Updates an existing Access Grant's time window.",
|
|
30130
|
+
operationId: 'accessGrantsUpdatePost',
|
|
30131
|
+
requestBody: {
|
|
30132
|
+
content: {
|
|
30133
|
+
'application/json': {
|
|
30134
|
+
schema: {
|
|
30135
|
+
properties: {
|
|
30136
|
+
access_grant_id: {
|
|
30137
|
+
description: 'ID of the Access Grant to update.',
|
|
30138
|
+
format: 'uuid',
|
|
30139
|
+
type: 'string',
|
|
30140
|
+
},
|
|
30141
|
+
ends_at: {
|
|
30142
|
+
description:
|
|
30143
|
+
'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`.',
|
|
30144
|
+
format: 'date-time',
|
|
30145
|
+
nullable: true,
|
|
30146
|
+
type: 'string',
|
|
30147
|
+
},
|
|
30148
|
+
name: {
|
|
30149
|
+
description: 'Display name for the access grant.',
|
|
30150
|
+
nullable: true,
|
|
30151
|
+
type: 'string',
|
|
30152
|
+
},
|
|
30153
|
+
starts_at: {
|
|
30154
|
+
description:
|
|
30155
|
+
'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.',
|
|
30156
|
+
format: 'date-time',
|
|
30157
|
+
type: 'string',
|
|
30158
|
+
},
|
|
30159
|
+
},
|
|
30160
|
+
required: ['access_grant_id'],
|
|
30161
|
+
type: 'object',
|
|
30162
|
+
},
|
|
30163
|
+
},
|
|
30164
|
+
},
|
|
30165
|
+
},
|
|
30166
|
+
responses: {
|
|
30167
|
+
200: {
|
|
30168
|
+
content: {
|
|
30169
|
+
'application/json': {
|
|
30170
|
+
schema: {
|
|
30171
|
+
properties: { ok: { type: 'boolean' } },
|
|
30172
|
+
required: ['ok'],
|
|
30173
|
+
type: 'object',
|
|
30174
|
+
},
|
|
30175
|
+
},
|
|
30176
|
+
},
|
|
30177
|
+
description: 'OK',
|
|
30178
|
+
},
|
|
30179
|
+
400: { description: 'Bad Request' },
|
|
30180
|
+
401: { description: 'Unauthorized' },
|
|
30181
|
+
},
|
|
30182
|
+
security: [
|
|
30183
|
+
{ pat_with_workspace: [] },
|
|
30184
|
+
{ console_session_with_workspace: [] },
|
|
30185
|
+
{ api_key: [] },
|
|
30186
|
+
{ client_session_with_customer: [] },
|
|
30187
|
+
],
|
|
30188
|
+
summary: '/access_grants/update',
|
|
30189
|
+
tags: [],
|
|
30190
|
+
'x-draft': 'Early access.',
|
|
30191
|
+
'x-fern-sdk-group-name': ['access_grants'],
|
|
30192
|
+
'x-fern-sdk-method-name': 'update',
|
|
30193
|
+
'x-response-key': null,
|
|
30194
|
+
'x-title': 'Update an Access Grant',
|
|
30195
|
+
},
|
|
30196
|
+
},
|
|
30197
|
+
'/access_methods/delete': {
|
|
30198
|
+
delete: {
|
|
30199
|
+
description: 'Deletes an access method.',
|
|
30200
|
+
operationId: 'accessMethodsDeleteDelete',
|
|
30201
|
+
parameters: [
|
|
30202
|
+
{
|
|
30203
|
+
in: 'query',
|
|
30204
|
+
name: 'access_method_id',
|
|
30205
|
+
required: true,
|
|
30206
|
+
schema: {
|
|
30207
|
+
description: 'ID of access method to get.',
|
|
30208
|
+
format: 'uuid',
|
|
30209
|
+
type: 'string',
|
|
30210
|
+
},
|
|
30211
|
+
},
|
|
30212
|
+
],
|
|
30213
|
+
responses: {
|
|
30214
|
+
200: {
|
|
30215
|
+
content: {
|
|
30216
|
+
'application/json': {
|
|
30217
|
+
schema: {
|
|
30218
|
+
properties: { ok: { type: 'boolean' } },
|
|
30219
|
+
required: ['ok'],
|
|
30220
|
+
type: 'object',
|
|
30221
|
+
},
|
|
30222
|
+
},
|
|
30223
|
+
},
|
|
30224
|
+
description: 'OK',
|
|
30225
|
+
},
|
|
30226
|
+
400: { description: 'Bad Request' },
|
|
30227
|
+
401: { description: 'Unauthorized' },
|
|
30228
|
+
},
|
|
30229
|
+
security: [
|
|
30230
|
+
{ pat_with_workspace: [] },
|
|
30231
|
+
{ console_session_with_workspace: [] },
|
|
30232
|
+
{ api_key: [] },
|
|
30233
|
+
],
|
|
30234
|
+
summary: '/access_methods/delete',
|
|
30235
|
+
tags: [],
|
|
30236
|
+
'x-draft': 'Early access.',
|
|
30237
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
30238
|
+
'x-fern-sdk-method-name': 'delete',
|
|
30239
|
+
'x-response-key': null,
|
|
30240
|
+
'x-title': 'Delete an Access Method',
|
|
30241
|
+
},
|
|
30242
|
+
post: {
|
|
30243
|
+
description: 'Deletes an access method.',
|
|
30244
|
+
operationId: 'accessMethodsDeletePost',
|
|
30245
|
+
requestBody: {
|
|
30246
|
+
content: {
|
|
30247
|
+
'application/json': {
|
|
30248
|
+
schema: {
|
|
30249
|
+
properties: {
|
|
30250
|
+
access_method_id: {
|
|
30251
|
+
description: 'ID of access method to get.',
|
|
30252
|
+
format: 'uuid',
|
|
30253
|
+
type: 'string',
|
|
30254
|
+
},
|
|
30255
|
+
},
|
|
30256
|
+
required: ['access_method_id'],
|
|
30257
|
+
type: 'object',
|
|
30258
|
+
},
|
|
30259
|
+
},
|
|
30260
|
+
},
|
|
30261
|
+
},
|
|
30262
|
+
responses: {
|
|
30263
|
+
200: {
|
|
30264
|
+
content: {
|
|
30265
|
+
'application/json': {
|
|
30266
|
+
schema: {
|
|
30267
|
+
properties: { ok: { type: 'boolean' } },
|
|
30268
|
+
required: ['ok'],
|
|
30269
|
+
type: 'object',
|
|
30270
|
+
},
|
|
30271
|
+
},
|
|
30272
|
+
},
|
|
30273
|
+
description: 'OK',
|
|
30274
|
+
},
|
|
30275
|
+
400: { description: 'Bad Request' },
|
|
30276
|
+
401: { description: 'Unauthorized' },
|
|
30277
|
+
},
|
|
30278
|
+
security: [
|
|
30279
|
+
{ pat_with_workspace: [] },
|
|
30280
|
+
{ console_session_with_workspace: [] },
|
|
30281
|
+
{ api_key: [] },
|
|
30282
|
+
],
|
|
30283
|
+
summary: '/access_methods/delete',
|
|
29285
30284
|
tags: [],
|
|
29286
30285
|
'x-draft': 'Early access.',
|
|
29287
30286
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
@@ -29289,9 +30288,126 @@ export default {
|
|
|
29289
30288
|
'x-response-key': null,
|
|
29290
30289
|
'x-title': 'Delete an Access Method',
|
|
29291
30290
|
},
|
|
30291
|
+
},
|
|
30292
|
+
'/access_methods/encode': {
|
|
30293
|
+
post: {
|
|
30294
|
+
description:
|
|
30295
|
+
'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).',
|
|
30296
|
+
operationId: 'accessMethodsEncodePost',
|
|
30297
|
+
requestBody: {
|
|
30298
|
+
content: {
|
|
30299
|
+
'application/json': {
|
|
30300
|
+
schema: {
|
|
30301
|
+
properties: {
|
|
30302
|
+
access_method_id: {
|
|
30303
|
+
description:
|
|
30304
|
+
'ID of the `access_method` to encode onto a card.',
|
|
30305
|
+
format: 'uuid',
|
|
30306
|
+
type: 'string',
|
|
30307
|
+
},
|
|
30308
|
+
acs_encoder_id: {
|
|
30309
|
+
description:
|
|
30310
|
+
'ID of the `acs_encoder` to use to encode the `access_method`.',
|
|
30311
|
+
format: 'uuid',
|
|
30312
|
+
type: 'string',
|
|
30313
|
+
},
|
|
30314
|
+
},
|
|
30315
|
+
required: ['acs_encoder_id', 'access_method_id'],
|
|
30316
|
+
type: 'object',
|
|
30317
|
+
},
|
|
30318
|
+
},
|
|
30319
|
+
},
|
|
30320
|
+
},
|
|
30321
|
+
responses: {
|
|
30322
|
+
200: {
|
|
30323
|
+
content: {
|
|
30324
|
+
'application/json': {
|
|
30325
|
+
schema: {
|
|
30326
|
+
properties: {
|
|
30327
|
+
action_attempt: {
|
|
30328
|
+
$ref: '#/components/schemas/action_attempt',
|
|
30329
|
+
},
|
|
30330
|
+
ok: { type: 'boolean' },
|
|
30331
|
+
},
|
|
30332
|
+
required: ['action_attempt', 'ok'],
|
|
30333
|
+
type: 'object',
|
|
30334
|
+
},
|
|
30335
|
+
},
|
|
30336
|
+
},
|
|
30337
|
+
description: 'OK',
|
|
30338
|
+
},
|
|
30339
|
+
400: { description: 'Bad Request' },
|
|
30340
|
+
401: { description: 'Unauthorized' },
|
|
30341
|
+
},
|
|
30342
|
+
security: [
|
|
30343
|
+
{ pat_with_workspace: [] },
|
|
30344
|
+
{ console_session_with_workspace: [] },
|
|
30345
|
+
{ api_key: [] },
|
|
30346
|
+
],
|
|
30347
|
+
summary: '/access_methods/encode',
|
|
30348
|
+
tags: [],
|
|
30349
|
+
'x-action-attempt-type': 'ENCODE_CREDENTIAL',
|
|
30350
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
30351
|
+
'x-fern-sdk-method-name': 'encode',
|
|
30352
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
30353
|
+
'x-response-key': 'action_attempt',
|
|
30354
|
+
'x-title': 'Encode an Access Method',
|
|
30355
|
+
},
|
|
30356
|
+
},
|
|
30357
|
+
'/access_methods/get': {
|
|
30358
|
+
get: {
|
|
30359
|
+
description: 'Gets an access method.',
|
|
30360
|
+
operationId: 'accessMethodsGetGet',
|
|
30361
|
+
parameters: [
|
|
30362
|
+
{
|
|
30363
|
+
in: 'query',
|
|
30364
|
+
name: 'access_method_id',
|
|
30365
|
+
required: true,
|
|
30366
|
+
schema: {
|
|
30367
|
+
description: 'ID of access method to get.',
|
|
30368
|
+
format: 'uuid',
|
|
30369
|
+
type: 'string',
|
|
30370
|
+
},
|
|
30371
|
+
},
|
|
30372
|
+
],
|
|
30373
|
+
responses: {
|
|
30374
|
+
200: {
|
|
30375
|
+
content: {
|
|
30376
|
+
'application/json': {
|
|
30377
|
+
schema: {
|
|
30378
|
+
properties: {
|
|
30379
|
+
access_method: {
|
|
30380
|
+
$ref: '#/components/schemas/access_method',
|
|
30381
|
+
},
|
|
30382
|
+
ok: { type: 'boolean' },
|
|
30383
|
+
},
|
|
30384
|
+
required: ['access_method', 'ok'],
|
|
30385
|
+
type: 'object',
|
|
30386
|
+
},
|
|
30387
|
+
},
|
|
30388
|
+
},
|
|
30389
|
+
description: 'OK',
|
|
30390
|
+
},
|
|
30391
|
+
400: { description: 'Bad Request' },
|
|
30392
|
+
401: { description: 'Unauthorized' },
|
|
30393
|
+
},
|
|
30394
|
+
security: [
|
|
30395
|
+
{ pat_with_workspace: [] },
|
|
30396
|
+
{ console_session_with_workspace: [] },
|
|
30397
|
+
{ api_key: [] },
|
|
30398
|
+
],
|
|
30399
|
+
summary: '/access_methods/get',
|
|
30400
|
+
tags: [],
|
|
30401
|
+
'x-draft': 'Early access.',
|
|
30402
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
30403
|
+
'x-fern-sdk-method-name': 'get',
|
|
30404
|
+
'x-fern-sdk-return-value': 'access_method',
|
|
30405
|
+
'x-response-key': 'access_method',
|
|
30406
|
+
'x-title': 'Get an Access Method',
|
|
30407
|
+
},
|
|
29292
30408
|
post: {
|
|
29293
|
-
description: '
|
|
29294
|
-
operationId: '
|
|
30409
|
+
description: 'Gets an access method.',
|
|
30410
|
+
operationId: 'accessMethodsGetPost',
|
|
29295
30411
|
requestBody: {
|
|
29296
30412
|
content: {
|
|
29297
30413
|
'application/json': {
|
|
@@ -29302,20 +30418,268 @@ export default {
|
|
|
29302
30418
|
format: 'uuid',
|
|
29303
30419
|
type: 'string',
|
|
29304
30420
|
},
|
|
29305
|
-
},
|
|
29306
|
-
required: ['access_method_id'],
|
|
29307
|
-
type: 'object',
|
|
29308
|
-
},
|
|
29309
|
-
},
|
|
29310
|
-
},
|
|
29311
|
-
},
|
|
29312
|
-
responses: {
|
|
29313
|
-
200: {
|
|
29314
|
-
content: {
|
|
29315
|
-
'application/json': {
|
|
29316
|
-
schema: {
|
|
29317
|
-
properties: {
|
|
29318
|
-
|
|
30421
|
+
},
|
|
30422
|
+
required: ['access_method_id'],
|
|
30423
|
+
type: 'object',
|
|
30424
|
+
},
|
|
30425
|
+
},
|
|
30426
|
+
},
|
|
30427
|
+
},
|
|
30428
|
+
responses: {
|
|
30429
|
+
200: {
|
|
30430
|
+
content: {
|
|
30431
|
+
'application/json': {
|
|
30432
|
+
schema: {
|
|
30433
|
+
properties: {
|
|
30434
|
+
access_method: {
|
|
30435
|
+
$ref: '#/components/schemas/access_method',
|
|
30436
|
+
},
|
|
30437
|
+
ok: { type: 'boolean' },
|
|
30438
|
+
},
|
|
30439
|
+
required: ['access_method', 'ok'],
|
|
30440
|
+
type: 'object',
|
|
30441
|
+
},
|
|
30442
|
+
},
|
|
30443
|
+
},
|
|
30444
|
+
description: 'OK',
|
|
30445
|
+
},
|
|
30446
|
+
400: { description: 'Bad Request' },
|
|
30447
|
+
401: { description: 'Unauthorized' },
|
|
30448
|
+
},
|
|
30449
|
+
security: [
|
|
30450
|
+
{ pat_with_workspace: [] },
|
|
30451
|
+
{ console_session_with_workspace: [] },
|
|
30452
|
+
{ api_key: [] },
|
|
30453
|
+
],
|
|
30454
|
+
summary: '/access_methods/get',
|
|
30455
|
+
tags: [],
|
|
30456
|
+
'x-draft': 'Early access.',
|
|
30457
|
+
'x-fern-sdk-group-name': ['access_methods'],
|
|
30458
|
+
'x-fern-sdk-method-name': 'get',
|
|
30459
|
+
'x-fern-sdk-return-value': 'access_method',
|
|
30460
|
+
'x-response-key': 'access_method',
|
|
30461
|
+
'x-title': 'Get an Access Method',
|
|
30462
|
+
},
|
|
30463
|
+
},
|
|
30464
|
+
'/access_methods/get_related': {
|
|
30465
|
+
get: {
|
|
30466
|
+
description:
|
|
30467
|
+
'Gets all related resources for one or more Access Methods.',
|
|
30468
|
+
operationId: 'accessMethodsGetRelatedGet',
|
|
30469
|
+
parameters: [
|
|
30470
|
+
{
|
|
30471
|
+
in: 'query',
|
|
30472
|
+
name: 'access_method_ids',
|
|
30473
|
+
required: true,
|
|
30474
|
+
schema: {
|
|
30475
|
+
description:
|
|
30476
|
+
'IDs of the access methods that you want to get along with their related resources.',
|
|
30477
|
+
items: { format: 'uuid', type: 'string' },
|
|
30478
|
+
type: 'array',
|
|
30479
|
+
},
|
|
30480
|
+
},
|
|
30481
|
+
{
|
|
30482
|
+
in: 'query',
|
|
30483
|
+
name: 'include',
|
|
30484
|
+
required: false,
|
|
30485
|
+
schema: {
|
|
30486
|
+
items: {
|
|
30487
|
+
enum: [
|
|
30488
|
+
'spaces',
|
|
30489
|
+
'devices',
|
|
30490
|
+
'acs_entrances',
|
|
30491
|
+
'access_grants',
|
|
30492
|
+
'access_methods',
|
|
30493
|
+
'instant_keys',
|
|
30494
|
+
'client_sessions',
|
|
30495
|
+
],
|
|
30496
|
+
type: 'string',
|
|
30497
|
+
},
|
|
30498
|
+
type: 'array',
|
|
30499
|
+
},
|
|
30500
|
+
},
|
|
30501
|
+
{
|
|
30502
|
+
in: 'query',
|
|
30503
|
+
name: 'exclude',
|
|
30504
|
+
required: false,
|
|
30505
|
+
schema: {
|
|
30506
|
+
items: {
|
|
30507
|
+
enum: [
|
|
30508
|
+
'spaces',
|
|
30509
|
+
'devices',
|
|
30510
|
+
'acs_entrances',
|
|
30511
|
+
'access_grants',
|
|
30512
|
+
'access_methods',
|
|
30513
|
+
'instant_keys',
|
|
30514
|
+
'client_sessions',
|
|
30515
|
+
],
|
|
30516
|
+
type: 'string',
|
|
30517
|
+
},
|
|
30518
|
+
type: 'array',
|
|
30519
|
+
},
|
|
30520
|
+
},
|
|
30521
|
+
],
|
|
30522
|
+
responses: {
|
|
30523
|
+
200: {
|
|
30524
|
+
content: {
|
|
30525
|
+
'application/json': {
|
|
30526
|
+
schema: {
|
|
30527
|
+
properties: {
|
|
30528
|
+
batch: {
|
|
30529
|
+
description: 'A batch of workspace resources.',
|
|
30530
|
+
properties: {
|
|
30531
|
+
access_codes: {
|
|
30532
|
+
items: { $ref: '#/components/schemas/access_code' },
|
|
30533
|
+
type: 'array',
|
|
30534
|
+
},
|
|
30535
|
+
access_grants: {
|
|
30536
|
+
items: { $ref: '#/components/schemas/access_grant' },
|
|
30537
|
+
type: 'array',
|
|
30538
|
+
},
|
|
30539
|
+
access_methods: {
|
|
30540
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
30541
|
+
type: 'array',
|
|
30542
|
+
},
|
|
30543
|
+
acs_access_groups: {
|
|
30544
|
+
items: {
|
|
30545
|
+
$ref: '#/components/schemas/acs_access_group',
|
|
30546
|
+
},
|
|
30547
|
+
type: 'array',
|
|
30548
|
+
},
|
|
30549
|
+
acs_credentials: {
|
|
30550
|
+
items: {
|
|
30551
|
+
$ref: '#/components/schemas/acs_credential',
|
|
30552
|
+
},
|
|
30553
|
+
type: 'array',
|
|
30554
|
+
},
|
|
30555
|
+
acs_encoders: {
|
|
30556
|
+
items: { $ref: '#/components/schemas/acs_encoder' },
|
|
30557
|
+
type: 'array',
|
|
30558
|
+
},
|
|
30559
|
+
acs_entrances: {
|
|
30560
|
+
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
30561
|
+
type: 'array',
|
|
30562
|
+
},
|
|
30563
|
+
acs_systems: {
|
|
30564
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
30565
|
+
type: 'array',
|
|
30566
|
+
},
|
|
30567
|
+
acs_users: {
|
|
30568
|
+
items: { $ref: '#/components/schemas/acs_user' },
|
|
30569
|
+
type: 'array',
|
|
30570
|
+
},
|
|
30571
|
+
action_attempts: {
|
|
30572
|
+
items: {
|
|
30573
|
+
$ref: '#/components/schemas/action_attempt',
|
|
30574
|
+
},
|
|
30575
|
+
type: 'array',
|
|
30576
|
+
},
|
|
30577
|
+
batch_type: {
|
|
30578
|
+
enum: [
|
|
30579
|
+
'workspaces',
|
|
30580
|
+
'spaces',
|
|
30581
|
+
'access_grants',
|
|
30582
|
+
'access_methods',
|
|
30583
|
+
],
|
|
30584
|
+
type: 'string',
|
|
30585
|
+
},
|
|
30586
|
+
client_sessions: {
|
|
30587
|
+
items: {
|
|
30588
|
+
$ref: '#/components/schemas/client_session',
|
|
30589
|
+
},
|
|
30590
|
+
type: 'array',
|
|
30591
|
+
},
|
|
30592
|
+
connect_webviews: {
|
|
30593
|
+
items: {
|
|
30594
|
+
$ref: '#/components/schemas/connect_webview',
|
|
30595
|
+
},
|
|
30596
|
+
type: 'array',
|
|
30597
|
+
},
|
|
30598
|
+
customization_profiles: {
|
|
30599
|
+
items: {
|
|
30600
|
+
$ref: '#/components/schemas/customization_profile',
|
|
30601
|
+
},
|
|
30602
|
+
type: 'array',
|
|
30603
|
+
},
|
|
30604
|
+
devices: {
|
|
30605
|
+
items: { $ref: '#/components/schemas/device' },
|
|
30606
|
+
type: 'array',
|
|
30607
|
+
},
|
|
30608
|
+
events: {
|
|
30609
|
+
items: { $ref: '#/components/schemas/event' },
|
|
30610
|
+
type: 'array',
|
|
30611
|
+
},
|
|
30612
|
+
instant_keys: {
|
|
30613
|
+
items: { $ref: '#/components/schemas/instant_key' },
|
|
30614
|
+
type: 'array',
|
|
30615
|
+
},
|
|
30616
|
+
noise_thresholds: {
|
|
30617
|
+
items: {
|
|
30618
|
+
$ref: '#/components/schemas/noise_threshold',
|
|
30619
|
+
},
|
|
30620
|
+
type: 'array',
|
|
30621
|
+
},
|
|
30622
|
+
spaces: {
|
|
30623
|
+
items: { $ref: '#/components/schemas/space' },
|
|
30624
|
+
type: 'array',
|
|
30625
|
+
},
|
|
30626
|
+
thermostat_daily_programs: {
|
|
30627
|
+
items: {
|
|
30628
|
+
$ref: '#/components/schemas/thermostat_daily_program',
|
|
30629
|
+
},
|
|
30630
|
+
type: 'array',
|
|
30631
|
+
},
|
|
30632
|
+
thermostat_schedules: {
|
|
30633
|
+
items: {
|
|
30634
|
+
$ref: '#/components/schemas/thermostat_schedule',
|
|
30635
|
+
},
|
|
30636
|
+
type: 'array',
|
|
30637
|
+
},
|
|
30638
|
+
unmanaged_access_codes: {
|
|
30639
|
+
items: {
|
|
30640
|
+
$ref: '#/components/schemas/unmanaged_access_code',
|
|
30641
|
+
},
|
|
30642
|
+
type: 'array',
|
|
30643
|
+
},
|
|
30644
|
+
unmanaged_acs_access_groups: {
|
|
30645
|
+
items: {
|
|
30646
|
+
$ref: '#/components/schemas/unmanaged_acs_access_group',
|
|
30647
|
+
},
|
|
30648
|
+
type: 'array',
|
|
30649
|
+
},
|
|
30650
|
+
unmanaged_acs_credentials: {
|
|
30651
|
+
items: {
|
|
30652
|
+
$ref: '#/components/schemas/unmanaged_acs_credential',
|
|
30653
|
+
},
|
|
30654
|
+
type: 'array',
|
|
30655
|
+
},
|
|
30656
|
+
unmanaged_acs_users: {
|
|
30657
|
+
items: {
|
|
30658
|
+
$ref: '#/components/schemas/unmanaged_acs_user',
|
|
30659
|
+
},
|
|
30660
|
+
type: 'array',
|
|
30661
|
+
},
|
|
30662
|
+
unmanaged_devices: {
|
|
30663
|
+
items: {
|
|
30664
|
+
$ref: '#/components/schemas/unmanaged_device',
|
|
30665
|
+
},
|
|
30666
|
+
type: 'array',
|
|
30667
|
+
},
|
|
30668
|
+
user_identities: {
|
|
30669
|
+
items: { $ref: '#/components/schemas/user_identity' },
|
|
30670
|
+
type: 'array',
|
|
30671
|
+
},
|
|
30672
|
+
workspaces: {
|
|
30673
|
+
items: { $ref: '#/components/schemas/workspace' },
|
|
30674
|
+
type: 'array',
|
|
30675
|
+
},
|
|
30676
|
+
},
|
|
30677
|
+
required: ['batch_type'],
|
|
30678
|
+
type: 'object',
|
|
30679
|
+
},
|
|
30680
|
+
ok: { type: 'boolean' },
|
|
30681
|
+
},
|
|
30682
|
+
required: ['batch', 'ok'],
|
|
29319
30683
|
type: 'object',
|
|
29320
30684
|
},
|
|
29321
30685
|
},
|
|
@@ -29330,39 +30694,63 @@ export default {
|
|
|
29330
30694
|
{ console_session_with_workspace: [] },
|
|
29331
30695
|
{ api_key: [] },
|
|
29332
30696
|
],
|
|
29333
|
-
summary: '/access_methods/
|
|
30697
|
+
summary: '/access_methods/get_related',
|
|
29334
30698
|
tags: [],
|
|
30699
|
+
'x-batch-type': 'access_methods',
|
|
29335
30700
|
'x-draft': 'Early access.',
|
|
29336
30701
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
29337
|
-
'x-fern-sdk-method-name': '
|
|
29338
|
-
'x-
|
|
29339
|
-
'x-
|
|
30702
|
+
'x-fern-sdk-method-name': 'get_related',
|
|
30703
|
+
'x-fern-sdk-return-value': 'batch',
|
|
30704
|
+
'x-response-key': 'batch',
|
|
30705
|
+
'x-title': 'Get related Access Method resources',
|
|
29340
30706
|
},
|
|
29341
|
-
},
|
|
29342
|
-
'/access_methods/encode': {
|
|
29343
30707
|
post: {
|
|
29344
30708
|
description:
|
|
29345
|
-
'
|
|
29346
|
-
operationId: '
|
|
30709
|
+
'Gets all related resources for one or more Access Methods.',
|
|
30710
|
+
operationId: 'accessMethodsGetRelatedPost',
|
|
29347
30711
|
requestBody: {
|
|
29348
30712
|
content: {
|
|
29349
30713
|
'application/json': {
|
|
29350
30714
|
schema: {
|
|
29351
30715
|
properties: {
|
|
29352
|
-
|
|
30716
|
+
access_method_ids: {
|
|
29353
30717
|
description:
|
|
29354
|
-
'
|
|
29355
|
-
format: 'uuid',
|
|
29356
|
-
type: '
|
|
30718
|
+
'IDs of the access methods that you want to get along with their related resources.',
|
|
30719
|
+
items: { format: 'uuid', type: 'string' },
|
|
30720
|
+
type: 'array',
|
|
29357
30721
|
},
|
|
29358
|
-
|
|
29359
|
-
|
|
29360
|
-
|
|
29361
|
-
|
|
29362
|
-
|
|
30722
|
+
exclude: {
|
|
30723
|
+
items: {
|
|
30724
|
+
enum: [
|
|
30725
|
+
'spaces',
|
|
30726
|
+
'devices',
|
|
30727
|
+
'acs_entrances',
|
|
30728
|
+
'access_grants',
|
|
30729
|
+
'access_methods',
|
|
30730
|
+
'instant_keys',
|
|
30731
|
+
'client_sessions',
|
|
30732
|
+
],
|
|
30733
|
+
type: 'string',
|
|
30734
|
+
},
|
|
30735
|
+
type: 'array',
|
|
30736
|
+
},
|
|
30737
|
+
include: {
|
|
30738
|
+
items: {
|
|
30739
|
+
enum: [
|
|
30740
|
+
'spaces',
|
|
30741
|
+
'devices',
|
|
30742
|
+
'acs_entrances',
|
|
30743
|
+
'access_grants',
|
|
30744
|
+
'access_methods',
|
|
30745
|
+
'instant_keys',
|
|
30746
|
+
'client_sessions',
|
|
30747
|
+
],
|
|
30748
|
+
type: 'string',
|
|
30749
|
+
},
|
|
30750
|
+
type: 'array',
|
|
29363
30751
|
},
|
|
29364
30752
|
},
|
|
29365
|
-
required: ['
|
|
30753
|
+
required: ['access_method_ids'],
|
|
29366
30754
|
type: 'object',
|
|
29367
30755
|
},
|
|
29368
30756
|
},
|
|
@@ -29374,12 +30762,161 @@ export default {
|
|
|
29374
30762
|
'application/json': {
|
|
29375
30763
|
schema: {
|
|
29376
30764
|
properties: {
|
|
29377
|
-
|
|
29378
|
-
|
|
30765
|
+
batch: {
|
|
30766
|
+
description: 'A batch of workspace resources.',
|
|
30767
|
+
properties: {
|
|
30768
|
+
access_codes: {
|
|
30769
|
+
items: { $ref: '#/components/schemas/access_code' },
|
|
30770
|
+
type: 'array',
|
|
30771
|
+
},
|
|
30772
|
+
access_grants: {
|
|
30773
|
+
items: { $ref: '#/components/schemas/access_grant' },
|
|
30774
|
+
type: 'array',
|
|
30775
|
+
},
|
|
30776
|
+
access_methods: {
|
|
30777
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
30778
|
+
type: 'array',
|
|
30779
|
+
},
|
|
30780
|
+
acs_access_groups: {
|
|
30781
|
+
items: {
|
|
30782
|
+
$ref: '#/components/schemas/acs_access_group',
|
|
30783
|
+
},
|
|
30784
|
+
type: 'array',
|
|
30785
|
+
},
|
|
30786
|
+
acs_credentials: {
|
|
30787
|
+
items: {
|
|
30788
|
+
$ref: '#/components/schemas/acs_credential',
|
|
30789
|
+
},
|
|
30790
|
+
type: 'array',
|
|
30791
|
+
},
|
|
30792
|
+
acs_encoders: {
|
|
30793
|
+
items: { $ref: '#/components/schemas/acs_encoder' },
|
|
30794
|
+
type: 'array',
|
|
30795
|
+
},
|
|
30796
|
+
acs_entrances: {
|
|
30797
|
+
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
30798
|
+
type: 'array',
|
|
30799
|
+
},
|
|
30800
|
+
acs_systems: {
|
|
30801
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
30802
|
+
type: 'array',
|
|
30803
|
+
},
|
|
30804
|
+
acs_users: {
|
|
30805
|
+
items: { $ref: '#/components/schemas/acs_user' },
|
|
30806
|
+
type: 'array',
|
|
30807
|
+
},
|
|
30808
|
+
action_attempts: {
|
|
30809
|
+
items: {
|
|
30810
|
+
$ref: '#/components/schemas/action_attempt',
|
|
30811
|
+
},
|
|
30812
|
+
type: 'array',
|
|
30813
|
+
},
|
|
30814
|
+
batch_type: {
|
|
30815
|
+
enum: [
|
|
30816
|
+
'workspaces',
|
|
30817
|
+
'spaces',
|
|
30818
|
+
'access_grants',
|
|
30819
|
+
'access_methods',
|
|
30820
|
+
],
|
|
30821
|
+
type: 'string',
|
|
30822
|
+
},
|
|
30823
|
+
client_sessions: {
|
|
30824
|
+
items: {
|
|
30825
|
+
$ref: '#/components/schemas/client_session',
|
|
30826
|
+
},
|
|
30827
|
+
type: 'array',
|
|
30828
|
+
},
|
|
30829
|
+
connect_webviews: {
|
|
30830
|
+
items: {
|
|
30831
|
+
$ref: '#/components/schemas/connect_webview',
|
|
30832
|
+
},
|
|
30833
|
+
type: 'array',
|
|
30834
|
+
},
|
|
30835
|
+
customization_profiles: {
|
|
30836
|
+
items: {
|
|
30837
|
+
$ref: '#/components/schemas/customization_profile',
|
|
30838
|
+
},
|
|
30839
|
+
type: 'array',
|
|
30840
|
+
},
|
|
30841
|
+
devices: {
|
|
30842
|
+
items: { $ref: '#/components/schemas/device' },
|
|
30843
|
+
type: 'array',
|
|
30844
|
+
},
|
|
30845
|
+
events: {
|
|
30846
|
+
items: { $ref: '#/components/schemas/event' },
|
|
30847
|
+
type: 'array',
|
|
30848
|
+
},
|
|
30849
|
+
instant_keys: {
|
|
30850
|
+
items: { $ref: '#/components/schemas/instant_key' },
|
|
30851
|
+
type: 'array',
|
|
30852
|
+
},
|
|
30853
|
+
noise_thresholds: {
|
|
30854
|
+
items: {
|
|
30855
|
+
$ref: '#/components/schemas/noise_threshold',
|
|
30856
|
+
},
|
|
30857
|
+
type: 'array',
|
|
30858
|
+
},
|
|
30859
|
+
spaces: {
|
|
30860
|
+
items: { $ref: '#/components/schemas/space' },
|
|
30861
|
+
type: 'array',
|
|
30862
|
+
},
|
|
30863
|
+
thermostat_daily_programs: {
|
|
30864
|
+
items: {
|
|
30865
|
+
$ref: '#/components/schemas/thermostat_daily_program',
|
|
30866
|
+
},
|
|
30867
|
+
type: 'array',
|
|
30868
|
+
},
|
|
30869
|
+
thermostat_schedules: {
|
|
30870
|
+
items: {
|
|
30871
|
+
$ref: '#/components/schemas/thermostat_schedule',
|
|
30872
|
+
},
|
|
30873
|
+
type: 'array',
|
|
30874
|
+
},
|
|
30875
|
+
unmanaged_access_codes: {
|
|
30876
|
+
items: {
|
|
30877
|
+
$ref: '#/components/schemas/unmanaged_access_code',
|
|
30878
|
+
},
|
|
30879
|
+
type: 'array',
|
|
30880
|
+
},
|
|
30881
|
+
unmanaged_acs_access_groups: {
|
|
30882
|
+
items: {
|
|
30883
|
+
$ref: '#/components/schemas/unmanaged_acs_access_group',
|
|
30884
|
+
},
|
|
30885
|
+
type: 'array',
|
|
30886
|
+
},
|
|
30887
|
+
unmanaged_acs_credentials: {
|
|
30888
|
+
items: {
|
|
30889
|
+
$ref: '#/components/schemas/unmanaged_acs_credential',
|
|
30890
|
+
},
|
|
30891
|
+
type: 'array',
|
|
30892
|
+
},
|
|
30893
|
+
unmanaged_acs_users: {
|
|
30894
|
+
items: {
|
|
30895
|
+
$ref: '#/components/schemas/unmanaged_acs_user',
|
|
30896
|
+
},
|
|
30897
|
+
type: 'array',
|
|
30898
|
+
},
|
|
30899
|
+
unmanaged_devices: {
|
|
30900
|
+
items: {
|
|
30901
|
+
$ref: '#/components/schemas/unmanaged_device',
|
|
30902
|
+
},
|
|
30903
|
+
type: 'array',
|
|
30904
|
+
},
|
|
30905
|
+
user_identities: {
|
|
30906
|
+
items: { $ref: '#/components/schemas/user_identity' },
|
|
30907
|
+
type: 'array',
|
|
30908
|
+
},
|
|
30909
|
+
workspaces: {
|
|
30910
|
+
items: { $ref: '#/components/schemas/workspace' },
|
|
30911
|
+
type: 'array',
|
|
30912
|
+
},
|
|
30913
|
+
},
|
|
30914
|
+
required: ['batch_type'],
|
|
30915
|
+
type: 'object',
|
|
29379
30916
|
},
|
|
29380
30917
|
ok: { type: 'boolean' },
|
|
29381
30918
|
},
|
|
29382
|
-
required: ['
|
|
30919
|
+
required: ['batch', 'ok'],
|
|
29383
30920
|
type: 'object',
|
|
29384
30921
|
},
|
|
29385
30922
|
},
|
|
@@ -29394,27 +30931,62 @@ export default {
|
|
|
29394
30931
|
{ console_session_with_workspace: [] },
|
|
29395
30932
|
{ api_key: [] },
|
|
29396
30933
|
],
|
|
29397
|
-
summary: '/access_methods/
|
|
30934
|
+
summary: '/access_methods/get_related',
|
|
29398
30935
|
tags: [],
|
|
29399
|
-
'x-
|
|
30936
|
+
'x-batch-type': 'access_methods',
|
|
30937
|
+
'x-draft': 'Early access.',
|
|
29400
30938
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
29401
|
-
'x-fern-sdk-method-name': '
|
|
29402
|
-
'x-fern-sdk-return-value': '
|
|
29403
|
-
'x-response-key': '
|
|
29404
|
-
'x-title': '
|
|
30939
|
+
'x-fern-sdk-method-name': 'get_related',
|
|
30940
|
+
'x-fern-sdk-return-value': 'batch',
|
|
30941
|
+
'x-response-key': 'batch',
|
|
30942
|
+
'x-title': 'Get related Access Method resources',
|
|
29405
30943
|
},
|
|
29406
30944
|
},
|
|
29407
|
-
'/access_methods/
|
|
30945
|
+
'/access_methods/list': {
|
|
29408
30946
|
get: {
|
|
29409
|
-
description:
|
|
29410
|
-
|
|
30947
|
+
description:
|
|
30948
|
+
'Lists all access methods, usually filtered by Access Grant.',
|
|
30949
|
+
operationId: 'accessMethodsListGet',
|
|
29411
30950
|
parameters: [
|
|
29412
30951
|
{
|
|
29413
30952
|
in: 'query',
|
|
29414
|
-
name: '
|
|
30953
|
+
name: 'access_grant_id',
|
|
29415
30954
|
required: true,
|
|
29416
30955
|
schema: {
|
|
29417
|
-
description: 'ID of
|
|
30956
|
+
description: 'ID of Access Grant to list access methods for.',
|
|
30957
|
+
format: 'uuid',
|
|
30958
|
+
type: 'string',
|
|
30959
|
+
},
|
|
30960
|
+
},
|
|
30961
|
+
{
|
|
30962
|
+
in: 'query',
|
|
30963
|
+
name: 'device_id',
|
|
30964
|
+
required: false,
|
|
30965
|
+
schema: {
|
|
30966
|
+
description:
|
|
30967
|
+
'ID of the device for which you want to retrieve all access methods.',
|
|
30968
|
+
format: 'uuid',
|
|
30969
|
+
type: 'string',
|
|
30970
|
+
},
|
|
30971
|
+
},
|
|
30972
|
+
{
|
|
30973
|
+
in: 'query',
|
|
30974
|
+
name: 'acs_entrance_id',
|
|
30975
|
+
required: false,
|
|
30976
|
+
schema: {
|
|
30977
|
+
description:
|
|
30978
|
+
'ID of the entrance for which you want to retrieve all access methods.',
|
|
30979
|
+
format: 'uuid',
|
|
30980
|
+
type: 'string',
|
|
30981
|
+
},
|
|
30982
|
+
},
|
|
30983
|
+
{
|
|
30984
|
+
in: 'query',
|
|
30985
|
+
name: 'space_id',
|
|
30986
|
+
required: false,
|
|
30987
|
+
schema: {
|
|
30988
|
+
description:
|
|
30989
|
+
'ID of the space for which you want to retrieve all access methods.',
|
|
29418
30990
|
format: 'uuid',
|
|
29419
30991
|
type: 'string',
|
|
29420
30992
|
},
|
|
@@ -29426,12 +30998,13 @@ export default {
|
|
|
29426
30998
|
'application/json': {
|
|
29427
30999
|
schema: {
|
|
29428
31000
|
properties: {
|
|
29429
|
-
|
|
29430
|
-
$ref: '#/components/schemas/access_method',
|
|
31001
|
+
access_methods: {
|
|
31002
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
31003
|
+
type: 'array',
|
|
29431
31004
|
},
|
|
29432
31005
|
ok: { type: 'boolean' },
|
|
29433
31006
|
},
|
|
29434
|
-
required: ['
|
|
31007
|
+
required: ['access_methods', 'ok'],
|
|
29435
31008
|
type: 'object',
|
|
29436
31009
|
},
|
|
29437
31010
|
},
|
|
@@ -29446,30 +31019,50 @@ export default {
|
|
|
29446
31019
|
{ console_session_with_workspace: [] },
|
|
29447
31020
|
{ api_key: [] },
|
|
29448
31021
|
],
|
|
29449
|
-
summary: '/access_methods/
|
|
31022
|
+
summary: '/access_methods/list',
|
|
29450
31023
|
tags: [],
|
|
29451
31024
|
'x-draft': 'Early access.',
|
|
29452
31025
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
29453
|
-
'x-fern-sdk-method-name': '
|
|
29454
|
-
'x-fern-sdk-return-value': '
|
|
29455
|
-
'x-response-key': '
|
|
29456
|
-
'x-title': '
|
|
31026
|
+
'x-fern-sdk-method-name': 'list',
|
|
31027
|
+
'x-fern-sdk-return-value': 'access_methods',
|
|
31028
|
+
'x-response-key': 'access_methods',
|
|
31029
|
+
'x-title': 'List Access Methods',
|
|
29457
31030
|
},
|
|
29458
31031
|
post: {
|
|
29459
|
-
description:
|
|
29460
|
-
|
|
31032
|
+
description:
|
|
31033
|
+
'Lists all access methods, usually filtered by Access Grant.',
|
|
31034
|
+
operationId: 'accessMethodsListPost',
|
|
29461
31035
|
requestBody: {
|
|
29462
31036
|
content: {
|
|
29463
31037
|
'application/json': {
|
|
29464
31038
|
schema: {
|
|
29465
31039
|
properties: {
|
|
29466
|
-
|
|
29467
|
-
description:
|
|
31040
|
+
access_grant_id: {
|
|
31041
|
+
description:
|
|
31042
|
+
'ID of Access Grant to list access methods for.',
|
|
31043
|
+
format: 'uuid',
|
|
31044
|
+
type: 'string',
|
|
31045
|
+
},
|
|
31046
|
+
acs_entrance_id: {
|
|
31047
|
+
description:
|
|
31048
|
+
'ID of the entrance for which you want to retrieve all access methods.',
|
|
31049
|
+
format: 'uuid',
|
|
31050
|
+
type: 'string',
|
|
31051
|
+
},
|
|
31052
|
+
device_id: {
|
|
31053
|
+
description:
|
|
31054
|
+
'ID of the device for which you want to retrieve all access methods.',
|
|
31055
|
+
format: 'uuid',
|
|
31056
|
+
type: 'string',
|
|
31057
|
+
},
|
|
31058
|
+
space_id: {
|
|
31059
|
+
description:
|
|
31060
|
+
'ID of the space for which you want to retrieve all access methods.',
|
|
29468
31061
|
format: 'uuid',
|
|
29469
31062
|
type: 'string',
|
|
29470
31063
|
},
|
|
29471
31064
|
},
|
|
29472
|
-
required: ['
|
|
31065
|
+
required: ['access_grant_id'],
|
|
29473
31066
|
type: 'object',
|
|
29474
31067
|
},
|
|
29475
31068
|
},
|
|
@@ -29481,12 +31074,13 @@ export default {
|
|
|
29481
31074
|
'application/json': {
|
|
29482
31075
|
schema: {
|
|
29483
31076
|
properties: {
|
|
29484
|
-
|
|
29485
|
-
$ref: '#/components/schemas/access_method',
|
|
31077
|
+
access_methods: {
|
|
31078
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
31079
|
+
type: 'array',
|
|
29486
31080
|
},
|
|
29487
31081
|
ok: { type: 'boolean' },
|
|
29488
31082
|
},
|
|
29489
|
-
required: ['
|
|
31083
|
+
required: ['access_methods', 'ok'],
|
|
29490
31084
|
type: 'object',
|
|
29491
31085
|
},
|
|
29492
31086
|
},
|
|
@@ -29501,71 +31095,30 @@ export default {
|
|
|
29501
31095
|
{ console_session_with_workspace: [] },
|
|
29502
31096
|
{ api_key: [] },
|
|
29503
31097
|
],
|
|
29504
|
-
summary: '/access_methods/
|
|
31098
|
+
summary: '/access_methods/list',
|
|
29505
31099
|
tags: [],
|
|
29506
31100
|
'x-draft': 'Early access.',
|
|
29507
31101
|
'x-fern-sdk-group-name': ['access_methods'],
|
|
29508
|
-
'x-fern-sdk-method-name': '
|
|
29509
|
-
'x-fern-sdk-return-value': '
|
|
29510
|
-
'x-response-key': '
|
|
29511
|
-
'x-title': '
|
|
31102
|
+
'x-fern-sdk-method-name': 'list',
|
|
31103
|
+
'x-fern-sdk-return-value': 'access_methods',
|
|
31104
|
+
'x-response-key': 'access_methods',
|
|
31105
|
+
'x-title': 'List Access Methods',
|
|
29512
31106
|
},
|
|
29513
31107
|
},
|
|
29514
|
-
'/access_methods/
|
|
31108
|
+
'/access_methods/unmanaged/get': {
|
|
29515
31109
|
get: {
|
|
29516
31110
|
description:
|
|
29517
|
-
'Gets
|
|
29518
|
-
operationId: '
|
|
31111
|
+
'Gets an unmanaged access method (where is_managed = false).',
|
|
31112
|
+
operationId: 'accessMethodsUnmanagedGetGet',
|
|
29519
31113
|
parameters: [
|
|
29520
31114
|
{
|
|
29521
31115
|
in: 'query',
|
|
29522
|
-
name: '
|
|
31116
|
+
name: 'access_method_id',
|
|
29523
31117
|
required: true,
|
|
29524
31118
|
schema: {
|
|
29525
|
-
description:
|
|
29526
|
-
|
|
29527
|
-
|
|
29528
|
-
type: 'array',
|
|
29529
|
-
},
|
|
29530
|
-
},
|
|
29531
|
-
{
|
|
29532
|
-
in: 'query',
|
|
29533
|
-
name: 'include',
|
|
29534
|
-
required: false,
|
|
29535
|
-
schema: {
|
|
29536
|
-
items: {
|
|
29537
|
-
enum: [
|
|
29538
|
-
'spaces',
|
|
29539
|
-
'devices',
|
|
29540
|
-
'acs_entrances',
|
|
29541
|
-
'access_grants',
|
|
29542
|
-
'access_methods',
|
|
29543
|
-
'instant_keys',
|
|
29544
|
-
'client_sessions',
|
|
29545
|
-
],
|
|
29546
|
-
type: 'string',
|
|
29547
|
-
},
|
|
29548
|
-
type: 'array',
|
|
29549
|
-
},
|
|
29550
|
-
},
|
|
29551
|
-
{
|
|
29552
|
-
in: 'query',
|
|
29553
|
-
name: 'exclude',
|
|
29554
|
-
required: false,
|
|
29555
|
-
schema: {
|
|
29556
|
-
items: {
|
|
29557
|
-
enum: [
|
|
29558
|
-
'spaces',
|
|
29559
|
-
'devices',
|
|
29560
|
-
'acs_entrances',
|
|
29561
|
-
'access_grants',
|
|
29562
|
-
'access_methods',
|
|
29563
|
-
'instant_keys',
|
|
29564
|
-
'client_sessions',
|
|
29565
|
-
],
|
|
29566
|
-
type: 'string',
|
|
29567
|
-
},
|
|
29568
|
-
type: 'array',
|
|
31119
|
+
description: 'ID of unmanaged access method to get.',
|
|
31120
|
+
format: 'uuid',
|
|
31121
|
+
type: 'string',
|
|
29569
31122
|
},
|
|
29570
31123
|
},
|
|
29571
31124
|
],
|
|
@@ -29575,161 +31128,119 @@ export default {
|
|
|
29575
31128
|
'application/json': {
|
|
29576
31129
|
schema: {
|
|
29577
31130
|
properties: {
|
|
29578
|
-
|
|
29579
|
-
description:
|
|
31131
|
+
access_method: {
|
|
31132
|
+
description:
|
|
31133
|
+
'Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.',
|
|
29580
31134
|
properties: {
|
|
29581
|
-
|
|
29582
|
-
|
|
29583
|
-
|
|
29584
|
-
},
|
|
29585
|
-
access_grants: {
|
|
29586
|
-
items: { $ref: '#/components/schemas/access_grant' },
|
|
29587
|
-
type: 'array',
|
|
29588
|
-
},
|
|
29589
|
-
access_methods: {
|
|
29590
|
-
items: { $ref: '#/components/schemas/access_method' },
|
|
29591
|
-
type: 'array',
|
|
29592
|
-
},
|
|
29593
|
-
acs_access_groups: {
|
|
29594
|
-
items: {
|
|
29595
|
-
$ref: '#/components/schemas/acs_access_group',
|
|
29596
|
-
},
|
|
29597
|
-
type: 'array',
|
|
29598
|
-
},
|
|
29599
|
-
acs_credentials: {
|
|
29600
|
-
items: {
|
|
29601
|
-
$ref: '#/components/schemas/acs_credential',
|
|
29602
|
-
},
|
|
29603
|
-
type: 'array',
|
|
29604
|
-
},
|
|
29605
|
-
acs_encoders: {
|
|
29606
|
-
items: { $ref: '#/components/schemas/acs_encoder' },
|
|
29607
|
-
type: 'array',
|
|
29608
|
-
},
|
|
29609
|
-
acs_entrances: {
|
|
29610
|
-
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
29611
|
-
type: 'array',
|
|
29612
|
-
},
|
|
29613
|
-
acs_systems: {
|
|
29614
|
-
items: { $ref: '#/components/schemas/acs_system' },
|
|
29615
|
-
type: 'array',
|
|
29616
|
-
},
|
|
29617
|
-
acs_users: {
|
|
29618
|
-
items: { $ref: '#/components/schemas/acs_user' },
|
|
29619
|
-
type: 'array',
|
|
29620
|
-
},
|
|
29621
|
-
action_attempts: {
|
|
29622
|
-
items: {
|
|
29623
|
-
$ref: '#/components/schemas/action_attempt',
|
|
29624
|
-
},
|
|
29625
|
-
type: 'array',
|
|
29626
|
-
},
|
|
29627
|
-
batch_type: {
|
|
29628
|
-
enum: [
|
|
29629
|
-
'workspaces',
|
|
29630
|
-
'spaces',
|
|
29631
|
-
'access_grants',
|
|
29632
|
-
'access_methods',
|
|
29633
|
-
],
|
|
31135
|
+
access_method_id: {
|
|
31136
|
+
description: 'ID of the access method.',
|
|
31137
|
+
format: 'uuid',
|
|
29634
31138
|
type: 'string',
|
|
29635
31139
|
},
|
|
29636
|
-
|
|
29637
|
-
|
|
29638
|
-
|
|
29639
|
-
|
|
29640
|
-
type: '
|
|
29641
|
-
},
|
|
29642
|
-
connect_webviews: {
|
|
29643
|
-
items: {
|
|
29644
|
-
$ref: '#/components/schemas/connect_webview',
|
|
29645
|
-
},
|
|
29646
|
-
type: 'array',
|
|
29647
|
-
},
|
|
29648
|
-
customization_profiles: {
|
|
29649
|
-
items: {
|
|
29650
|
-
$ref: '#/components/schemas/customization_profile',
|
|
29651
|
-
},
|
|
29652
|
-
type: 'array',
|
|
29653
|
-
},
|
|
29654
|
-
devices: {
|
|
29655
|
-
items: { $ref: '#/components/schemas/device' },
|
|
29656
|
-
type: 'array',
|
|
29657
|
-
},
|
|
29658
|
-
events: {
|
|
29659
|
-
items: { $ref: '#/components/schemas/event' },
|
|
29660
|
-
type: 'array',
|
|
29661
|
-
},
|
|
29662
|
-
instant_keys: {
|
|
29663
|
-
items: { $ref: '#/components/schemas/instant_key' },
|
|
29664
|
-
type: 'array',
|
|
29665
|
-
},
|
|
29666
|
-
noise_thresholds: {
|
|
29667
|
-
items: {
|
|
29668
|
-
$ref: '#/components/schemas/noise_threshold',
|
|
29669
|
-
},
|
|
29670
|
-
type: 'array',
|
|
29671
|
-
},
|
|
29672
|
-
spaces: {
|
|
29673
|
-
items: { $ref: '#/components/schemas/space' },
|
|
29674
|
-
type: 'array',
|
|
29675
|
-
},
|
|
29676
|
-
thermostat_daily_programs: {
|
|
29677
|
-
items: {
|
|
29678
|
-
$ref: '#/components/schemas/thermostat_daily_program',
|
|
29679
|
-
},
|
|
29680
|
-
type: 'array',
|
|
31140
|
+
code: {
|
|
31141
|
+
description:
|
|
31142
|
+
'The actual PIN code for code access methods.',
|
|
31143
|
+
nullable: true,
|
|
31144
|
+
type: 'string',
|
|
29681
31145
|
},
|
|
29682
|
-
|
|
29683
|
-
|
|
29684
|
-
|
|
29685
|
-
|
|
29686
|
-
type: '
|
|
31146
|
+
created_at: {
|
|
31147
|
+
description:
|
|
31148
|
+
'Date and time at which the access method was created.',
|
|
31149
|
+
format: 'date-time',
|
|
31150
|
+
type: 'string',
|
|
29687
31151
|
},
|
|
29688
|
-
|
|
29689
|
-
|
|
29690
|
-
|
|
29691
|
-
},
|
|
29692
|
-
type: 'array',
|
|
31152
|
+
display_name: {
|
|
31153
|
+
description: 'Display name of the access method.',
|
|
31154
|
+
type: 'string',
|
|
29693
31155
|
},
|
|
29694
|
-
|
|
29695
|
-
|
|
29696
|
-
|
|
29697
|
-
|
|
29698
|
-
type: 'array',
|
|
31156
|
+
is_encoding_required: {
|
|
31157
|
+
description:
|
|
31158
|
+
'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
|
|
31159
|
+
type: 'boolean',
|
|
29699
31160
|
},
|
|
29700
|
-
|
|
29701
|
-
|
|
29702
|
-
|
|
29703
|
-
|
|
29704
|
-
type: 'array',
|
|
31161
|
+
is_issued: {
|
|
31162
|
+
description:
|
|
31163
|
+
'Indicates whether the access method has been issued.',
|
|
31164
|
+
type: 'boolean',
|
|
29705
31165
|
},
|
|
29706
|
-
|
|
29707
|
-
|
|
29708
|
-
|
|
29709
|
-
|
|
29710
|
-
|
|
31166
|
+
issued_at: {
|
|
31167
|
+
description:
|
|
31168
|
+
'Date and time at which the access method was issued.',
|
|
31169
|
+
format: 'date-time',
|
|
31170
|
+
nullable: true,
|
|
31171
|
+
type: 'string',
|
|
29711
31172
|
},
|
|
29712
|
-
|
|
31173
|
+
mode: {
|
|
31174
|
+
description:
|
|
31175
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
31176
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
31177
|
+
type: 'string',
|
|
31178
|
+
},
|
|
31179
|
+
warnings: {
|
|
31180
|
+
description:
|
|
31181
|
+
'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
29713
31182
|
items: {
|
|
29714
|
-
|
|
31183
|
+
description:
|
|
31184
|
+
'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
31185
|
+
discriminator: { propertyName: 'warning_code' },
|
|
31186
|
+
oneOf: [
|
|
31187
|
+
{
|
|
31188
|
+
description:
|
|
31189
|
+
'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
|
|
31190
|
+
properties: {
|
|
31191
|
+
created_at: {
|
|
31192
|
+
description:
|
|
31193
|
+
'Date and time at which Seam created the warning.',
|
|
31194
|
+
format: 'date-time',
|
|
31195
|
+
type: 'string',
|
|
31196
|
+
},
|
|
31197
|
+
message: {
|
|
31198
|
+
description:
|
|
31199
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31200
|
+
type: 'string',
|
|
31201
|
+
},
|
|
31202
|
+
warning_code: {
|
|
31203
|
+
description:
|
|
31204
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31205
|
+
enum: ['being_deleted'],
|
|
31206
|
+
type: 'string',
|
|
31207
|
+
},
|
|
31208
|
+
},
|
|
31209
|
+
required: [
|
|
31210
|
+
'created_at',
|
|
31211
|
+
'message',
|
|
31212
|
+
'warning_code',
|
|
31213
|
+
],
|
|
31214
|
+
type: 'object',
|
|
31215
|
+
},
|
|
31216
|
+
],
|
|
29715
31217
|
},
|
|
29716
31218
|
type: 'array',
|
|
29717
31219
|
},
|
|
29718
|
-
|
|
29719
|
-
|
|
29720
|
-
|
|
29721
|
-
|
|
29722
|
-
|
|
29723
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
29724
|
-
type: 'array',
|
|
31220
|
+
workspace_id: {
|
|
31221
|
+
description:
|
|
31222
|
+
'ID of the Seam workspace associated with the access method.',
|
|
31223
|
+
format: 'uuid',
|
|
31224
|
+
type: 'string',
|
|
29725
31225
|
},
|
|
29726
31226
|
},
|
|
29727
|
-
required: [
|
|
31227
|
+
required: [
|
|
31228
|
+
'workspace_id',
|
|
31229
|
+
'access_method_id',
|
|
31230
|
+
'display_name',
|
|
31231
|
+
'mode',
|
|
31232
|
+
'created_at',
|
|
31233
|
+
'issued_at',
|
|
31234
|
+
'is_issued',
|
|
31235
|
+
'warnings',
|
|
31236
|
+
],
|
|
29728
31237
|
type: 'object',
|
|
31238
|
+
'x-draft': 'Early access.',
|
|
31239
|
+
'x-route-path': '/access_methods/unmanaged',
|
|
29729
31240
|
},
|
|
29730
31241
|
ok: { type: 'boolean' },
|
|
29731
31242
|
},
|
|
29732
|
-
required: ['
|
|
31243
|
+
required: ['access_method', 'ok'],
|
|
29733
31244
|
type: 'object',
|
|
29734
31245
|
},
|
|
29735
31246
|
},
|
|
@@ -29744,63 +31255,31 @@ export default {
|
|
|
29744
31255
|
{ console_session_with_workspace: [] },
|
|
29745
31256
|
{ api_key: [] },
|
|
29746
31257
|
],
|
|
29747
|
-
summary: '/access_methods/
|
|
31258
|
+
summary: '/access_methods/unmanaged/get',
|
|
29748
31259
|
tags: [],
|
|
29749
|
-
'x-batch-type': 'access_methods',
|
|
29750
31260
|
'x-draft': 'Early access.',
|
|
29751
|
-
'x-fern-sdk-group-name': ['access_methods'],
|
|
29752
|
-
'x-fern-sdk-method-name': '
|
|
29753
|
-
'x-fern-sdk-return-value': '
|
|
29754
|
-
'x-response-key': '
|
|
29755
|
-
'x-title': 'Get
|
|
31261
|
+
'x-fern-sdk-group-name': ['access_methods', 'unmanaged'],
|
|
31262
|
+
'x-fern-sdk-method-name': 'get',
|
|
31263
|
+
'x-fern-sdk-return-value': 'access_method',
|
|
31264
|
+
'x-response-key': 'access_method',
|
|
31265
|
+
'x-title': 'Get an Unmanaged Access Method',
|
|
29756
31266
|
},
|
|
29757
31267
|
post: {
|
|
29758
31268
|
description:
|
|
29759
|
-
'Gets
|
|
29760
|
-
operationId: '
|
|
31269
|
+
'Gets an unmanaged access method (where is_managed = false).',
|
|
31270
|
+
operationId: 'accessMethodsUnmanagedGetPost',
|
|
29761
31271
|
requestBody: {
|
|
29762
31272
|
content: {
|
|
29763
31273
|
'application/json': {
|
|
29764
31274
|
schema: {
|
|
29765
31275
|
properties: {
|
|
29766
|
-
|
|
29767
|
-
description:
|
|
29768
|
-
|
|
29769
|
-
|
|
29770
|
-
type: 'array',
|
|
29771
|
-
},
|
|
29772
|
-
exclude: {
|
|
29773
|
-
items: {
|
|
29774
|
-
enum: [
|
|
29775
|
-
'spaces',
|
|
29776
|
-
'devices',
|
|
29777
|
-
'acs_entrances',
|
|
29778
|
-
'access_grants',
|
|
29779
|
-
'access_methods',
|
|
29780
|
-
'instant_keys',
|
|
29781
|
-
'client_sessions',
|
|
29782
|
-
],
|
|
29783
|
-
type: 'string',
|
|
29784
|
-
},
|
|
29785
|
-
type: 'array',
|
|
29786
|
-
},
|
|
29787
|
-
include: {
|
|
29788
|
-
items: {
|
|
29789
|
-
enum: [
|
|
29790
|
-
'spaces',
|
|
29791
|
-
'devices',
|
|
29792
|
-
'acs_entrances',
|
|
29793
|
-
'access_grants',
|
|
29794
|
-
'access_methods',
|
|
29795
|
-
'instant_keys',
|
|
29796
|
-
'client_sessions',
|
|
29797
|
-
],
|
|
29798
|
-
type: 'string',
|
|
29799
|
-
},
|
|
29800
|
-
type: 'array',
|
|
31276
|
+
access_method_id: {
|
|
31277
|
+
description: 'ID of unmanaged access method to get.',
|
|
31278
|
+
format: 'uuid',
|
|
31279
|
+
type: 'string',
|
|
29801
31280
|
},
|
|
29802
31281
|
},
|
|
29803
|
-
required: ['
|
|
31282
|
+
required: ['access_method_id'],
|
|
29804
31283
|
type: 'object',
|
|
29805
31284
|
},
|
|
29806
31285
|
},
|
|
@@ -29812,161 +31291,119 @@ export default {
|
|
|
29812
31291
|
'application/json': {
|
|
29813
31292
|
schema: {
|
|
29814
31293
|
properties: {
|
|
29815
|
-
|
|
29816
|
-
description:
|
|
31294
|
+
access_method: {
|
|
31295
|
+
description:
|
|
31296
|
+
'Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.',
|
|
29817
31297
|
properties: {
|
|
29818
|
-
|
|
29819
|
-
|
|
29820
|
-
|
|
29821
|
-
},
|
|
29822
|
-
access_grants: {
|
|
29823
|
-
items: { $ref: '#/components/schemas/access_grant' },
|
|
29824
|
-
type: 'array',
|
|
29825
|
-
},
|
|
29826
|
-
access_methods: {
|
|
29827
|
-
items: { $ref: '#/components/schemas/access_method' },
|
|
29828
|
-
type: 'array',
|
|
29829
|
-
},
|
|
29830
|
-
acs_access_groups: {
|
|
29831
|
-
items: {
|
|
29832
|
-
$ref: '#/components/schemas/acs_access_group',
|
|
29833
|
-
},
|
|
29834
|
-
type: 'array',
|
|
29835
|
-
},
|
|
29836
|
-
acs_credentials: {
|
|
29837
|
-
items: {
|
|
29838
|
-
$ref: '#/components/schemas/acs_credential',
|
|
29839
|
-
},
|
|
29840
|
-
type: 'array',
|
|
29841
|
-
},
|
|
29842
|
-
acs_encoders: {
|
|
29843
|
-
items: { $ref: '#/components/schemas/acs_encoder' },
|
|
29844
|
-
type: 'array',
|
|
29845
|
-
},
|
|
29846
|
-
acs_entrances: {
|
|
29847
|
-
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
29848
|
-
type: 'array',
|
|
29849
|
-
},
|
|
29850
|
-
acs_systems: {
|
|
29851
|
-
items: { $ref: '#/components/schemas/acs_system' },
|
|
29852
|
-
type: 'array',
|
|
29853
|
-
},
|
|
29854
|
-
acs_users: {
|
|
29855
|
-
items: { $ref: '#/components/schemas/acs_user' },
|
|
29856
|
-
type: 'array',
|
|
29857
|
-
},
|
|
29858
|
-
action_attempts: {
|
|
29859
|
-
items: {
|
|
29860
|
-
$ref: '#/components/schemas/action_attempt',
|
|
29861
|
-
},
|
|
29862
|
-
type: 'array',
|
|
29863
|
-
},
|
|
29864
|
-
batch_type: {
|
|
29865
|
-
enum: [
|
|
29866
|
-
'workspaces',
|
|
29867
|
-
'spaces',
|
|
29868
|
-
'access_grants',
|
|
29869
|
-
'access_methods',
|
|
29870
|
-
],
|
|
31298
|
+
access_method_id: {
|
|
31299
|
+
description: 'ID of the access method.',
|
|
31300
|
+
format: 'uuid',
|
|
29871
31301
|
type: 'string',
|
|
29872
31302
|
},
|
|
29873
|
-
|
|
29874
|
-
|
|
29875
|
-
|
|
29876
|
-
|
|
29877
|
-
type: '
|
|
29878
|
-
},
|
|
29879
|
-
connect_webviews: {
|
|
29880
|
-
items: {
|
|
29881
|
-
$ref: '#/components/schemas/connect_webview',
|
|
29882
|
-
},
|
|
29883
|
-
type: 'array',
|
|
29884
|
-
},
|
|
29885
|
-
customization_profiles: {
|
|
29886
|
-
items: {
|
|
29887
|
-
$ref: '#/components/schemas/customization_profile',
|
|
29888
|
-
},
|
|
29889
|
-
type: 'array',
|
|
29890
|
-
},
|
|
29891
|
-
devices: {
|
|
29892
|
-
items: { $ref: '#/components/schemas/device' },
|
|
29893
|
-
type: 'array',
|
|
29894
|
-
},
|
|
29895
|
-
events: {
|
|
29896
|
-
items: { $ref: '#/components/schemas/event' },
|
|
29897
|
-
type: 'array',
|
|
29898
|
-
},
|
|
29899
|
-
instant_keys: {
|
|
29900
|
-
items: { $ref: '#/components/schemas/instant_key' },
|
|
29901
|
-
type: 'array',
|
|
29902
|
-
},
|
|
29903
|
-
noise_thresholds: {
|
|
29904
|
-
items: {
|
|
29905
|
-
$ref: '#/components/schemas/noise_threshold',
|
|
29906
|
-
},
|
|
29907
|
-
type: 'array',
|
|
29908
|
-
},
|
|
29909
|
-
spaces: {
|
|
29910
|
-
items: { $ref: '#/components/schemas/space' },
|
|
29911
|
-
type: 'array',
|
|
29912
|
-
},
|
|
29913
|
-
thermostat_daily_programs: {
|
|
29914
|
-
items: {
|
|
29915
|
-
$ref: '#/components/schemas/thermostat_daily_program',
|
|
29916
|
-
},
|
|
29917
|
-
type: 'array',
|
|
31303
|
+
code: {
|
|
31304
|
+
description:
|
|
31305
|
+
'The actual PIN code for code access methods.',
|
|
31306
|
+
nullable: true,
|
|
31307
|
+
type: 'string',
|
|
29918
31308
|
},
|
|
29919
|
-
|
|
29920
|
-
|
|
29921
|
-
|
|
29922
|
-
|
|
29923
|
-
type: '
|
|
31309
|
+
created_at: {
|
|
31310
|
+
description:
|
|
31311
|
+
'Date and time at which the access method was created.',
|
|
31312
|
+
format: 'date-time',
|
|
31313
|
+
type: 'string',
|
|
29924
31314
|
},
|
|
29925
|
-
|
|
29926
|
-
|
|
29927
|
-
|
|
29928
|
-
},
|
|
29929
|
-
type: 'array',
|
|
31315
|
+
display_name: {
|
|
31316
|
+
description: 'Display name of the access method.',
|
|
31317
|
+
type: 'string',
|
|
29930
31318
|
},
|
|
29931
|
-
|
|
29932
|
-
|
|
29933
|
-
|
|
29934
|
-
|
|
29935
|
-
type: 'array',
|
|
31319
|
+
is_encoding_required: {
|
|
31320
|
+
description:
|
|
31321
|
+
'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
|
|
31322
|
+
type: 'boolean',
|
|
29936
31323
|
},
|
|
29937
|
-
|
|
29938
|
-
|
|
29939
|
-
|
|
29940
|
-
|
|
29941
|
-
type: 'array',
|
|
31324
|
+
is_issued: {
|
|
31325
|
+
description:
|
|
31326
|
+
'Indicates whether the access method has been issued.',
|
|
31327
|
+
type: 'boolean',
|
|
29942
31328
|
},
|
|
29943
|
-
|
|
29944
|
-
|
|
29945
|
-
|
|
29946
|
-
|
|
29947
|
-
|
|
31329
|
+
issued_at: {
|
|
31330
|
+
description:
|
|
31331
|
+
'Date and time at which the access method was issued.',
|
|
31332
|
+
format: 'date-time',
|
|
31333
|
+
nullable: true,
|
|
31334
|
+
type: 'string',
|
|
29948
31335
|
},
|
|
29949
|
-
|
|
31336
|
+
mode: {
|
|
31337
|
+
description:
|
|
31338
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
31339
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
31340
|
+
type: 'string',
|
|
31341
|
+
},
|
|
31342
|
+
warnings: {
|
|
31343
|
+
description:
|
|
31344
|
+
'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
29950
31345
|
items: {
|
|
29951
|
-
|
|
31346
|
+
description:
|
|
31347
|
+
'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
31348
|
+
discriminator: { propertyName: 'warning_code' },
|
|
31349
|
+
oneOf: [
|
|
31350
|
+
{
|
|
31351
|
+
description:
|
|
31352
|
+
'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
|
|
31353
|
+
properties: {
|
|
31354
|
+
created_at: {
|
|
31355
|
+
description:
|
|
31356
|
+
'Date and time at which Seam created the warning.',
|
|
31357
|
+
format: 'date-time',
|
|
31358
|
+
type: 'string',
|
|
31359
|
+
},
|
|
31360
|
+
message: {
|
|
31361
|
+
description:
|
|
31362
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31363
|
+
type: 'string',
|
|
31364
|
+
},
|
|
31365
|
+
warning_code: {
|
|
31366
|
+
description:
|
|
31367
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31368
|
+
enum: ['being_deleted'],
|
|
31369
|
+
type: 'string',
|
|
31370
|
+
},
|
|
31371
|
+
},
|
|
31372
|
+
required: [
|
|
31373
|
+
'created_at',
|
|
31374
|
+
'message',
|
|
31375
|
+
'warning_code',
|
|
31376
|
+
],
|
|
31377
|
+
type: 'object',
|
|
31378
|
+
},
|
|
31379
|
+
],
|
|
29952
31380
|
},
|
|
29953
31381
|
type: 'array',
|
|
29954
31382
|
},
|
|
29955
|
-
|
|
29956
|
-
|
|
29957
|
-
|
|
29958
|
-
|
|
29959
|
-
|
|
29960
|
-
items: { $ref: '#/components/schemas/workspace' },
|
|
29961
|
-
type: 'array',
|
|
31383
|
+
workspace_id: {
|
|
31384
|
+
description:
|
|
31385
|
+
'ID of the Seam workspace associated with the access method.',
|
|
31386
|
+
format: 'uuid',
|
|
31387
|
+
type: 'string',
|
|
29962
31388
|
},
|
|
29963
31389
|
},
|
|
29964
|
-
required: [
|
|
31390
|
+
required: [
|
|
31391
|
+
'workspace_id',
|
|
31392
|
+
'access_method_id',
|
|
31393
|
+
'display_name',
|
|
31394
|
+
'mode',
|
|
31395
|
+
'created_at',
|
|
31396
|
+
'issued_at',
|
|
31397
|
+
'is_issued',
|
|
31398
|
+
'warnings',
|
|
31399
|
+
],
|
|
29965
31400
|
type: 'object',
|
|
31401
|
+
'x-draft': 'Early access.',
|
|
31402
|
+
'x-route-path': '/access_methods/unmanaged',
|
|
29966
31403
|
},
|
|
29967
31404
|
ok: { type: 'boolean' },
|
|
29968
31405
|
},
|
|
29969
|
-
required: ['
|
|
31406
|
+
required: ['access_method', 'ok'],
|
|
29970
31407
|
type: 'object',
|
|
29971
31408
|
},
|
|
29972
31409
|
},
|
|
@@ -29981,29 +31418,29 @@ export default {
|
|
|
29981
31418
|
{ console_session_with_workspace: [] },
|
|
29982
31419
|
{ api_key: [] },
|
|
29983
31420
|
],
|
|
29984
|
-
summary: '/access_methods/
|
|
31421
|
+
summary: '/access_methods/unmanaged/get',
|
|
29985
31422
|
tags: [],
|
|
29986
|
-
'x-batch-type': 'access_methods',
|
|
29987
31423
|
'x-draft': 'Early access.',
|
|
29988
|
-
'x-fern-sdk-group-name': ['access_methods'],
|
|
29989
|
-
'x-fern-sdk-method-name': '
|
|
29990
|
-
'x-fern-sdk-return-value': '
|
|
29991
|
-
'x-response-key': '
|
|
29992
|
-
'x-title': 'Get
|
|
31424
|
+
'x-fern-sdk-group-name': ['access_methods', 'unmanaged'],
|
|
31425
|
+
'x-fern-sdk-method-name': 'get',
|
|
31426
|
+
'x-fern-sdk-return-value': 'access_method',
|
|
31427
|
+
'x-response-key': 'access_method',
|
|
31428
|
+
'x-title': 'Get an Unmanaged Access Method',
|
|
29993
31429
|
},
|
|
29994
31430
|
},
|
|
29995
|
-
'/access_methods/list': {
|
|
31431
|
+
'/access_methods/unmanaged/list': {
|
|
29996
31432
|
get: {
|
|
29997
31433
|
description:
|
|
29998
|
-
'Lists all access methods, usually filtered by Access Grant.',
|
|
29999
|
-
operationId: '
|
|
31434
|
+
'Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.',
|
|
31435
|
+
operationId: 'accessMethodsUnmanagedListGet',
|
|
30000
31436
|
parameters: [
|
|
30001
31437
|
{
|
|
30002
31438
|
in: 'query',
|
|
30003
31439
|
name: 'access_grant_id',
|
|
30004
31440
|
required: true,
|
|
30005
31441
|
schema: {
|
|
30006
|
-
description:
|
|
31442
|
+
description:
|
|
31443
|
+
'ID of Access Grant to list unmanaged access methods for.',
|
|
30007
31444
|
format: 'uuid',
|
|
30008
31445
|
type: 'string',
|
|
30009
31446
|
},
|
|
@@ -30014,7 +31451,7 @@ export default {
|
|
|
30014
31451
|
required: false,
|
|
30015
31452
|
schema: {
|
|
30016
31453
|
description:
|
|
30017
|
-
'ID of the device for which you want to retrieve all access methods.',
|
|
31454
|
+
'ID of the device for which you want to retrieve all unmanaged access methods.',
|
|
30018
31455
|
format: 'uuid',
|
|
30019
31456
|
type: 'string',
|
|
30020
31457
|
},
|
|
@@ -30025,7 +31462,7 @@ export default {
|
|
|
30025
31462
|
required: false,
|
|
30026
31463
|
schema: {
|
|
30027
31464
|
description:
|
|
30028
|
-
'ID of the entrance for which you want to retrieve all access methods.',
|
|
31465
|
+
'ID of the entrance for which you want to retrieve all unmanaged access methods.',
|
|
30029
31466
|
format: 'uuid',
|
|
30030
31467
|
type: 'string',
|
|
30031
31468
|
},
|
|
@@ -30036,7 +31473,7 @@ export default {
|
|
|
30036
31473
|
required: false,
|
|
30037
31474
|
schema: {
|
|
30038
31475
|
description:
|
|
30039
|
-
'ID of the space for which you want to retrieve all access methods.',
|
|
31476
|
+
'ID of the space for which you want to retrieve all unmanaged access methods.',
|
|
30040
31477
|
format: 'uuid',
|
|
30041
31478
|
type: 'string',
|
|
30042
31479
|
},
|
|
@@ -30049,7 +31486,116 @@ export default {
|
|
|
30049
31486
|
schema: {
|
|
30050
31487
|
properties: {
|
|
30051
31488
|
access_methods: {
|
|
30052
|
-
items: {
|
|
31489
|
+
items: {
|
|
31490
|
+
description:
|
|
31491
|
+
'Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.',
|
|
31492
|
+
properties: {
|
|
31493
|
+
access_method_id: {
|
|
31494
|
+
description: 'ID of the access method.',
|
|
31495
|
+
format: 'uuid',
|
|
31496
|
+
type: 'string',
|
|
31497
|
+
},
|
|
31498
|
+
code: {
|
|
31499
|
+
description:
|
|
31500
|
+
'The actual PIN code for code access methods.',
|
|
31501
|
+
nullable: true,
|
|
31502
|
+
type: 'string',
|
|
31503
|
+
},
|
|
31504
|
+
created_at: {
|
|
31505
|
+
description:
|
|
31506
|
+
'Date and time at which the access method was created.',
|
|
31507
|
+
format: 'date-time',
|
|
31508
|
+
type: 'string',
|
|
31509
|
+
},
|
|
31510
|
+
display_name: {
|
|
31511
|
+
description: 'Display name of the access method.',
|
|
31512
|
+
type: 'string',
|
|
31513
|
+
},
|
|
31514
|
+
is_encoding_required: {
|
|
31515
|
+
description:
|
|
31516
|
+
'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
|
|
31517
|
+
type: 'boolean',
|
|
31518
|
+
},
|
|
31519
|
+
is_issued: {
|
|
31520
|
+
description:
|
|
31521
|
+
'Indicates whether the access method has been issued.',
|
|
31522
|
+
type: 'boolean',
|
|
31523
|
+
},
|
|
31524
|
+
issued_at: {
|
|
31525
|
+
description:
|
|
31526
|
+
'Date and time at which the access method was issued.',
|
|
31527
|
+
format: 'date-time',
|
|
31528
|
+
nullable: true,
|
|
31529
|
+
type: 'string',
|
|
31530
|
+
},
|
|
31531
|
+
mode: {
|
|
31532
|
+
description:
|
|
31533
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
31534
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
31535
|
+
type: 'string',
|
|
31536
|
+
},
|
|
31537
|
+
warnings: {
|
|
31538
|
+
description:
|
|
31539
|
+
'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
31540
|
+
items: {
|
|
31541
|
+
description:
|
|
31542
|
+
'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
31543
|
+
discriminator: { propertyName: 'warning_code' },
|
|
31544
|
+
oneOf: [
|
|
31545
|
+
{
|
|
31546
|
+
description:
|
|
31547
|
+
'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
|
|
31548
|
+
properties: {
|
|
31549
|
+
created_at: {
|
|
31550
|
+
description:
|
|
31551
|
+
'Date and time at which Seam created the warning.',
|
|
31552
|
+
format: 'date-time',
|
|
31553
|
+
type: 'string',
|
|
31554
|
+
},
|
|
31555
|
+
message: {
|
|
31556
|
+
description:
|
|
31557
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31558
|
+
type: 'string',
|
|
31559
|
+
},
|
|
31560
|
+
warning_code: {
|
|
31561
|
+
description:
|
|
31562
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31563
|
+
enum: ['being_deleted'],
|
|
31564
|
+
type: 'string',
|
|
31565
|
+
},
|
|
31566
|
+
},
|
|
31567
|
+
required: [
|
|
31568
|
+
'created_at',
|
|
31569
|
+
'message',
|
|
31570
|
+
'warning_code',
|
|
31571
|
+
],
|
|
31572
|
+
type: 'object',
|
|
31573
|
+
},
|
|
31574
|
+
],
|
|
31575
|
+
},
|
|
31576
|
+
type: 'array',
|
|
31577
|
+
},
|
|
31578
|
+
workspace_id: {
|
|
31579
|
+
description:
|
|
31580
|
+
'ID of the Seam workspace associated with the access method.',
|
|
31581
|
+
format: 'uuid',
|
|
31582
|
+
type: 'string',
|
|
31583
|
+
},
|
|
31584
|
+
},
|
|
31585
|
+
required: [
|
|
31586
|
+
'workspace_id',
|
|
31587
|
+
'access_method_id',
|
|
31588
|
+
'display_name',
|
|
31589
|
+
'mode',
|
|
31590
|
+
'created_at',
|
|
31591
|
+
'issued_at',
|
|
31592
|
+
'is_issued',
|
|
31593
|
+
'warnings',
|
|
31594
|
+
],
|
|
31595
|
+
type: 'object',
|
|
31596
|
+
'x-draft': 'Early access.',
|
|
31597
|
+
'x-route-path': '/access_methods/unmanaged',
|
|
31598
|
+
},
|
|
30053
31599
|
type: 'array',
|
|
30054
31600
|
},
|
|
30055
31601
|
ok: { type: 'boolean' },
|
|
@@ -30069,19 +31615,19 @@ export default {
|
|
|
30069
31615
|
{ console_session_with_workspace: [] },
|
|
30070
31616
|
{ api_key: [] },
|
|
30071
31617
|
],
|
|
30072
|
-
summary: '/access_methods/list',
|
|
31618
|
+
summary: '/access_methods/unmanaged/list',
|
|
30073
31619
|
tags: [],
|
|
30074
31620
|
'x-draft': 'Early access.',
|
|
30075
|
-
'x-fern-sdk-group-name': ['access_methods'],
|
|
31621
|
+
'x-fern-sdk-group-name': ['access_methods', 'unmanaged'],
|
|
30076
31622
|
'x-fern-sdk-method-name': 'list',
|
|
30077
31623
|
'x-fern-sdk-return-value': 'access_methods',
|
|
30078
31624
|
'x-response-key': 'access_methods',
|
|
30079
|
-
'x-title': 'List Access Methods',
|
|
31625
|
+
'x-title': 'List Unmanaged Access Methods',
|
|
30080
31626
|
},
|
|
30081
31627
|
post: {
|
|
30082
31628
|
description:
|
|
30083
|
-
'Lists all access methods, usually filtered by Access Grant.',
|
|
30084
|
-
operationId: '
|
|
31629
|
+
'Lists all unmanaged access methods (where is_managed = false), usually filtered by Access Grant.',
|
|
31630
|
+
operationId: 'accessMethodsUnmanagedListPost',
|
|
30085
31631
|
requestBody: {
|
|
30086
31632
|
content: {
|
|
30087
31633
|
'application/json': {
|
|
@@ -30089,25 +31635,25 @@ export default {
|
|
|
30089
31635
|
properties: {
|
|
30090
31636
|
access_grant_id: {
|
|
30091
31637
|
description:
|
|
30092
|
-
'ID of Access Grant to list access methods for.',
|
|
31638
|
+
'ID of Access Grant to list unmanaged access methods for.',
|
|
30093
31639
|
format: 'uuid',
|
|
30094
31640
|
type: 'string',
|
|
30095
31641
|
},
|
|
30096
31642
|
acs_entrance_id: {
|
|
30097
31643
|
description:
|
|
30098
|
-
'ID of the entrance for which you want to retrieve all access methods.',
|
|
31644
|
+
'ID of the entrance for which you want to retrieve all unmanaged access methods.',
|
|
30099
31645
|
format: 'uuid',
|
|
30100
31646
|
type: 'string',
|
|
30101
31647
|
},
|
|
30102
31648
|
device_id: {
|
|
30103
31649
|
description:
|
|
30104
|
-
'ID of the device for which you want to retrieve all access methods.',
|
|
31650
|
+
'ID of the device for which you want to retrieve all unmanaged access methods.',
|
|
30105
31651
|
format: 'uuid',
|
|
30106
31652
|
type: 'string',
|
|
30107
31653
|
},
|
|
30108
31654
|
space_id: {
|
|
30109
31655
|
description:
|
|
30110
|
-
'ID of the space for which you want to retrieve all access methods.',
|
|
31656
|
+
'ID of the space for which you want to retrieve all unmanaged access methods.',
|
|
30111
31657
|
format: 'uuid',
|
|
30112
31658
|
type: 'string',
|
|
30113
31659
|
},
|
|
@@ -30125,7 +31671,116 @@ export default {
|
|
|
30125
31671
|
schema: {
|
|
30126
31672
|
properties: {
|
|
30127
31673
|
access_methods: {
|
|
30128
|
-
items: {
|
|
31674
|
+
items: {
|
|
31675
|
+
description:
|
|
31676
|
+
'Represents an unmanaged access method. Unmanaged access methods do not have client sessions, instant keys, customization profiles, or keys.',
|
|
31677
|
+
properties: {
|
|
31678
|
+
access_method_id: {
|
|
31679
|
+
description: 'ID of the access method.',
|
|
31680
|
+
format: 'uuid',
|
|
31681
|
+
type: 'string',
|
|
31682
|
+
},
|
|
31683
|
+
code: {
|
|
31684
|
+
description:
|
|
31685
|
+
'The actual PIN code for code access methods.',
|
|
31686
|
+
nullable: true,
|
|
31687
|
+
type: 'string',
|
|
31688
|
+
},
|
|
31689
|
+
created_at: {
|
|
31690
|
+
description:
|
|
31691
|
+
'Date and time at which the access method was created.',
|
|
31692
|
+
format: 'date-time',
|
|
31693
|
+
type: 'string',
|
|
31694
|
+
},
|
|
31695
|
+
display_name: {
|
|
31696
|
+
description: 'Display name of the access method.',
|
|
31697
|
+
type: 'string',
|
|
31698
|
+
},
|
|
31699
|
+
is_encoding_required: {
|
|
31700
|
+
description:
|
|
31701
|
+
'Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.',
|
|
31702
|
+
type: 'boolean',
|
|
31703
|
+
},
|
|
31704
|
+
is_issued: {
|
|
31705
|
+
description:
|
|
31706
|
+
'Indicates whether the access method has been issued.',
|
|
31707
|
+
type: 'boolean',
|
|
31708
|
+
},
|
|
31709
|
+
issued_at: {
|
|
31710
|
+
description:
|
|
31711
|
+
'Date and time at which the access method was issued.',
|
|
31712
|
+
format: 'date-time',
|
|
31713
|
+
nullable: true,
|
|
31714
|
+
type: 'string',
|
|
31715
|
+
},
|
|
31716
|
+
mode: {
|
|
31717
|
+
description:
|
|
31718
|
+
'Access method mode. Supported values: `code`, `card`, `mobile_key`.',
|
|
31719
|
+
enum: ['code', 'card', 'mobile_key'],
|
|
31720
|
+
type: 'string',
|
|
31721
|
+
},
|
|
31722
|
+
warnings: {
|
|
31723
|
+
description:
|
|
31724
|
+
'Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
31725
|
+
items: {
|
|
31726
|
+
description:
|
|
31727
|
+
'Warning associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods).',
|
|
31728
|
+
discriminator: { propertyName: 'warning_code' },
|
|
31729
|
+
oneOf: [
|
|
31730
|
+
{
|
|
31731
|
+
description:
|
|
31732
|
+
'Indicates that the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods) is being deleted.',
|
|
31733
|
+
properties: {
|
|
31734
|
+
created_at: {
|
|
31735
|
+
description:
|
|
31736
|
+
'Date and time at which Seam created the warning.',
|
|
31737
|
+
format: 'date-time',
|
|
31738
|
+
type: 'string',
|
|
31739
|
+
},
|
|
31740
|
+
message: {
|
|
31741
|
+
description:
|
|
31742
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31743
|
+
type: 'string',
|
|
31744
|
+
},
|
|
31745
|
+
warning_code: {
|
|
31746
|
+
description:
|
|
31747
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31748
|
+
enum: ['being_deleted'],
|
|
31749
|
+
type: 'string',
|
|
31750
|
+
},
|
|
31751
|
+
},
|
|
31752
|
+
required: [
|
|
31753
|
+
'created_at',
|
|
31754
|
+
'message',
|
|
31755
|
+
'warning_code',
|
|
31756
|
+
],
|
|
31757
|
+
type: 'object',
|
|
31758
|
+
},
|
|
31759
|
+
],
|
|
31760
|
+
},
|
|
31761
|
+
type: 'array',
|
|
31762
|
+
},
|
|
31763
|
+
workspace_id: {
|
|
31764
|
+
description:
|
|
31765
|
+
'ID of the Seam workspace associated with the access method.',
|
|
31766
|
+
format: 'uuid',
|
|
31767
|
+
type: 'string',
|
|
31768
|
+
},
|
|
31769
|
+
},
|
|
31770
|
+
required: [
|
|
31771
|
+
'workspace_id',
|
|
31772
|
+
'access_method_id',
|
|
31773
|
+
'display_name',
|
|
31774
|
+
'mode',
|
|
31775
|
+
'created_at',
|
|
31776
|
+
'issued_at',
|
|
31777
|
+
'is_issued',
|
|
31778
|
+
'warnings',
|
|
31779
|
+
],
|
|
31780
|
+
type: 'object',
|
|
31781
|
+
'x-draft': 'Early access.',
|
|
31782
|
+
'x-route-path': '/access_methods/unmanaged',
|
|
31783
|
+
},
|
|
30129
31784
|
type: 'array',
|
|
30130
31785
|
},
|
|
30131
31786
|
ok: { type: 'boolean' },
|
|
@@ -30145,14 +31800,14 @@ export default {
|
|
|
30145
31800
|
{ console_session_with_workspace: [] },
|
|
30146
31801
|
{ api_key: [] },
|
|
30147
31802
|
],
|
|
30148
|
-
summary: '/access_methods/list',
|
|
31803
|
+
summary: '/access_methods/unmanaged/list',
|
|
30149
31804
|
tags: [],
|
|
30150
31805
|
'x-draft': 'Early access.',
|
|
30151
|
-
'x-fern-sdk-group-name': ['access_methods'],
|
|
31806
|
+
'x-fern-sdk-group-name': ['access_methods', 'unmanaged'],
|
|
30152
31807
|
'x-fern-sdk-method-name': 'list',
|
|
30153
31808
|
'x-fern-sdk-return-value': 'access_methods',
|
|
30154
31809
|
'x-response-key': 'access_methods',
|
|
30155
|
-
'x-title': 'List Access Methods',
|
|
31810
|
+
'x-title': 'List Unmanaged Access Methods',
|
|
30156
31811
|
},
|
|
30157
31812
|
},
|
|
30158
31813
|
'/acs/access_groups/add_user': {
|
|
@@ -57893,12 +59548,245 @@ export default {
|
|
|
57893
59548
|
properties: {
|
|
57894
59549
|
user_identity_id: {
|
|
57895
59550
|
description:
|
|
57896
|
-
'ID of the user identity for which you want to retrieve all access systems.',
|
|
59551
|
+
'ID of the user identity for which you want to retrieve all access systems.',
|
|
59552
|
+
format: 'uuid',
|
|
59553
|
+
type: 'string',
|
|
59554
|
+
},
|
|
59555
|
+
},
|
|
59556
|
+
required: ['user_identity_id'],
|
|
59557
|
+
type: 'object',
|
|
59558
|
+
},
|
|
59559
|
+
},
|
|
59560
|
+
},
|
|
59561
|
+
},
|
|
59562
|
+
responses: {
|
|
59563
|
+
200: {
|
|
59564
|
+
content: {
|
|
59565
|
+
'application/json': {
|
|
59566
|
+
schema: {
|
|
59567
|
+
properties: {
|
|
59568
|
+
acs_systems: {
|
|
59569
|
+
items: { $ref: '#/components/schemas/acs_system' },
|
|
59570
|
+
type: 'array',
|
|
59571
|
+
},
|
|
59572
|
+
ok: { type: 'boolean' },
|
|
59573
|
+
},
|
|
59574
|
+
required: ['acs_systems', 'ok'],
|
|
59575
|
+
type: 'object',
|
|
59576
|
+
},
|
|
59577
|
+
},
|
|
59578
|
+
},
|
|
59579
|
+
description: 'OK',
|
|
59580
|
+
},
|
|
59581
|
+
400: { description: 'Bad Request' },
|
|
59582
|
+
401: { description: 'Unauthorized' },
|
|
59583
|
+
},
|
|
59584
|
+
security: [
|
|
59585
|
+
{ client_session: [] },
|
|
59586
|
+
{ pat_with_workspace: [] },
|
|
59587
|
+
{ console_session_with_workspace: [] },
|
|
59588
|
+
{ api_key: [] },
|
|
59589
|
+
],
|
|
59590
|
+
summary: '/user_identities/list_acs_systems',
|
|
59591
|
+
tags: ['/user_identities'],
|
|
59592
|
+
'x-fern-sdk-group-name': ['user_identities'],
|
|
59593
|
+
'x-fern-sdk-method-name': 'list_acs_systems',
|
|
59594
|
+
'x-fern-sdk-return-value': 'acs_systems',
|
|
59595
|
+
'x-response-key': 'acs_systems',
|
|
59596
|
+
'x-title': 'List ACS Systems Associated with a User Identity',
|
|
59597
|
+
},
|
|
59598
|
+
},
|
|
59599
|
+
'/user_identities/list_acs_users': {
|
|
59600
|
+
get: {
|
|
59601
|
+
description:
|
|
59602
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
59603
|
+
operationId: 'userIdentitiesListAcsUsersGet',
|
|
59604
|
+
parameters: [
|
|
59605
|
+
{
|
|
59606
|
+
in: 'query',
|
|
59607
|
+
name: 'user_identity_id',
|
|
59608
|
+
required: true,
|
|
59609
|
+
schema: {
|
|
59610
|
+
description:
|
|
59611
|
+
'ID of the user identity for which you want to retrieve all access system users.',
|
|
59612
|
+
format: 'uuid',
|
|
59613
|
+
type: 'string',
|
|
59614
|
+
},
|
|
59615
|
+
},
|
|
59616
|
+
],
|
|
59617
|
+
responses: {
|
|
59618
|
+
200: {
|
|
59619
|
+
content: {
|
|
59620
|
+
'application/json': {
|
|
59621
|
+
schema: {
|
|
59622
|
+
properties: {
|
|
59623
|
+
acs_users: {
|
|
59624
|
+
items: { $ref: '#/components/schemas/acs_user' },
|
|
59625
|
+
type: 'array',
|
|
59626
|
+
},
|
|
59627
|
+
ok: { type: 'boolean' },
|
|
59628
|
+
},
|
|
59629
|
+
required: ['acs_users', 'ok'],
|
|
59630
|
+
type: 'object',
|
|
59631
|
+
},
|
|
59632
|
+
},
|
|
59633
|
+
},
|
|
59634
|
+
description: 'OK',
|
|
59635
|
+
},
|
|
59636
|
+
400: { description: 'Bad Request' },
|
|
59637
|
+
401: { description: 'Unauthorized' },
|
|
59638
|
+
},
|
|
59639
|
+
security: [
|
|
59640
|
+
{ api_key: [] },
|
|
59641
|
+
{ pat_with_workspace: [] },
|
|
59642
|
+
{ console_session_with_workspace: [] },
|
|
59643
|
+
],
|
|
59644
|
+
summary: '/user_identities/list_acs_users',
|
|
59645
|
+
tags: ['/user_identities'],
|
|
59646
|
+
'x-fern-sdk-group-name': ['user_identities'],
|
|
59647
|
+
'x-fern-sdk-method-name': 'list_acs_users',
|
|
59648
|
+
'x-fern-sdk-return-value': 'acs_users',
|
|
59649
|
+
'x-response-key': 'acs_users',
|
|
59650
|
+
'x-title': 'List ACS Users Associated with a User Identity',
|
|
59651
|
+
},
|
|
59652
|
+
post: {
|
|
59653
|
+
description:
|
|
59654
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
59655
|
+
operationId: 'userIdentitiesListAcsUsersPost',
|
|
59656
|
+
requestBody: {
|
|
59657
|
+
content: {
|
|
59658
|
+
'application/json': {
|
|
59659
|
+
schema: {
|
|
59660
|
+
properties: {
|
|
59661
|
+
user_identity_id: {
|
|
59662
|
+
description:
|
|
59663
|
+
'ID of the user identity for which you want to retrieve all access system users.',
|
|
59664
|
+
format: 'uuid',
|
|
59665
|
+
type: 'string',
|
|
59666
|
+
},
|
|
59667
|
+
},
|
|
59668
|
+
required: ['user_identity_id'],
|
|
59669
|
+
type: 'object',
|
|
59670
|
+
},
|
|
59671
|
+
},
|
|
59672
|
+
},
|
|
59673
|
+
},
|
|
59674
|
+
responses: {
|
|
59675
|
+
200: {
|
|
59676
|
+
content: {
|
|
59677
|
+
'application/json': {
|
|
59678
|
+
schema: {
|
|
59679
|
+
properties: {
|
|
59680
|
+
acs_users: {
|
|
59681
|
+
items: { $ref: '#/components/schemas/acs_user' },
|
|
59682
|
+
type: 'array',
|
|
59683
|
+
},
|
|
59684
|
+
ok: { type: 'boolean' },
|
|
59685
|
+
},
|
|
59686
|
+
required: ['acs_users', 'ok'],
|
|
59687
|
+
type: 'object',
|
|
59688
|
+
},
|
|
59689
|
+
},
|
|
59690
|
+
},
|
|
59691
|
+
description: 'OK',
|
|
59692
|
+
},
|
|
59693
|
+
400: { description: 'Bad Request' },
|
|
59694
|
+
401: { description: 'Unauthorized' },
|
|
59695
|
+
},
|
|
59696
|
+
security: [
|
|
59697
|
+
{ api_key: [] },
|
|
59698
|
+
{ pat_with_workspace: [] },
|
|
59699
|
+
{ console_session_with_workspace: [] },
|
|
59700
|
+
],
|
|
59701
|
+
summary: '/user_identities/list_acs_users',
|
|
59702
|
+
tags: ['/user_identities'],
|
|
59703
|
+
'x-fern-sdk-group-name': ['user_identities'],
|
|
59704
|
+
'x-fern-sdk-method-name': 'list_acs_users',
|
|
59705
|
+
'x-fern-sdk-return-value': 'acs_users',
|
|
59706
|
+
'x-response-key': 'acs_users',
|
|
59707
|
+
'x-title': 'List ACS Users Associated with a User Identity',
|
|
59708
|
+
},
|
|
59709
|
+
},
|
|
59710
|
+
'/user_identities/remove_acs_user': {
|
|
59711
|
+
delete: {
|
|
59712
|
+
description:
|
|
59713
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
59714
|
+
operationId: 'userIdentitiesRemoveAcsUserDelete',
|
|
59715
|
+
parameters: [
|
|
59716
|
+
{
|
|
59717
|
+
in: 'query',
|
|
59718
|
+
name: 'user_identity_id',
|
|
59719
|
+
required: true,
|
|
59720
|
+
schema: {
|
|
59721
|
+
description:
|
|
59722
|
+
'ID of the user identity from which you want to remove an access system user.',
|
|
59723
|
+
format: 'uuid',
|
|
59724
|
+
type: 'string',
|
|
59725
|
+
},
|
|
59726
|
+
},
|
|
59727
|
+
{
|
|
59728
|
+
in: 'query',
|
|
59729
|
+
name: 'acs_user_id',
|
|
59730
|
+
required: true,
|
|
59731
|
+
schema: {
|
|
59732
|
+
description:
|
|
59733
|
+
'ID of the access system user that you want to remove from the user identity..',
|
|
59734
|
+
format: 'uuid',
|
|
59735
|
+
type: 'string',
|
|
59736
|
+
},
|
|
59737
|
+
},
|
|
59738
|
+
],
|
|
59739
|
+
responses: {
|
|
59740
|
+
200: {
|
|
59741
|
+
content: {
|
|
59742
|
+
'application/json': {
|
|
59743
|
+
schema: {
|
|
59744
|
+
properties: { ok: { type: 'boolean' } },
|
|
59745
|
+
required: ['ok'],
|
|
59746
|
+
type: 'object',
|
|
59747
|
+
},
|
|
59748
|
+
},
|
|
59749
|
+
},
|
|
59750
|
+
description: 'OK',
|
|
59751
|
+
},
|
|
59752
|
+
400: { description: 'Bad Request' },
|
|
59753
|
+
401: { description: 'Unauthorized' },
|
|
59754
|
+
},
|
|
59755
|
+
security: [
|
|
59756
|
+
{ api_key: [] },
|
|
59757
|
+
{ pat_with_workspace: [] },
|
|
59758
|
+
{ console_session_with_workspace: [] },
|
|
59759
|
+
],
|
|
59760
|
+
summary: '/user_identities/remove_acs_user',
|
|
59761
|
+
tags: ['/user_identities'],
|
|
59762
|
+
'x-fern-sdk-group-name': ['user_identities'],
|
|
59763
|
+
'x-fern-sdk-method-name': 'remove_acs_user',
|
|
59764
|
+
'x-response-key': null,
|
|
59765
|
+
'x-title': 'Remove an ACS User from a User Identity',
|
|
59766
|
+
},
|
|
59767
|
+
post: {
|
|
59768
|
+
description:
|
|
59769
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
59770
|
+
operationId: 'userIdentitiesRemoveAcsUserPost',
|
|
59771
|
+
requestBody: {
|
|
59772
|
+
content: {
|
|
59773
|
+
'application/json': {
|
|
59774
|
+
schema: {
|
|
59775
|
+
properties: {
|
|
59776
|
+
acs_user_id: {
|
|
59777
|
+
description:
|
|
59778
|
+
'ID of the access system user that you want to remove from the user identity..',
|
|
59779
|
+
format: 'uuid',
|
|
59780
|
+
type: 'string',
|
|
59781
|
+
},
|
|
59782
|
+
user_identity_id: {
|
|
59783
|
+
description:
|
|
59784
|
+
'ID of the user identity from which you want to remove an access system user.',
|
|
57897
59785
|
format: 'uuid',
|
|
57898
59786
|
type: 'string',
|
|
57899
59787
|
},
|
|
57900
59788
|
},
|
|
57901
|
-
required: ['user_identity_id'],
|
|
59789
|
+
required: ['user_identity_id', 'acs_user_id'],
|
|
57902
59790
|
type: 'object',
|
|
57903
59791
|
},
|
|
57904
59792
|
},
|
|
@@ -57909,14 +59797,8 @@ export default {
|
|
|
57909
59797
|
content: {
|
|
57910
59798
|
'application/json': {
|
|
57911
59799
|
schema: {
|
|
57912
|
-
properties: {
|
|
57913
|
-
|
|
57914
|
-
items: { $ref: '#/components/schemas/acs_system' },
|
|
57915
|
-
type: 'array',
|
|
57916
|
-
},
|
|
57917
|
-
ok: { type: 'boolean' },
|
|
57918
|
-
},
|
|
57919
|
-
required: ['acs_systems', 'ok'],
|
|
59800
|
+
properties: { ok: { type: 'boolean' } },
|
|
59801
|
+
required: ['ok'],
|
|
57920
59802
|
type: 'object',
|
|
57921
59803
|
},
|
|
57922
59804
|
},
|
|
@@ -57927,25 +59809,23 @@ export default {
|
|
|
57927
59809
|
401: { description: 'Unauthorized' },
|
|
57928
59810
|
},
|
|
57929
59811
|
security: [
|
|
57930
|
-
{
|
|
59812
|
+
{ api_key: [] },
|
|
57931
59813
|
{ pat_with_workspace: [] },
|
|
57932
59814
|
{ console_session_with_workspace: [] },
|
|
57933
|
-
{ api_key: [] },
|
|
57934
59815
|
],
|
|
57935
|
-
summary: '/user_identities/
|
|
59816
|
+
summary: '/user_identities/remove_acs_user',
|
|
57936
59817
|
tags: ['/user_identities'],
|
|
57937
59818
|
'x-fern-sdk-group-name': ['user_identities'],
|
|
57938
|
-
'x-fern-sdk-method-name': '
|
|
57939
|
-
'x-
|
|
57940
|
-
'x-
|
|
57941
|
-
'x-title': 'List ACS Systems Associated with a User Identity',
|
|
59819
|
+
'x-fern-sdk-method-name': 'remove_acs_user',
|
|
59820
|
+
'x-response-key': null,
|
|
59821
|
+
'x-title': 'Remove an ACS User from a User Identity',
|
|
57942
59822
|
},
|
|
57943
59823
|
},
|
|
57944
|
-
'/user_identities/
|
|
57945
|
-
|
|
59824
|
+
'/user_identities/revoke_access_to_device': {
|
|
59825
|
+
delete: {
|
|
57946
59826
|
description:
|
|
57947
|
-
'
|
|
57948
|
-
operationId: '
|
|
59827
|
+
'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
59828
|
+
operationId: 'userIdentitiesRevokeAccessToDeviceDelete',
|
|
57949
59829
|
parameters: [
|
|
57950
59830
|
{
|
|
57951
59831
|
in: 'query',
|
|
@@ -57953,7 +59833,18 @@ export default {
|
|
|
57953
59833
|
required: true,
|
|
57954
59834
|
schema: {
|
|
57955
59835
|
description:
|
|
57956
|
-
'ID of the user identity
|
|
59836
|
+
'ID of the user identity from which you want to revoke access to a device.',
|
|
59837
|
+
format: 'uuid',
|
|
59838
|
+
type: 'string',
|
|
59839
|
+
},
|
|
59840
|
+
},
|
|
59841
|
+
{
|
|
59842
|
+
in: 'query',
|
|
59843
|
+
name: 'device_id',
|
|
59844
|
+
required: true,
|
|
59845
|
+
schema: {
|
|
59846
|
+
description:
|
|
59847
|
+
'ID of the managed device to which you want to revoke access from the user identity.',
|
|
57957
59848
|
format: 'uuid',
|
|
57958
59849
|
type: 'string',
|
|
57959
59850
|
},
|
|
@@ -57964,14 +59855,8 @@ export default {
|
|
|
57964
59855
|
content: {
|
|
57965
59856
|
'application/json': {
|
|
57966
59857
|
schema: {
|
|
57967
|
-
properties: {
|
|
57968
|
-
|
|
57969
|
-
items: { $ref: '#/components/schemas/acs_user' },
|
|
57970
|
-
type: 'array',
|
|
57971
|
-
},
|
|
57972
|
-
ok: { type: 'boolean' },
|
|
57973
|
-
},
|
|
57974
|
-
required: ['acs_users', 'ok'],
|
|
59858
|
+
properties: { ok: { type: 'boolean' } },
|
|
59859
|
+
required: ['ok'],
|
|
57975
59860
|
type: 'object',
|
|
57976
59861
|
},
|
|
57977
59862
|
},
|
|
@@ -57986,31 +59871,36 @@ export default {
|
|
|
57986
59871
|
{ pat_with_workspace: [] },
|
|
57987
59872
|
{ console_session_with_workspace: [] },
|
|
57988
59873
|
],
|
|
57989
|
-
summary: '/user_identities/
|
|
59874
|
+
summary: '/user_identities/revoke_access_to_device',
|
|
57990
59875
|
tags: ['/user_identities'],
|
|
57991
59876
|
'x-fern-sdk-group-name': ['user_identities'],
|
|
57992
|
-
'x-fern-sdk-method-name': '
|
|
57993
|
-
'x-
|
|
57994
|
-
'x-
|
|
57995
|
-
'x-title': 'List ACS Users Associated with a User Identity',
|
|
59877
|
+
'x-fern-sdk-method-name': 'revoke_access_to_device',
|
|
59878
|
+
'x-response-key': null,
|
|
59879
|
+
'x-title': 'Revoke Access to a Device from a User Identity',
|
|
57996
59880
|
},
|
|
57997
59881
|
post: {
|
|
57998
59882
|
description:
|
|
57999
|
-
'
|
|
58000
|
-
operationId: '
|
|
59883
|
+
'Revokes access to a specified [device](https://docs.seam.co/latest/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
|
|
59884
|
+
operationId: 'userIdentitiesRevokeAccessToDevicePost',
|
|
58001
59885
|
requestBody: {
|
|
58002
59886
|
content: {
|
|
58003
59887
|
'application/json': {
|
|
58004
59888
|
schema: {
|
|
58005
59889
|
properties: {
|
|
59890
|
+
device_id: {
|
|
59891
|
+
description:
|
|
59892
|
+
'ID of the managed device to which you want to revoke access from the user identity.',
|
|
59893
|
+
format: 'uuid',
|
|
59894
|
+
type: 'string',
|
|
59895
|
+
},
|
|
58006
59896
|
user_identity_id: {
|
|
58007
59897
|
description:
|
|
58008
|
-
'ID of the user identity
|
|
59898
|
+
'ID of the user identity from which you want to revoke access to a device.',
|
|
58009
59899
|
format: 'uuid',
|
|
58010
59900
|
type: 'string',
|
|
58011
59901
|
},
|
|
58012
59902
|
},
|
|
58013
|
-
required: ['user_identity_id'],
|
|
59903
|
+
required: ['user_identity_id', 'device_id'],
|
|
58014
59904
|
type: 'object',
|
|
58015
59905
|
},
|
|
58016
59906
|
},
|
|
@@ -58021,14 +59911,8 @@ export default {
|
|
|
58021
59911
|
content: {
|
|
58022
59912
|
'application/json': {
|
|
58023
59913
|
schema: {
|
|
58024
|
-
properties: {
|
|
58025
|
-
|
|
58026
|
-
items: { $ref: '#/components/schemas/acs_user' },
|
|
58027
|
-
type: 'array',
|
|
58028
|
-
},
|
|
58029
|
-
ok: { type: 'boolean' },
|
|
58030
|
-
},
|
|
58031
|
-
required: ['acs_users', 'ok'],
|
|
59914
|
+
properties: { ok: { type: 'boolean' } },
|
|
59915
|
+
required: ['ok'],
|
|
58032
59916
|
type: 'object',
|
|
58033
59917
|
},
|
|
58034
59918
|
},
|
|
@@ -58043,20 +59927,19 @@ export default {
|
|
|
58043
59927
|
{ pat_with_workspace: [] },
|
|
58044
59928
|
{ console_session_with_workspace: [] },
|
|
58045
59929
|
],
|
|
58046
|
-
summary: '/user_identities/
|
|
59930
|
+
summary: '/user_identities/revoke_access_to_device',
|
|
58047
59931
|
tags: ['/user_identities'],
|
|
58048
59932
|
'x-fern-sdk-group-name': ['user_identities'],
|
|
58049
|
-
'x-fern-sdk-method-name': '
|
|
58050
|
-
'x-
|
|
58051
|
-
'x-
|
|
58052
|
-
'x-title': 'List ACS Users Associated with a User Identity',
|
|
59933
|
+
'x-fern-sdk-method-name': 'revoke_access_to_device',
|
|
59934
|
+
'x-response-key': null,
|
|
59935
|
+
'x-title': 'Revoke Access to a Device from a User Identity',
|
|
58053
59936
|
},
|
|
58054
59937
|
},
|
|
58055
|
-
'/user_identities/
|
|
58056
|
-
|
|
59938
|
+
'/user_identities/unmanaged/get': {
|
|
59939
|
+
get: {
|
|
58057
59940
|
description:
|
|
58058
|
-
'
|
|
58059
|
-
operationId: '
|
|
59941
|
+
'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).',
|
|
59942
|
+
operationId: 'userIdentitiesUnmanagedGetGet',
|
|
58060
59943
|
parameters: [
|
|
58061
59944
|
{
|
|
58062
59945
|
in: 'query',
|
|
@@ -58064,18 +59947,7 @@ export default {
|
|
|
58064
59947
|
required: true,
|
|
58065
59948
|
schema: {
|
|
58066
59949
|
description:
|
|
58067
|
-
'ID of the user identity
|
|
58068
|
-
format: 'uuid',
|
|
58069
|
-
type: 'string',
|
|
58070
|
-
},
|
|
58071
|
-
},
|
|
58072
|
-
{
|
|
58073
|
-
in: 'query',
|
|
58074
|
-
name: 'acs_user_id',
|
|
58075
|
-
required: true,
|
|
58076
|
-
schema: {
|
|
58077
|
-
description:
|
|
58078
|
-
'ID of the access system user that you want to remove from the user identity..',
|
|
59950
|
+
'ID of the unmanaged user identity that you want to get.',
|
|
58079
59951
|
format: 'uuid',
|
|
58080
59952
|
type: 'string',
|
|
58081
59953
|
},
|
|
@@ -58086,8 +59958,200 @@ export default {
|
|
|
58086
59958
|
content: {
|
|
58087
59959
|
'application/json': {
|
|
58088
59960
|
schema: {
|
|
58089
|
-
properties: {
|
|
58090
|
-
|
|
59961
|
+
properties: {
|
|
59962
|
+
ok: { type: 'boolean' },
|
|
59963
|
+
user_identity: {
|
|
59964
|
+
description:
|
|
59965
|
+
'Represents an unmanaged user identity. Unmanaged user identities do not have keys.',
|
|
59966
|
+
properties: {
|
|
59967
|
+
acs_user_ids: {
|
|
59968
|
+
description:
|
|
59969
|
+
'Array of access system user IDs associated with the user identity.',
|
|
59970
|
+
items: { format: 'uuid', type: 'string' },
|
|
59971
|
+
type: 'array',
|
|
59972
|
+
},
|
|
59973
|
+
created_at: {
|
|
59974
|
+
description:
|
|
59975
|
+
'Date and time at which the user identity was created.',
|
|
59976
|
+
format: 'date-time',
|
|
59977
|
+
type: 'string',
|
|
59978
|
+
},
|
|
59979
|
+
display_name: { minLength: 1, type: 'string' },
|
|
59980
|
+
email_address: {
|
|
59981
|
+
description:
|
|
59982
|
+
'Unique email address for the user identity.',
|
|
59983
|
+
format: 'email',
|
|
59984
|
+
nullable: true,
|
|
59985
|
+
type: 'string',
|
|
59986
|
+
},
|
|
59987
|
+
errors: {
|
|
59988
|
+
description:
|
|
59989
|
+
'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.',
|
|
59990
|
+
items: {
|
|
59991
|
+
description:
|
|
59992
|
+
'Errors associated with the user identity.',
|
|
59993
|
+
discriminator: { propertyName: 'error_code' },
|
|
59994
|
+
oneOf: [
|
|
59995
|
+
{
|
|
59996
|
+
description:
|
|
59997
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
59998
|
+
properties: {
|
|
59999
|
+
acs_system_id: {
|
|
60000
|
+
description:
|
|
60001
|
+
'ID of the access system that the user identity is associated with.',
|
|
60002
|
+
format: 'uuid',
|
|
60003
|
+
type: 'string',
|
|
60004
|
+
},
|
|
60005
|
+
acs_user_id: {
|
|
60006
|
+
description:
|
|
60007
|
+
'ID of the access system user that has an issue.',
|
|
60008
|
+
format: 'uuid',
|
|
60009
|
+
type: 'string',
|
|
60010
|
+
},
|
|
60011
|
+
created_at: {
|
|
60012
|
+
description:
|
|
60013
|
+
'Date and time at which Seam created the error.',
|
|
60014
|
+
format: 'date-time',
|
|
60015
|
+
type: 'string',
|
|
60016
|
+
},
|
|
60017
|
+
error_code: {
|
|
60018
|
+
description:
|
|
60019
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
60020
|
+
enum: ['issue_with_acs_user'],
|
|
60021
|
+
type: 'string',
|
|
60022
|
+
},
|
|
60023
|
+
message: {
|
|
60024
|
+
description:
|
|
60025
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
60026
|
+
type: 'string',
|
|
60027
|
+
},
|
|
60028
|
+
},
|
|
60029
|
+
required: [
|
|
60030
|
+
'created_at',
|
|
60031
|
+
'message',
|
|
60032
|
+
'error_code',
|
|
60033
|
+
'acs_user_id',
|
|
60034
|
+
'acs_system_id',
|
|
60035
|
+
],
|
|
60036
|
+
type: 'object',
|
|
60037
|
+
},
|
|
60038
|
+
],
|
|
60039
|
+
},
|
|
60040
|
+
type: 'array',
|
|
60041
|
+
},
|
|
60042
|
+
full_name: {
|
|
60043
|
+
minLength: 1,
|
|
60044
|
+
nullable: true,
|
|
60045
|
+
type: 'string',
|
|
60046
|
+
},
|
|
60047
|
+
phone_number: {
|
|
60048
|
+
description:
|
|
60049
|
+
'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
60050
|
+
nullable: true,
|
|
60051
|
+
type: 'string',
|
|
60052
|
+
},
|
|
60053
|
+
user_identity_id: {
|
|
60054
|
+
description: 'ID of the user identity.',
|
|
60055
|
+
format: 'uuid',
|
|
60056
|
+
type: 'string',
|
|
60057
|
+
},
|
|
60058
|
+
warnings: {
|
|
60059
|
+
description:
|
|
60060
|
+
'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.',
|
|
60061
|
+
items: {
|
|
60062
|
+
description:
|
|
60063
|
+
'Warnings associated with the user identity.',
|
|
60064
|
+
discriminator: { propertyName: 'warning_code' },
|
|
60065
|
+
oneOf: [
|
|
60066
|
+
{
|
|
60067
|
+
description:
|
|
60068
|
+
'Indicates that the user identity is currently being deleted.',
|
|
60069
|
+
properties: {
|
|
60070
|
+
created_at: {
|
|
60071
|
+
description:
|
|
60072
|
+
'Date and time at which Seam created the warning.',
|
|
60073
|
+
format: 'date-time',
|
|
60074
|
+
type: 'string',
|
|
60075
|
+
},
|
|
60076
|
+
message: {
|
|
60077
|
+
description:
|
|
60078
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60079
|
+
type: 'string',
|
|
60080
|
+
},
|
|
60081
|
+
warning_code: {
|
|
60082
|
+
description:
|
|
60083
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60084
|
+
enum: ['being_deleted'],
|
|
60085
|
+
type: 'string',
|
|
60086
|
+
},
|
|
60087
|
+
},
|
|
60088
|
+
required: [
|
|
60089
|
+
'created_at',
|
|
60090
|
+
'message',
|
|
60091
|
+
'warning_code',
|
|
60092
|
+
],
|
|
60093
|
+
type: 'object',
|
|
60094
|
+
},
|
|
60095
|
+
{
|
|
60096
|
+
description:
|
|
60097
|
+
"Indicates that the ACS user's profile does not match the user identity's profile",
|
|
60098
|
+
properties: {
|
|
60099
|
+
created_at: {
|
|
60100
|
+
description:
|
|
60101
|
+
'Date and time at which Seam created the warning.',
|
|
60102
|
+
format: 'date-time',
|
|
60103
|
+
type: 'string',
|
|
60104
|
+
},
|
|
60105
|
+
message: {
|
|
60106
|
+
description:
|
|
60107
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60108
|
+
type: 'string',
|
|
60109
|
+
},
|
|
60110
|
+
warning_code: {
|
|
60111
|
+
description:
|
|
60112
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60113
|
+
enum: [
|
|
60114
|
+
'acs_user_profile_does_not_match_user_identity',
|
|
60115
|
+
],
|
|
60116
|
+
type: 'string',
|
|
60117
|
+
},
|
|
60118
|
+
},
|
|
60119
|
+
required: [
|
|
60120
|
+
'created_at',
|
|
60121
|
+
'message',
|
|
60122
|
+
'warning_code',
|
|
60123
|
+
],
|
|
60124
|
+
type: 'object',
|
|
60125
|
+
},
|
|
60126
|
+
],
|
|
60127
|
+
},
|
|
60128
|
+
type: 'array',
|
|
60129
|
+
},
|
|
60130
|
+
workspace_id: {
|
|
60131
|
+
description:
|
|
60132
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
60133
|
+
format: 'uuid',
|
|
60134
|
+
type: 'string',
|
|
60135
|
+
},
|
|
60136
|
+
},
|
|
60137
|
+
required: [
|
|
60138
|
+
'user_identity_id',
|
|
60139
|
+
'email_address',
|
|
60140
|
+
'phone_number',
|
|
60141
|
+
'display_name',
|
|
60142
|
+
'full_name',
|
|
60143
|
+
'created_at',
|
|
60144
|
+
'workspace_id',
|
|
60145
|
+
'errors',
|
|
60146
|
+
'warnings',
|
|
60147
|
+
'acs_user_ids',
|
|
60148
|
+
],
|
|
60149
|
+
type: 'object',
|
|
60150
|
+
'x-draft': 'Early access.',
|
|
60151
|
+
'x-route-path': '/user_identities/unmanaged',
|
|
60152
|
+
},
|
|
60153
|
+
},
|
|
60154
|
+
required: ['user_identity', 'ok'],
|
|
58091
60155
|
type: 'object',
|
|
58092
60156
|
},
|
|
58093
60157
|
},
|
|
@@ -58102,36 +60166,31 @@ export default {
|
|
|
58102
60166
|
{ pat_with_workspace: [] },
|
|
58103
60167
|
{ console_session_with_workspace: [] },
|
|
58104
60168
|
],
|
|
58105
|
-
summary: '/user_identities/
|
|
60169
|
+
summary: '/user_identities/unmanaged/get',
|
|
58106
60170
|
tags: ['/user_identities'],
|
|
58107
|
-
'x-fern-sdk-group-name': ['user_identities'],
|
|
58108
|
-
'x-fern-sdk-method-name': '
|
|
58109
|
-
'x-
|
|
58110
|
-
'x-
|
|
60171
|
+
'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
|
|
60172
|
+
'x-fern-sdk-method-name': 'get',
|
|
60173
|
+
'x-fern-sdk-return-value': 'user_identity',
|
|
60174
|
+
'x-response-key': 'user_identity',
|
|
60175
|
+
'x-title': 'Get an Unmanaged User Identity',
|
|
58111
60176
|
},
|
|
58112
60177
|
post: {
|
|
58113
|
-
description:
|
|
58114
|
-
'
|
|
58115
|
-
operationId: '
|
|
60178
|
+
description:
|
|
60179
|
+
'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).',
|
|
60180
|
+
operationId: 'userIdentitiesUnmanagedGetPost',
|
|
58116
60181
|
requestBody: {
|
|
58117
60182
|
content: {
|
|
58118
60183
|
'application/json': {
|
|
58119
60184
|
schema: {
|
|
58120
60185
|
properties: {
|
|
58121
|
-
acs_user_id: {
|
|
58122
|
-
description:
|
|
58123
|
-
'ID of the access system user that you want to remove from the user identity..',
|
|
58124
|
-
format: 'uuid',
|
|
58125
|
-
type: 'string',
|
|
58126
|
-
},
|
|
58127
60186
|
user_identity_id: {
|
|
58128
60187
|
description:
|
|
58129
|
-
'ID of the user identity
|
|
60188
|
+
'ID of the unmanaged user identity that you want to get.',
|
|
58130
60189
|
format: 'uuid',
|
|
58131
60190
|
type: 'string',
|
|
58132
60191
|
},
|
|
58133
60192
|
},
|
|
58134
|
-
required: ['user_identity_id'
|
|
60193
|
+
required: ['user_identity_id'],
|
|
58135
60194
|
type: 'object',
|
|
58136
60195
|
},
|
|
58137
60196
|
},
|
|
@@ -58142,8 +60201,200 @@ export default {
|
|
|
58142
60201
|
content: {
|
|
58143
60202
|
'application/json': {
|
|
58144
60203
|
schema: {
|
|
58145
|
-
properties: {
|
|
58146
|
-
|
|
60204
|
+
properties: {
|
|
60205
|
+
ok: { type: 'boolean' },
|
|
60206
|
+
user_identity: {
|
|
60207
|
+
description:
|
|
60208
|
+
'Represents an unmanaged user identity. Unmanaged user identities do not have keys.',
|
|
60209
|
+
properties: {
|
|
60210
|
+
acs_user_ids: {
|
|
60211
|
+
description:
|
|
60212
|
+
'Array of access system user IDs associated with the user identity.',
|
|
60213
|
+
items: { format: 'uuid', type: 'string' },
|
|
60214
|
+
type: 'array',
|
|
60215
|
+
},
|
|
60216
|
+
created_at: {
|
|
60217
|
+
description:
|
|
60218
|
+
'Date and time at which the user identity was created.',
|
|
60219
|
+
format: 'date-time',
|
|
60220
|
+
type: 'string',
|
|
60221
|
+
},
|
|
60222
|
+
display_name: { minLength: 1, type: 'string' },
|
|
60223
|
+
email_address: {
|
|
60224
|
+
description:
|
|
60225
|
+
'Unique email address for the user identity.',
|
|
60226
|
+
format: 'email',
|
|
60227
|
+
nullable: true,
|
|
60228
|
+
type: 'string',
|
|
60229
|
+
},
|
|
60230
|
+
errors: {
|
|
60231
|
+
description:
|
|
60232
|
+
'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.',
|
|
60233
|
+
items: {
|
|
60234
|
+
description:
|
|
60235
|
+
'Errors associated with the user identity.',
|
|
60236
|
+
discriminator: { propertyName: 'error_code' },
|
|
60237
|
+
oneOf: [
|
|
60238
|
+
{
|
|
60239
|
+
description:
|
|
60240
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
60241
|
+
properties: {
|
|
60242
|
+
acs_system_id: {
|
|
60243
|
+
description:
|
|
60244
|
+
'ID of the access system that the user identity is associated with.',
|
|
60245
|
+
format: 'uuid',
|
|
60246
|
+
type: 'string',
|
|
60247
|
+
},
|
|
60248
|
+
acs_user_id: {
|
|
60249
|
+
description:
|
|
60250
|
+
'ID of the access system user that has an issue.',
|
|
60251
|
+
format: 'uuid',
|
|
60252
|
+
type: 'string',
|
|
60253
|
+
},
|
|
60254
|
+
created_at: {
|
|
60255
|
+
description:
|
|
60256
|
+
'Date and time at which Seam created the error.',
|
|
60257
|
+
format: 'date-time',
|
|
60258
|
+
type: 'string',
|
|
60259
|
+
},
|
|
60260
|
+
error_code: {
|
|
60261
|
+
description:
|
|
60262
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
60263
|
+
enum: ['issue_with_acs_user'],
|
|
60264
|
+
type: 'string',
|
|
60265
|
+
},
|
|
60266
|
+
message: {
|
|
60267
|
+
description:
|
|
60268
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
60269
|
+
type: 'string',
|
|
60270
|
+
},
|
|
60271
|
+
},
|
|
60272
|
+
required: [
|
|
60273
|
+
'created_at',
|
|
60274
|
+
'message',
|
|
60275
|
+
'error_code',
|
|
60276
|
+
'acs_user_id',
|
|
60277
|
+
'acs_system_id',
|
|
60278
|
+
],
|
|
60279
|
+
type: 'object',
|
|
60280
|
+
},
|
|
60281
|
+
],
|
|
60282
|
+
},
|
|
60283
|
+
type: 'array',
|
|
60284
|
+
},
|
|
60285
|
+
full_name: {
|
|
60286
|
+
minLength: 1,
|
|
60287
|
+
nullable: true,
|
|
60288
|
+
type: 'string',
|
|
60289
|
+
},
|
|
60290
|
+
phone_number: {
|
|
60291
|
+
description:
|
|
60292
|
+
'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
60293
|
+
nullable: true,
|
|
60294
|
+
type: 'string',
|
|
60295
|
+
},
|
|
60296
|
+
user_identity_id: {
|
|
60297
|
+
description: 'ID of the user identity.',
|
|
60298
|
+
format: 'uuid',
|
|
60299
|
+
type: 'string',
|
|
60300
|
+
},
|
|
60301
|
+
warnings: {
|
|
60302
|
+
description:
|
|
60303
|
+
'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.',
|
|
60304
|
+
items: {
|
|
60305
|
+
description:
|
|
60306
|
+
'Warnings associated with the user identity.',
|
|
60307
|
+
discriminator: { propertyName: 'warning_code' },
|
|
60308
|
+
oneOf: [
|
|
60309
|
+
{
|
|
60310
|
+
description:
|
|
60311
|
+
'Indicates that the user identity is currently being deleted.',
|
|
60312
|
+
properties: {
|
|
60313
|
+
created_at: {
|
|
60314
|
+
description:
|
|
60315
|
+
'Date and time at which Seam created the warning.',
|
|
60316
|
+
format: 'date-time',
|
|
60317
|
+
type: 'string',
|
|
60318
|
+
},
|
|
60319
|
+
message: {
|
|
60320
|
+
description:
|
|
60321
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60322
|
+
type: 'string',
|
|
60323
|
+
},
|
|
60324
|
+
warning_code: {
|
|
60325
|
+
description:
|
|
60326
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60327
|
+
enum: ['being_deleted'],
|
|
60328
|
+
type: 'string',
|
|
60329
|
+
},
|
|
60330
|
+
},
|
|
60331
|
+
required: [
|
|
60332
|
+
'created_at',
|
|
60333
|
+
'message',
|
|
60334
|
+
'warning_code',
|
|
60335
|
+
],
|
|
60336
|
+
type: 'object',
|
|
60337
|
+
},
|
|
60338
|
+
{
|
|
60339
|
+
description:
|
|
60340
|
+
"Indicates that the ACS user's profile does not match the user identity's profile",
|
|
60341
|
+
properties: {
|
|
60342
|
+
created_at: {
|
|
60343
|
+
description:
|
|
60344
|
+
'Date and time at which Seam created the warning.',
|
|
60345
|
+
format: 'date-time',
|
|
60346
|
+
type: 'string',
|
|
60347
|
+
},
|
|
60348
|
+
message: {
|
|
60349
|
+
description:
|
|
60350
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60351
|
+
type: 'string',
|
|
60352
|
+
},
|
|
60353
|
+
warning_code: {
|
|
60354
|
+
description:
|
|
60355
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60356
|
+
enum: [
|
|
60357
|
+
'acs_user_profile_does_not_match_user_identity',
|
|
60358
|
+
],
|
|
60359
|
+
type: 'string',
|
|
60360
|
+
},
|
|
60361
|
+
},
|
|
60362
|
+
required: [
|
|
60363
|
+
'created_at',
|
|
60364
|
+
'message',
|
|
60365
|
+
'warning_code',
|
|
60366
|
+
],
|
|
60367
|
+
type: 'object',
|
|
60368
|
+
},
|
|
60369
|
+
],
|
|
60370
|
+
},
|
|
60371
|
+
type: 'array',
|
|
60372
|
+
},
|
|
60373
|
+
workspace_id: {
|
|
60374
|
+
description:
|
|
60375
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
60376
|
+
format: 'uuid',
|
|
60377
|
+
type: 'string',
|
|
60378
|
+
},
|
|
60379
|
+
},
|
|
60380
|
+
required: [
|
|
60381
|
+
'user_identity_id',
|
|
60382
|
+
'email_address',
|
|
60383
|
+
'phone_number',
|
|
60384
|
+
'display_name',
|
|
60385
|
+
'full_name',
|
|
60386
|
+
'created_at',
|
|
60387
|
+
'workspace_id',
|
|
60388
|
+
'errors',
|
|
60389
|
+
'warnings',
|
|
60390
|
+
'acs_user_ids',
|
|
60391
|
+
],
|
|
60392
|
+
type: 'object',
|
|
60393
|
+
'x-draft': 'Early access.',
|
|
60394
|
+
'x-route-path': '/user_identities/unmanaged',
|
|
60395
|
+
},
|
|
60396
|
+
},
|
|
60397
|
+
required: ['user_identity', 'ok'],
|
|
58147
60398
|
type: 'object',
|
|
58148
60399
|
},
|
|
58149
60400
|
},
|
|
@@ -58158,39 +60409,27 @@ export default {
|
|
|
58158
60409
|
{ pat_with_workspace: [] },
|
|
58159
60410
|
{ console_session_with_workspace: [] },
|
|
58160
60411
|
],
|
|
58161
|
-
summary: '/user_identities/
|
|
60412
|
+
summary: '/user_identities/unmanaged/get',
|
|
58162
60413
|
tags: ['/user_identities'],
|
|
58163
|
-
'x-fern-sdk-group-name': ['user_identities'],
|
|
58164
|
-
'x-fern-sdk-method-name': '
|
|
58165
|
-
'x-
|
|
58166
|
-
'x-
|
|
60414
|
+
'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
|
|
60415
|
+
'x-fern-sdk-method-name': 'get',
|
|
60416
|
+
'x-fern-sdk-return-value': 'user_identity',
|
|
60417
|
+
'x-response-key': 'user_identity',
|
|
60418
|
+
'x-title': 'Get an Unmanaged User Identity',
|
|
58167
60419
|
},
|
|
58168
60420
|
},
|
|
58169
|
-
'/user_identities/
|
|
58170
|
-
|
|
60421
|
+
'/user_identities/unmanaged/list': {
|
|
60422
|
+
get: {
|
|
58171
60423
|
description:
|
|
58172
|
-
'
|
|
58173
|
-
operationId: '
|
|
60424
|
+
'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).',
|
|
60425
|
+
operationId: 'userIdentitiesUnmanagedListGet',
|
|
58174
60426
|
parameters: [
|
|
58175
60427
|
{
|
|
58176
60428
|
in: 'query',
|
|
58177
|
-
name: '
|
|
58178
|
-
required: true,
|
|
58179
|
-
schema: {
|
|
58180
|
-
description:
|
|
58181
|
-
'ID of the user identity from which you want to revoke access to a device.',
|
|
58182
|
-
format: 'uuid',
|
|
58183
|
-
type: 'string',
|
|
58184
|
-
},
|
|
58185
|
-
},
|
|
58186
|
-
{
|
|
58187
|
-
in: 'query',
|
|
58188
|
-
name: 'device_id',
|
|
58189
|
-
required: true,
|
|
60429
|
+
name: 'search',
|
|
58190
60430
|
schema: {
|
|
58191
60431
|
description:
|
|
58192
|
-
'
|
|
58193
|
-
format: 'uuid',
|
|
60432
|
+
'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`.',
|
|
58194
60433
|
type: 'string',
|
|
58195
60434
|
},
|
|
58196
60435
|
},
|
|
@@ -58200,8 +60439,203 @@ export default {
|
|
|
58200
60439
|
content: {
|
|
58201
60440
|
'application/json': {
|
|
58202
60441
|
schema: {
|
|
58203
|
-
properties: {
|
|
58204
|
-
|
|
60442
|
+
properties: {
|
|
60443
|
+
ok: { type: 'boolean' },
|
|
60444
|
+
user_identities: {
|
|
60445
|
+
items: {
|
|
60446
|
+
description:
|
|
60447
|
+
'Represents an unmanaged user identity. Unmanaged user identities do not have keys.',
|
|
60448
|
+
properties: {
|
|
60449
|
+
acs_user_ids: {
|
|
60450
|
+
description:
|
|
60451
|
+
'Array of access system user IDs associated with the user identity.',
|
|
60452
|
+
items: { format: 'uuid', type: 'string' },
|
|
60453
|
+
type: 'array',
|
|
60454
|
+
},
|
|
60455
|
+
created_at: {
|
|
60456
|
+
description:
|
|
60457
|
+
'Date and time at which the user identity was created.',
|
|
60458
|
+
format: 'date-time',
|
|
60459
|
+
type: 'string',
|
|
60460
|
+
},
|
|
60461
|
+
display_name: { minLength: 1, type: 'string' },
|
|
60462
|
+
email_address: {
|
|
60463
|
+
description:
|
|
60464
|
+
'Unique email address for the user identity.',
|
|
60465
|
+
format: 'email',
|
|
60466
|
+
nullable: true,
|
|
60467
|
+
type: 'string',
|
|
60468
|
+
},
|
|
60469
|
+
errors: {
|
|
60470
|
+
description:
|
|
60471
|
+
'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.',
|
|
60472
|
+
items: {
|
|
60473
|
+
description:
|
|
60474
|
+
'Errors associated with the user identity.',
|
|
60475
|
+
discriminator: { propertyName: 'error_code' },
|
|
60476
|
+
oneOf: [
|
|
60477
|
+
{
|
|
60478
|
+
description:
|
|
60479
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
60480
|
+
properties: {
|
|
60481
|
+
acs_system_id: {
|
|
60482
|
+
description:
|
|
60483
|
+
'ID of the access system that the user identity is associated with.',
|
|
60484
|
+
format: 'uuid',
|
|
60485
|
+
type: 'string',
|
|
60486
|
+
},
|
|
60487
|
+
acs_user_id: {
|
|
60488
|
+
description:
|
|
60489
|
+
'ID of the access system user that has an issue.',
|
|
60490
|
+
format: 'uuid',
|
|
60491
|
+
type: 'string',
|
|
60492
|
+
},
|
|
60493
|
+
created_at: {
|
|
60494
|
+
description:
|
|
60495
|
+
'Date and time at which Seam created the error.',
|
|
60496
|
+
format: 'date-time',
|
|
60497
|
+
type: 'string',
|
|
60498
|
+
},
|
|
60499
|
+
error_code: {
|
|
60500
|
+
description:
|
|
60501
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
60502
|
+
enum: ['issue_with_acs_user'],
|
|
60503
|
+
type: 'string',
|
|
60504
|
+
},
|
|
60505
|
+
message: {
|
|
60506
|
+
description:
|
|
60507
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
60508
|
+
type: 'string',
|
|
60509
|
+
},
|
|
60510
|
+
},
|
|
60511
|
+
required: [
|
|
60512
|
+
'created_at',
|
|
60513
|
+
'message',
|
|
60514
|
+
'error_code',
|
|
60515
|
+
'acs_user_id',
|
|
60516
|
+
'acs_system_id',
|
|
60517
|
+
],
|
|
60518
|
+
type: 'object',
|
|
60519
|
+
},
|
|
60520
|
+
],
|
|
60521
|
+
},
|
|
60522
|
+
type: 'array',
|
|
60523
|
+
},
|
|
60524
|
+
full_name: {
|
|
60525
|
+
minLength: 1,
|
|
60526
|
+
nullable: true,
|
|
60527
|
+
type: 'string',
|
|
60528
|
+
},
|
|
60529
|
+
phone_number: {
|
|
60530
|
+
description:
|
|
60531
|
+
'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
60532
|
+
nullable: true,
|
|
60533
|
+
type: 'string',
|
|
60534
|
+
},
|
|
60535
|
+
user_identity_id: {
|
|
60536
|
+
description: 'ID of the user identity.',
|
|
60537
|
+
format: 'uuid',
|
|
60538
|
+
type: 'string',
|
|
60539
|
+
},
|
|
60540
|
+
warnings: {
|
|
60541
|
+
description:
|
|
60542
|
+
'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.',
|
|
60543
|
+
items: {
|
|
60544
|
+
description:
|
|
60545
|
+
'Warnings associated with the user identity.',
|
|
60546
|
+
discriminator: { propertyName: 'warning_code' },
|
|
60547
|
+
oneOf: [
|
|
60548
|
+
{
|
|
60549
|
+
description:
|
|
60550
|
+
'Indicates that the user identity is currently being deleted.',
|
|
60551
|
+
properties: {
|
|
60552
|
+
created_at: {
|
|
60553
|
+
description:
|
|
60554
|
+
'Date and time at which Seam created the warning.',
|
|
60555
|
+
format: 'date-time',
|
|
60556
|
+
type: 'string',
|
|
60557
|
+
},
|
|
60558
|
+
message: {
|
|
60559
|
+
description:
|
|
60560
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60561
|
+
type: 'string',
|
|
60562
|
+
},
|
|
60563
|
+
warning_code: {
|
|
60564
|
+
description:
|
|
60565
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60566
|
+
enum: ['being_deleted'],
|
|
60567
|
+
type: 'string',
|
|
60568
|
+
},
|
|
60569
|
+
},
|
|
60570
|
+
required: [
|
|
60571
|
+
'created_at',
|
|
60572
|
+
'message',
|
|
60573
|
+
'warning_code',
|
|
60574
|
+
],
|
|
60575
|
+
type: 'object',
|
|
60576
|
+
},
|
|
60577
|
+
{
|
|
60578
|
+
description:
|
|
60579
|
+
"Indicates that the ACS user's profile does not match the user identity's profile",
|
|
60580
|
+
properties: {
|
|
60581
|
+
created_at: {
|
|
60582
|
+
description:
|
|
60583
|
+
'Date and time at which Seam created the warning.',
|
|
60584
|
+
format: 'date-time',
|
|
60585
|
+
type: 'string',
|
|
60586
|
+
},
|
|
60587
|
+
message: {
|
|
60588
|
+
description:
|
|
60589
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60590
|
+
type: 'string',
|
|
60591
|
+
},
|
|
60592
|
+
warning_code: {
|
|
60593
|
+
description:
|
|
60594
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60595
|
+
enum: [
|
|
60596
|
+
'acs_user_profile_does_not_match_user_identity',
|
|
60597
|
+
],
|
|
60598
|
+
type: 'string',
|
|
60599
|
+
},
|
|
60600
|
+
},
|
|
60601
|
+
required: [
|
|
60602
|
+
'created_at',
|
|
60603
|
+
'message',
|
|
60604
|
+
'warning_code',
|
|
60605
|
+
],
|
|
60606
|
+
type: 'object',
|
|
60607
|
+
},
|
|
60608
|
+
],
|
|
60609
|
+
},
|
|
60610
|
+
type: 'array',
|
|
60611
|
+
},
|
|
60612
|
+
workspace_id: {
|
|
60613
|
+
description:
|
|
60614
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
60615
|
+
format: 'uuid',
|
|
60616
|
+
type: 'string',
|
|
60617
|
+
},
|
|
60618
|
+
},
|
|
60619
|
+
required: [
|
|
60620
|
+
'user_identity_id',
|
|
60621
|
+
'email_address',
|
|
60622
|
+
'phone_number',
|
|
60623
|
+
'display_name',
|
|
60624
|
+
'full_name',
|
|
60625
|
+
'created_at',
|
|
60626
|
+
'workspace_id',
|
|
60627
|
+
'errors',
|
|
60628
|
+
'warnings',
|
|
60629
|
+
'acs_user_ids',
|
|
60630
|
+
],
|
|
60631
|
+
type: 'object',
|
|
60632
|
+
'x-draft': 'Early access.',
|
|
60633
|
+
'x-route-path': '/user_identities/unmanaged',
|
|
60634
|
+
},
|
|
60635
|
+
type: 'array',
|
|
60636
|
+
},
|
|
60637
|
+
},
|
|
60638
|
+
required: ['user_identities', 'ok'],
|
|
58205
60639
|
type: 'object',
|
|
58206
60640
|
},
|
|
58207
60641
|
},
|
|
@@ -58213,39 +60647,33 @@ export default {
|
|
|
58213
60647
|
},
|
|
58214
60648
|
security: [
|
|
58215
60649
|
{ api_key: [] },
|
|
60650
|
+
{ client_session: [] },
|
|
58216
60651
|
{ pat_with_workspace: [] },
|
|
58217
60652
|
{ console_session_with_workspace: [] },
|
|
58218
60653
|
],
|
|
58219
|
-
summary: '/user_identities/
|
|
60654
|
+
summary: '/user_identities/unmanaged/list',
|
|
58220
60655
|
tags: ['/user_identities'],
|
|
58221
|
-
'x-fern-sdk-group-name': ['user_identities'],
|
|
58222
|
-
'x-fern-sdk-method-name': '
|
|
58223
|
-
'x-
|
|
58224
|
-
'x-
|
|
60656
|
+
'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
|
|
60657
|
+
'x-fern-sdk-method-name': 'list',
|
|
60658
|
+
'x-fern-sdk-return-value': 'user_identities',
|
|
60659
|
+
'x-response-key': 'user_identities',
|
|
60660
|
+
'x-title': 'List Unmanaged User Identities',
|
|
58225
60661
|
},
|
|
58226
60662
|
post: {
|
|
58227
60663
|
description:
|
|
58228
|
-
'
|
|
58229
|
-
operationId: '
|
|
60664
|
+
'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).',
|
|
60665
|
+
operationId: 'userIdentitiesUnmanagedListPost',
|
|
58230
60666
|
requestBody: {
|
|
58231
60667
|
content: {
|
|
58232
60668
|
'application/json': {
|
|
58233
60669
|
schema: {
|
|
58234
60670
|
properties: {
|
|
58235
|
-
|
|
58236
|
-
description:
|
|
58237
|
-
'ID of the managed device to which you want to revoke access from the user identity.',
|
|
58238
|
-
format: 'uuid',
|
|
58239
|
-
type: 'string',
|
|
58240
|
-
},
|
|
58241
|
-
user_identity_id: {
|
|
60671
|
+
search: {
|
|
58242
60672
|
description:
|
|
58243
|
-
'
|
|
58244
|
-
format: 'uuid',
|
|
60673
|
+
'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`.',
|
|
58245
60674
|
type: 'string',
|
|
58246
60675
|
},
|
|
58247
60676
|
},
|
|
58248
|
-
required: ['user_identity_id', 'device_id'],
|
|
58249
60677
|
type: 'object',
|
|
58250
60678
|
},
|
|
58251
60679
|
},
|
|
@@ -58256,8 +60684,203 @@ export default {
|
|
|
58256
60684
|
content: {
|
|
58257
60685
|
'application/json': {
|
|
58258
60686
|
schema: {
|
|
58259
|
-
properties: {
|
|
58260
|
-
|
|
60687
|
+
properties: {
|
|
60688
|
+
ok: { type: 'boolean' },
|
|
60689
|
+
user_identities: {
|
|
60690
|
+
items: {
|
|
60691
|
+
description:
|
|
60692
|
+
'Represents an unmanaged user identity. Unmanaged user identities do not have keys.',
|
|
60693
|
+
properties: {
|
|
60694
|
+
acs_user_ids: {
|
|
60695
|
+
description:
|
|
60696
|
+
'Array of access system user IDs associated with the user identity.',
|
|
60697
|
+
items: { format: 'uuid', type: 'string' },
|
|
60698
|
+
type: 'array',
|
|
60699
|
+
},
|
|
60700
|
+
created_at: {
|
|
60701
|
+
description:
|
|
60702
|
+
'Date and time at which the user identity was created.',
|
|
60703
|
+
format: 'date-time',
|
|
60704
|
+
type: 'string',
|
|
60705
|
+
},
|
|
60706
|
+
display_name: { minLength: 1, type: 'string' },
|
|
60707
|
+
email_address: {
|
|
60708
|
+
description:
|
|
60709
|
+
'Unique email address for the user identity.',
|
|
60710
|
+
format: 'email',
|
|
60711
|
+
nullable: true,
|
|
60712
|
+
type: 'string',
|
|
60713
|
+
},
|
|
60714
|
+
errors: {
|
|
60715
|
+
description:
|
|
60716
|
+
'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.',
|
|
60717
|
+
items: {
|
|
60718
|
+
description:
|
|
60719
|
+
'Errors associated with the user identity.',
|
|
60720
|
+
discriminator: { propertyName: 'error_code' },
|
|
60721
|
+
oneOf: [
|
|
60722
|
+
{
|
|
60723
|
+
description:
|
|
60724
|
+
'Indicates that there is an issue with an access system user associated with this user identity.',
|
|
60725
|
+
properties: {
|
|
60726
|
+
acs_system_id: {
|
|
60727
|
+
description:
|
|
60728
|
+
'ID of the access system that the user identity is associated with.',
|
|
60729
|
+
format: 'uuid',
|
|
60730
|
+
type: 'string',
|
|
60731
|
+
},
|
|
60732
|
+
acs_user_id: {
|
|
60733
|
+
description:
|
|
60734
|
+
'ID of the access system user that has an issue.',
|
|
60735
|
+
format: 'uuid',
|
|
60736
|
+
type: 'string',
|
|
60737
|
+
},
|
|
60738
|
+
created_at: {
|
|
60739
|
+
description:
|
|
60740
|
+
'Date and time at which Seam created the error.',
|
|
60741
|
+
format: 'date-time',
|
|
60742
|
+
type: 'string',
|
|
60743
|
+
},
|
|
60744
|
+
error_code: {
|
|
60745
|
+
description:
|
|
60746
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
60747
|
+
enum: ['issue_with_acs_user'],
|
|
60748
|
+
type: 'string',
|
|
60749
|
+
},
|
|
60750
|
+
message: {
|
|
60751
|
+
description:
|
|
60752
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
60753
|
+
type: 'string',
|
|
60754
|
+
},
|
|
60755
|
+
},
|
|
60756
|
+
required: [
|
|
60757
|
+
'created_at',
|
|
60758
|
+
'message',
|
|
60759
|
+
'error_code',
|
|
60760
|
+
'acs_user_id',
|
|
60761
|
+
'acs_system_id',
|
|
60762
|
+
],
|
|
60763
|
+
type: 'object',
|
|
60764
|
+
},
|
|
60765
|
+
],
|
|
60766
|
+
},
|
|
60767
|
+
type: 'array',
|
|
60768
|
+
},
|
|
60769
|
+
full_name: {
|
|
60770
|
+
minLength: 1,
|
|
60771
|
+
nullable: true,
|
|
60772
|
+
type: 'string',
|
|
60773
|
+
},
|
|
60774
|
+
phone_number: {
|
|
60775
|
+
description:
|
|
60776
|
+
'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
|
|
60777
|
+
nullable: true,
|
|
60778
|
+
type: 'string',
|
|
60779
|
+
},
|
|
60780
|
+
user_identity_id: {
|
|
60781
|
+
description: 'ID of the user identity.',
|
|
60782
|
+
format: 'uuid',
|
|
60783
|
+
type: 'string',
|
|
60784
|
+
},
|
|
60785
|
+
warnings: {
|
|
60786
|
+
description:
|
|
60787
|
+
'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.',
|
|
60788
|
+
items: {
|
|
60789
|
+
description:
|
|
60790
|
+
'Warnings associated with the user identity.',
|
|
60791
|
+
discriminator: { propertyName: 'warning_code' },
|
|
60792
|
+
oneOf: [
|
|
60793
|
+
{
|
|
60794
|
+
description:
|
|
60795
|
+
'Indicates that the user identity is currently being deleted.',
|
|
60796
|
+
properties: {
|
|
60797
|
+
created_at: {
|
|
60798
|
+
description:
|
|
60799
|
+
'Date and time at which Seam created the warning.',
|
|
60800
|
+
format: 'date-time',
|
|
60801
|
+
type: 'string',
|
|
60802
|
+
},
|
|
60803
|
+
message: {
|
|
60804
|
+
description:
|
|
60805
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60806
|
+
type: 'string',
|
|
60807
|
+
},
|
|
60808
|
+
warning_code: {
|
|
60809
|
+
description:
|
|
60810
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60811
|
+
enum: ['being_deleted'],
|
|
60812
|
+
type: 'string',
|
|
60813
|
+
},
|
|
60814
|
+
},
|
|
60815
|
+
required: [
|
|
60816
|
+
'created_at',
|
|
60817
|
+
'message',
|
|
60818
|
+
'warning_code',
|
|
60819
|
+
],
|
|
60820
|
+
type: 'object',
|
|
60821
|
+
},
|
|
60822
|
+
{
|
|
60823
|
+
description:
|
|
60824
|
+
"Indicates that the ACS user's profile does not match the user identity's profile",
|
|
60825
|
+
properties: {
|
|
60826
|
+
created_at: {
|
|
60827
|
+
description:
|
|
60828
|
+
'Date and time at which Seam created the warning.',
|
|
60829
|
+
format: 'date-time',
|
|
60830
|
+
type: 'string',
|
|
60831
|
+
},
|
|
60832
|
+
message: {
|
|
60833
|
+
description:
|
|
60834
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
60835
|
+
type: 'string',
|
|
60836
|
+
},
|
|
60837
|
+
warning_code: {
|
|
60838
|
+
description:
|
|
60839
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
60840
|
+
enum: [
|
|
60841
|
+
'acs_user_profile_does_not_match_user_identity',
|
|
60842
|
+
],
|
|
60843
|
+
type: 'string',
|
|
60844
|
+
},
|
|
60845
|
+
},
|
|
60846
|
+
required: [
|
|
60847
|
+
'created_at',
|
|
60848
|
+
'message',
|
|
60849
|
+
'warning_code',
|
|
60850
|
+
],
|
|
60851
|
+
type: 'object',
|
|
60852
|
+
},
|
|
60853
|
+
],
|
|
60854
|
+
},
|
|
60855
|
+
type: 'array',
|
|
60856
|
+
},
|
|
60857
|
+
workspace_id: {
|
|
60858
|
+
description:
|
|
60859
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
|
|
60860
|
+
format: 'uuid',
|
|
60861
|
+
type: 'string',
|
|
60862
|
+
},
|
|
60863
|
+
},
|
|
60864
|
+
required: [
|
|
60865
|
+
'user_identity_id',
|
|
60866
|
+
'email_address',
|
|
60867
|
+
'phone_number',
|
|
60868
|
+
'display_name',
|
|
60869
|
+
'full_name',
|
|
60870
|
+
'created_at',
|
|
60871
|
+
'workspace_id',
|
|
60872
|
+
'errors',
|
|
60873
|
+
'warnings',
|
|
60874
|
+
'acs_user_ids',
|
|
60875
|
+
],
|
|
60876
|
+
type: 'object',
|
|
60877
|
+
'x-draft': 'Early access.',
|
|
60878
|
+
'x-route-path': '/user_identities/unmanaged',
|
|
60879
|
+
},
|
|
60880
|
+
type: 'array',
|
|
60881
|
+
},
|
|
60882
|
+
},
|
|
60883
|
+
required: ['user_identities', 'ok'],
|
|
58261
60884
|
type: 'object',
|
|
58262
60885
|
},
|
|
58263
60886
|
},
|
|
@@ -58269,15 +60892,17 @@ export default {
|
|
|
58269
60892
|
},
|
|
58270
60893
|
security: [
|
|
58271
60894
|
{ api_key: [] },
|
|
60895
|
+
{ client_session: [] },
|
|
58272
60896
|
{ pat_with_workspace: [] },
|
|
58273
60897
|
{ console_session_with_workspace: [] },
|
|
58274
60898
|
],
|
|
58275
|
-
summary: '/user_identities/
|
|
60899
|
+
summary: '/user_identities/unmanaged/list',
|
|
58276
60900
|
tags: ['/user_identities'],
|
|
58277
|
-
'x-fern-sdk-group-name': ['user_identities'],
|
|
58278
|
-
'x-fern-sdk-method-name': '
|
|
58279
|
-
'x-
|
|
58280
|
-
'x-
|
|
60901
|
+
'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
|
|
60902
|
+
'x-fern-sdk-method-name': 'list',
|
|
60903
|
+
'x-fern-sdk-return-value': 'user_identities',
|
|
60904
|
+
'x-response-key': 'user_identities',
|
|
60905
|
+
'x-title': 'List Unmanaged User Identities',
|
|
58281
60906
|
},
|
|
58282
60907
|
},
|
|
58283
60908
|
'/user_identities/update': {
|