NOTE: Only updates devices owned by the current user.

UpdateDevice renames one of the calling user’s devices. Use the update mask to specify which fields to change; only the display name is mutable, so device identity and keys never change.

PUT /api/v1/iam/personal_devices/{device_id}

UpdateDevice

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.PersonalDevice.UpdateDevice(ctx, operations.C1APIIamV1PersonalDeviceServiceUpdateDeviceRequest{
        DeviceID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.PersonalDeviceServiceUpdateDeviceResponse != nil {
        // handle response
    }
}

curl --request PUT \
  --url https://{tenantDomain}.conductor.one/api/v1/iam/personal_devices/{device_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device": {
    "displayName": "<string>"
  },
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/iam/personal_devices/{device_id}"

payload = {
    "device": { "displayName": "<string>" },
    "updateMask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({device: {displayName: '<string>'}, updateMask: '<string>'})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/iam/personal_devices/{device_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/iam/personal_devices/{device_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'device' => [
        'displayName' => '<string>'
    ],
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.put("https://{tenantDomain}.conductor.one/api/v1/iam/personal_devices/{device_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device\": {\n    \"displayName\": \"<string>\"\n  },\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/iam/personal_devices/{device_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"device\": {\n    \"displayName\": \"<string>\"\n  },\n  \"updateMask\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "device": {
    "createdAt": "2023-11-07T05:31:56Z",
    "deviceId": "<string>",
    "deviceOs": "<string>",
    "deviceSurface": "<string>",
    "displayName": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "userId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

device_id · string · required · read-only

The stable device identity: a base64url-encoded SHA-256 thumbprint of the device's root public signing key.

Body

application/json

The PersonalDeviceServiceUpdateDeviceRequest message.

device · Personal Device · object | null

PersonalDevice is one physical device with its app clients. The device identity is a stable thumbprint of the device's root signing key; the root key never authenticates an app — each client uses its own key.

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The PersonalDeviceServiceUpdateDeviceResponse message.

device · Personal Device · object | null

PersonalDevice is one physical device with its app clients. The device identity is a stable thumbprint of the device's root signing key; the root key never authenticates an app — each client uses its own key.

Show child attributes