diff --git a/docs/api-reference/_blueprint.json b/docs/api-reference/_blueprint.json index 10dde0de2..120056ff5 100644 --- a/docs/api-reference/_blueprint.json +++ b/docs/api-reference/_blueprint.json @@ -161255,6 +161255,110 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "reason", + "description": "Why access was denied, when the provider reports a determinable cause. Omitted when unknown.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "object", + "jsonType": "object", + "propertyGroups": [], + "properties": [ + { + "name": "message", + "description": "Human-readable explanation of why access was denied.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "string", + "jsonType": "string" + }, + { + "name": "reason_code", + "description": "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "enum", + "jsonType": "string", + "values": [ + { + "name": "unknown_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "expired_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "blocklisted_code", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "too_many_attempts", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "blocked_by_privacy_mode", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + }, + { + "name": "credential_error", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "" + } + ] + } + ] + }, { "name": "user_identity_id", "description": "undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.", diff --git a/docs/api-reference/locks/README.md b/docs/api-reference/locks/README.md index 3f71c230a..a92605c6d 100644 --- a/docs/api-reference/locks/README.md +++ b/docs/api-reference/locks/README.md @@ -4361,6 +4361,10 @@ The [lock](https://docs.seam.co/low-level-apis/smart-locks) denied access to a u Date and time at which the event occurred. +reason Object + + Why access was denied, when the provider reports a determinable cause. Omitted when unknown. + user_identity_id UUID undocumented: Unreleased. diff --git a/mintlify-docs/api/locks/events.mdx b/mintlify-docs/api/locks/events.mdx index 11ab67b94..248c2ea64 100644 --- a/mintlify-docs/api/locks/events.mdx +++ b/mintlify-docs/api/locks/events.mdx @@ -271,6 +271,10 @@ The [lock](/low-level-apis/smart-locks) denied access to a user after one or mor "event_id": "00000000-0000-0000-0000-000000000000", "event_type": "lock.access_denied", "occurred_at": "2025-01-01T00:00:00.000Z", + "reason": { + "message": "", + "reason_code": "unknown_code" + }, "user_identity_id": "00000000-0000-0000-0000-000000000000", "workspace_id": "00000000-0000-0000-0000-000000000000" } @@ -342,6 +346,21 @@ The [lock](/low-level-apis/smart-locks) denied access to a user after one or mor Date and time at which the event occurred. + + Why access was denied, when the provider reports a determinable cause. Omitted when unknown. + + + + Human-readable explanation of why access was denied. + + + Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. + + Possible values: `unknown_code`, `expired_code`, `blocklisted_code`, `too_many_attempts`, `blocked_by_privacy_mode`, `credential_error` + + + + undocumented: Unreleased. --- diff --git a/mintlify-docs/openapi.json b/mintlify-docs/openapi.json index 98221797c..f25df5759 100644 --- a/mintlify-docs/openapi.json +++ b/mintlify-docs/openapi.json @@ -17586,6 +17586,32 @@ "format": "date-time", "type": "string" }, + "reason": { + "description": "Why access was denied, when the provider reports a determinable cause. Omitted when unknown.", + "properties": { + "message": { + "description": "Human-readable explanation of why access was denied.", + "type": "string" + }, + "reason_code": { + "description": "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.", + "enum": [ + "unknown_code", + "expired_code", + "blocklisted_code", + "too_many_attempts", + "blocked_by_privacy_mode", + "credential_error" + ], + "type": "string" + } + }, + "required": [ + "reason_code", + "message" + ], + "type": "object" + }, "user_identity_id": { "description": "\n undocumented: Unreleased.\n ---\n ID of the user identity associated with the access-denied event.\n ", "format": "uuid", diff --git a/package-lock.json b/package-lock.json index 237b8edd2..7cfdb934b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.56.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.952.0", + "@seamapi/types": "1.953.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -4094,9 +4094,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.952.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.952.0.tgz", - "integrity": "sha512-PFeT7KF9f1cpy8GTOaBpVmqzwlnqfV8GBuHJ4Yr4uuMaP+Fq1nV5GTcJRQW5GBq1ztCk7WHswH+HFInjyMIK/A==", + "version": "1.953.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.953.0.tgz", + "integrity": "sha512-mnmPFNJSB3gQZrRkuBvYlNgXjNdfCQnrHZ4vieyVCx5viEcnXeSDKqNl9nPCFzjw2l4p8TQt3YHl76nDuPcZBg==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index 411b049d9..6e28c4558 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.56.0", "@seamapi/smith": "^0.5.2", - "@seamapi/types": "1.952.0", + "@seamapi/types": "1.953.0", "@types/command-exists": "^1.2.3", "change-case": "^5.4.4", "command-exists": "^1.2.9",