Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions docs/api/acs/credentials/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,45 @@ Set of IDs of the [entrances](../../../capability-guides/access-systems/retrievi

Vostio-specific metadata for the new credential.

<details>

<summary><b><code>auto_join</code></b> <i>Boolean</i></summary>

</details>

---



<details>

<summary><b><code>join_all_guest_acs_entrances</code></b> <i>Boolean</i></summary>

</details>

---



<details>

<summary><b><code>override_all_guest_acs_entrances</code></b> <i>Boolean</i></summary>

</details>

---



<details>

<summary><b><code>override_guest_acs_entrance_ids</code></b> <i>List</i></summary>

</details>

---


**`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).
Expand Down Expand Up @@ -85,8 +122,29 @@ Indicates whether the new credential is a [multi-phone sync credential](https://

Salto Space-specific metadata for the new credential.

<details>

<summary><b><code>assign_new_key</code></b> <i>Boolean</i></summary>

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).

</details>

---



<details>

<summary><b><code>update_current_key</code></b> <i>Boolean</i></summary>

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).

</details>

---


**`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.
Expand All @@ -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.

<details>

<summary><b><code>assa_abloy_credential_service_mobile_endpoint_id</code></b> <i>UUID</i></summary>

{% hint style="warning" %}
**Deprecated**. Read-only endpoint references moved to `endpoint`.
{% endhint %}

</details>

---



<details>

<summary><b><code>auto_join</code></b> <i>Boolean</i></summary>

</details>

---



<details>

<summary><b><code>card_format</code></b> <i>Enum</i></summary>

Enum values:

- <code>TLCode</code>
- <code>rfid48</code>

</details>

---



<details>

<summary><b><code>card_function_type</code></b> <i>Enum</i></summary>

Enum values:

- <code>guest</code>
- <code>staff</code>

</details>

---



<details>

<summary><b><code>is_override_key</code></b> <i>Boolean</i></summary>

{% hint style="warning" %}
**Deprecated**. Use `override` instead.
{% endhint %}

</details>

---



<details>

<summary><b><code>joiner_acs_credential_ids</code></b> <i>List</i></summary>

</details>

---



<details>

<summary><b><code>override</code></b> <i>Boolean</i></summary>

</details>

---



## Response

[acs\_credential](./)
Expand Down
21 changes: 21 additions & 0 deletions docs/api/acs/users/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

<details>

<summary><b><code>ends_at</code></b> <i>Datetime</i></summary>

Ending timestamp for the new access system user's access.

</details>

---



<details>

<summary><b><code>starts_at</code></b> <i>Datetime</i></summary>

Starting timestamp for the new access system user's access.

</details>

---


**`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.
Expand Down
21 changes: 21 additions & 0 deletions docs/api/acs/users/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

<details>

<summary><b><code>ends_at</code></b> <i>Datetime</i></summary>

Ending timestamp for the access system user's access.

</details>

---



<details>

<summary><b><code>starts_at</code></b> <i>Datetime</i></summary>

Starting timestamp for the access system user's access.

</details>

---


**`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.
Expand Down
119 changes: 119 additions & 0 deletions docs/api/phones/simulate/create_sandbox_phone.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,77 @@ ID of the user identity to associate with the simulated phone.

ASSA ABLOY metadata to associate with the simulated phone.

<details>

<summary><b><code>application_version</code></b> <i>String</i></summary>

Application version that you want to use for the simulated phone.

</details>

---



<details>

<summary><b><code>ble_capability</code></b> <i>Boolean</i></summary>

Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.

</details>

---



<details>

<summary><b><code>hce_capability</code></b> <i>Boolean</i></summary>

Indicates whether the simulated phone should have host card emulation (HCE) capability.

</details>

---



<details>

<summary><b><code>nfc_capability</code></b> <i>Boolean</i></summary>

Indicates whether the simulated phone should have near-field communication (NFC) capability.

</details>

---



<details>

<summary><b><code>seos_applet_version</code></b> <i>String</i></summary>

SEOS applet version that you want to use for the simulated phone.

</details>

---



<details>

<summary><b><code>seos_tsm_endpoint_id</code></b> <i>Number</i></summary>

ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.

</details>

---


**`custom_sdk_installation_id`** *String*

ID of the custom SDK installation to use for the simulated phone.
Expand All @@ -49,9 +118,59 @@ ID of the custom SDK installation to use for the simulated phone.

Metadata to associate with the simulated phone.

<details>

<summary><b><code>device_manufacturer</code></b> <i>String</i></summary>

Manufacturer that you want to use for the simulated phone.

</details>

---



<details>

<summary><b><code>device_model</code></b> <i>String</i></summary>

Device model that you want to use for the simulated phone.

</details>

---



<details>

<summary><b><code>operating_system</code></b> <i>Enum</i></summary>

Mobile operating system that you want to use for the simulated phone.

Enum values:

- <code>android</code>
- <code>ios</code>

</details>

---



<details>

<summary><b><code>os_version</code></b> <i>String</i></summary>

Mobile operating system version that you want to use for the simulated phone.

</details>

---



## Response

[phone](./)
Expand Down
8 changes: 8 additions & 0 deletions src/layouts/api-endpoint.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
{{> enum-values enumValues=this.itemEnumValues}}
</details>
{{/if}}
{{#if this.objectParameters}}
{{#each this.objectParameters}}

{{> property-collapsible this}}

{{/each}}
{{else}}

---

{{/if}}
{{/each}}
{{else}}
None
Expand Down
Loading