README.md

Identities

(identities)

Overview

Available Operations

• createIdentity

createIdentity

Example Usage

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

const unkey = new Unkey({
  rootKey: "UNKEY_ROOT_KEY",
});

async function run() {
  const result = await unkey.identities.createIdentity({
    externalId: "user_123",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { UnkeyCore } from "@unkey/api/core.js";
import { identitiesCreateIdentity } from "@unkey/api/funcs/identitiesCreateIdentity.js";

// Use `UnkeyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const unkey = new UnkeyCore({
  rootKey: "UNKEY_ROOT_KEY",
});

async function run() {
  const res = await identitiesCreateIdentity(unkey, {
    externalId: "user_123",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
request	components.V2IdentitiesCreateIdentityRequestBody	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.V2IdentitiesCreateIdentityResponseBody>

Errors

Error Type	Status Code	Content Type
errors.BadRequestErrorResponse	400	application/problem+json
errors.UnauthorizedErrorResponse	401	application/problem+json
errors.ForbiddenErrorResponse	403	application/problem+json
errors.ConflictErrorResponse	409	application/problem+json
errors.InternalServerErrorResponse	500	application/problem+json
errors.APIError	4XX, 5XX	*/*