Rename one current user's device.

PATCH

/api/account/devices/{id}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/account/devices/example \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "display_name": "example" }'

Renames a device installation owned by the authenticated Account Page user.

Authorizations

• accountSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

Media type application/json

object

display_name

required

string

<= 64 characters

Example ^generated

{
  "display_name": "example"
}

Responses

200

Account Page device mutation response.

Media type application/json

object

device

required

object

id

required

string

display_name

required

string

fallback_display_name

string

platform

required

string

current

required

boolean

last_seen_at

string | null

last_seen_at_unix

integer | null

client_id

string

app_display_name

string

Example ^generated

{
  "device": {
    "id": "example",
    "display_name": "example",
    "fallback_display_name": "example",
    "platform": "example",
    "current": true,
    "last_seen_at": "example",
    "last_seen_at_unix": 1,
    "client_id": "example",
    "app_display_name": "example"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}