diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 7f4a73f0d..752edd55c 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -55,8 +55,45 @@ Set of IDs of the [entrances](../../../capability-guides/access-systems/retrievi Vostio-specific metadata for the new credential. +
+ +auto_join Boolean + +
+ +--- + + + +
+ +join_all_guest_acs_entrances Boolean + +
+ +--- + + + +
+ +override_all_guest_acs_entrances Boolean + +
+ +--- + + + +
+ +override_guest_acs_entrance_ids List + +
+ --- + **`code`** *String* Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). @@ -85,8 +122,29 @@ Indicates whether the new credential is a [multi-phone sync credential](https:// Salto Space-specific metadata for the new credential. +
+ +assign_new_key Boolean + +Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](../../../device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md). + +
+ --- + + +
+ +update_current_key Boolean + +Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](../../../device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md). + +
+ +--- + + **`starts_at`** *String* Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. @@ -103,9 +161,94 @@ ID of the user identity to whom the new credential belongs. You must provide eit Visionline-specific metadata for the new credential. +
+ +assa_abloy_credential_service_mobile_endpoint_id UUID + +{% hint style="warning" %} +**Deprecated**. Read-only endpoint references moved to `endpoint`. +{% endhint %} + +
+ +--- + + + +
+ +auto_join Boolean + +
+ +--- + + + +
+ +card_format Enum + +Enum values: + +- TLCode +- rfid48 + +
+ +--- + + + +
+ +card_function_type Enum + +Enum values: + +- guest +- staff + +
+ --- + +
+ +is_override_key Boolean + +{% hint style="warning" %} +**Deprecated**. Use `override` instead. +{% endhint %} + +
+ +--- + + + +
+ +joiner_acs_credential_ids List + +
+ +--- + + + +
+ +override Boolean + +
+ +--- + + + ## Response [acs\_credential](./) diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index e01970d7d..ab46bf132 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -43,8 +43,29 @@ Full name of the new access system user. `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. +
+ +ends_at Datetime + +Ending timestamp for the new access system user's access. + +
+ --- + + +
+ +starts_at Datetime + +Starting timestamp for the new access system user's access. + +
+ +--- + + **`acs_access_group_ids`** *Array* *of UUIDs* Array of access group IDs to indicate the access groups to which you want to add the new access system user. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 52a1924b7..ee21567b9 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -31,8 +31,29 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. +
+ +ends_at Datetime + +Ending timestamp for the access system user's access. + +
+ --- + + +
+ +starts_at Datetime + +Starting timestamp for the access system user's access. + +
+ +--- + + **`acs_system_id`** *String* ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index ff865551f..93ba0b635 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -37,8 +37,77 @@ ID of the user identity to associate with the simulated phone. ASSA ABLOY metadata to associate with the simulated phone. +
+ +application_version String + +Application version that you want to use for the simulated phone. + +
+ +--- + + + +
+ +ble_capability Boolean + +Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability. + +
+ +--- + + + +
+ +hce_capability Boolean + +Indicates whether the simulated phone should have host card emulation (HCE) capability. + +
+ +--- + + + +
+ +nfc_capability Boolean + +Indicates whether the simulated phone should have near-field communication (NFC) capability. + +
+ +--- + + + +
+ +seos_applet_version String + +SEOS applet version that you want to use for the simulated phone. + +
+ +--- + + + +
+ +seos_tsm_endpoint_id Number + +ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone. + +
+ --- + **`custom_sdk_installation_id`** *String* ID of the custom SDK installation to use for the simulated phone. @@ -49,9 +118,59 @@ ID of the custom SDK installation to use for the simulated phone. Metadata to associate with the simulated phone. +
+ +device_manufacturer String + +Manufacturer that you want to use for the simulated phone. + +
+ +--- + + + +
+ +device_model String + +Device model that you want to use for the simulated phone. + +
+ +--- + + + +
+ +operating_system Enum + +Mobile operating system that you want to use for the simulated phone. + +Enum values: + +- android +- ios + +
+ +--- + + + +
+ +os_version String + +Mobile operating system version that you want to use for the simulated phone. + +
+ --- + ## Response [phone](./) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 54fd56bff..7747919fb 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -47,9 +47,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati {{> enum-values enumValues=this.itemEnumValues}} {{/if}} +{{#if this.objectParameters}} +{{#each this.objectParameters}} + +{{> property-collapsible this}} + +{{/each}} +{{else}} --- +{{/if}} {{/each}} {{else}} None