Phones

phone

Represents an app user's mobile phone.

created_at

Format: Datetime

Date and time at which the phone was created.

---

custom_metadata

Format: Record

Optional custom metadata for the phone.

---

device_id

Format: UUID

ID of the phone.

---

device_type

Format: Enum

Type of phone.

Possible enum values:

• ios_phone

• android_phone

---

display_name

Format: String

Display name of the phone. Defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.

---

errors

Format: List

Item format: Object

Errors associated with the phone.

error_code Format: String

message Format: String

---

nickname

Format: String

Optional nickname to describe the phone, settable through Seam.

---

properties

Format: Object

Properties of the phone.

assa_abloy_credential_service_metadata Format: Object

ASSA ABLOY Credential Service metadata for the phone.

assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object

Endpoints associated with the phone.

• endpoint_id Format: String

  ID of the associated endpoint.

• is_active Format: Boolean

  Indicated whether the endpoint is active.

assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean

Indicates whether the credential service has active endpoints associated with the phone.

salto_space_credential_service_metadata Format: Object

Salto Space credential service metadata for the phone.

salto_space_credential_service_metadata.has_active_phone Format: Boolean

Indicates whether the credential service has an active associated phone.

---

warnings

Format: List

Item format: Object

Warnings associated with the phone.

message Format: String

warning_code Format: String

---

workspace_id

Format: UUID

ID of the workspace that contains the phone.

---

Endpoints

/phones/deactivate

Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see App User Lost Phone Process.

/phones/get

Returns a single phone entry matching the provided device_id.

/phones/list

Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the owner_user_identity_id or acs_credential_id, respectively, in the request body.

---

Events

phone.deactivated

A phone device was deactivated.

created_at Format: Datetime

Date and time at which the event was created.

device_id Format: UUID

ID of the device.

event_id Format: UUID

ID of the event.

event_type Format: String

occurred_at Format: Datetime

Date and time at which the event occurred.

workspace_id Format: UUID

ID of the workspace.

---