Phones

The phone Object

• Properties

• Errors

• Warnings

• Events

• Endpoints

Represents an app user's mobile phone.

JSON

{
  created_at: [example value],
  custom_metadata: [example value],
  device_id: [example value],
  device_type: [example value],
  display_name: [example value],
  errors: [example value],
  nickname: [example value],
  properties: [example value],
  warnings: [example value],
  workspace_id: [example value]
}

---

Properties

created_at Datetime

Date and time at which the phone was created.

---

custom_metadata Record

Optional custom metadata for the phone.

---

device_id UUID

ID of the phone.

---

device_type Enum

Type of phone.

Enum values

• ios_phone

• android_phone

---

display_name 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 List of Objects

Errors associated with the phone.

Child Object Properties

error_code Stringmessage String

---

nickname String

Optional nickname to describe the phone, settable through Seam.

---

properties Object

Properties of the phone.

Child Properties

• assa_abloy_credential_service_metadata Object

ASSA ABLOY Credential Service metadata for the phone.

• assa_abloy_credential_service_metadata.endpoints List of Objects

Endpoints associated with the phone.

• endpoint_id String

  ID of the associated endpoint.

• is_active Boolean

  Indicated whether the endpoint is active.

  • assa_abloy_credential_service_metadata.has_active_endpoint Boolean

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

  • salto_space_credential_service_metadata Object

  Salto Space credential service metadata for the phone.

  • salto_space_credential_service_metadata.has_active_phone Boolean

  Indicates whether the credential service has an active associated phone.

---

warnings List of Objects

Warnings associated with the phone.

Child Object Properties

message Stringwarning_code String

---

workspace_id UUID

ID of the workspace that contains the phone.

---

Events

phone.deactivated

A phone device was deactivated.

Properties

created_at Datetime

Date and time at which the event was created.

device_id UUID

ID of the device.

event_id UUID

ID of the event.

event_type Enum

Value: phone.deactivated

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace.

---

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.