Skip to main content
POST
/
public
/
v1
/
query
/
get_user

Authorizations

​
X-Stamp
string
required
Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

​
organizationId
string
required
Unique identifier for a given organization.
​
userId
string
required
Unique identifier for a given user.

Response

A successful response returns the following fields:
​
user
object
required
user field
curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_user \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "userId": "<string>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getUser({
  organizationId: "<string> (Unique identifier for a given organization.)",
  userId: "<string> (Unique identifier for a given user.)"
});

{
  "user": {
    "userId": "<string>",
    "userName": "<string>",
    "userEmail": "<string>",
    "userPhoneNumber": "<string>",
    "authenticators": [
      {
        "transports": [
          "<AUTHENTICATOR_TRANSPORT_BLE>"
        ],
        "attestationType": "<string>",
        "aaguid": "<string>",
        "credentialId": "<string>",
        "model": "<string>",
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "authenticatorId": "<string>",
        "authenticatorName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        }
      }
    ],
    "apiKeys": [
      {
        "credential": {
          "publicKey": "<string>",
          "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
        },
        "apiKeyId": "<string>",
        "apiKeyName": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "expirationSeconds": "<string>"
      }
    ],
    "userTags": [
      "<string>"
    ],
    "oauthProviders": [
      {
        "providerId": "<string>",
        "providerName": "<string>",
        "issuer": "<string>",
        "audience": "<string>",
        "subject": "<string>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        }
      }
    ],
    "createdAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "updatedAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    }
  }
}