Update Identity

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.identities.update_identity(identity="user_123", meta={
        "email": "alice@example.com",
        "name": "Alice Smith",
        "plan": "premium",
    }, ratelimits=[
        {
            "name": "requests",
            "limit": 1000,
            "duration": 3600000,
            "auto_apply": True,
        },
    ])

    # Handle response
    print(res)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.identities.updateIdentity({
    identity: "user_123",
    meta: {
      "email": "alice@example.com",
      "name": "Alice Smith",
      "plan": "premium",
    },
  });

  console.log(result);
}

run();

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

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

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Identities.UpdateIdentity(ctx, components.V2IdentitiesUpdateIdentityRequestBody{
        Identity: "user_123",
        Meta: map[string]any{
            "email": "alice@example.com",
            "name": "Alice Smith",
            "plan": "premium",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2IdentitiesUpdateIdentityResponseBody != nil {
        // handle response
    }
}

curl --request POST \
  --url https://api.unkey.com/v2/identities.updateIdentity \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity": "user_123",
  "meta": {
    "email": "alice@example.com",
    "name": "Alice Smith",
    "plan": "premium"
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identity: 'user_123',
    meta: {email: 'alice@example.com', name: 'Alice Smith', plan: 'premium'}
  })
};

fetch('https://api.unkey.com/v2/identities.updateIdentity', 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://api.unkey.com/v2/identities.updateIdentity",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identity' => 'user_123',
    'meta' => [
        'email' => 'alice@example.com',
        'name' => 'Alice Smith',
        'plan' => 'premium'
    ]
  ]),
  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.post("https://api.unkey.com/v2/identities.updateIdentity")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identity\": \"user_123\",\n  \"meta\": {\n    \"email\": \"alice@example.com\",\n    \"name\": \"Alice Smith\",\n    \"plan\": \"premium\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/identities.updateIdentity")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identity\": \"user_123\",\n  \"meta\": {\n    \"email\": \"alice@example.com\",\n    \"name\": \"Alice Smith\",\n    \"plan\": \"premium\"\n  }\n}"

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

{
  "data": {
    "id": "<string>",
    "externalId": "<string>",
    "meta": {},
    "ratelimits": [
      {
        "id": "rl_1234567890abcdef",
        "name": "api_requests",
        "limit": 1000,
        "duration": 3600000,
        "autoApply": true
      }
    ]
  },
  "meta": {
    "requestId": "req_123"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found",
    "errors": [
      {
        "location": "body.permissions[0].name",
        "message": "Must be at least 3 characters long",
        "fix": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
      }
    ]
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'identity.*.update_identity' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_0uVwX4yZaAbCdEfGhIjKl"
  }
}

{
  "error": {
    "detail": "Identity with externalId \"user_123\" not found.",
    "status": 404,
    "title": "Not Found",
    "type": "not_found"
  },
  "meta": {
    "requestId": "req_2wXyZaAbCdEfGhIjKlMnOp"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}