List Users

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>"
}'

{
  "users": [
    {
      "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>"
      }
    }
  ]
}

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>"
}'

{
  "users": [
    {
      "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>"
      }
    }
  ]
}

POST

public

query

list_users

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.

Response

A successful response returns the following fields:

users

array

required

A list of Users.

Show users details

users.userId

string

required

Unique identifier for a given User.

users.userName

string

required

Human-readable name for a User.

users.userEmail

string

The user’s email address.

users.userPhoneNumber

string

The user’s phone number in E.164 format e.g. +13214567890

users.authenticators

array

required

A list of Authenticator parameters.

Show authenticators details

users.authenticators.transports

array

required

Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).

Show transports details

users.authenticators.transports.item

enum

required

item fieldEnum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

users.authenticators.attestationType

string

required

attestationType field

users.authenticators.aaguid

string

required

Identifier indicating the type of the Security Key.

users.authenticators.credentialId

string

required

Unique identifier for a WebAuthn credential.

users.authenticators.model

string

required

The type of Authenticator device.

users.authenticators.credential

object

required

credential field

Show credential details

users.authenticators.credential.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

users.authenticators.credential.type

enum

required

type fieldEnum options: CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR, CREDENTIAL_TYPE_API_KEY_P256, CREDENTIAL_TYPE_RECOVER_USER_KEY_P256, CREDENTIAL_TYPE_API_KEY_SECP256K1, CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256, CREDENTIAL_TYPE_API_KEY_ED25519, CREDENTIAL_TYPE_OTP_AUTH_KEY_P256, CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256, CREDENTIAL_TYPE_OAUTH_KEY_P256, CREDENTIAL_TYPE_LOGIN

users.authenticators.authenticatorId

string

required

Unique identifier for a given Authenticator.

users.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

users.authenticators.createdAt

object

required

createdAt field

Show createdAt details

users.authenticators.createdAt.seconds

string

required

seconds field

users.authenticators.createdAt.nanos

string

required

nanos field

users.authenticators.updatedAt

object

required

updatedAt field

Show updatedAt details

users.authenticators.updatedAt.seconds

string

required

seconds field

users.authenticators.updatedAt.nanos

string

required

nanos field

users.apiKeys

array

required

A list of API Key parameters. This field, if not needed, should be an empty array in your request body.

Show apiKeys details

users.apiKeys.credential

object

required

credential field

Show credential details

users.apiKeys.credential.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

users.apiKeys.credential.type

enum

required

users.apiKeys.apiKeyId

string

required

Unique identifier for a given API Key.

users.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

users.apiKeys.createdAt

object

required

createdAt field

Show createdAt details

users.apiKeys.createdAt.seconds

string

required

seconds field

users.apiKeys.createdAt.nanos

string

required

nanos field

users.apiKeys.updatedAt

object

required

updatedAt field

Show updatedAt details

users.apiKeys.updatedAt.seconds

string

required

seconds field

users.apiKeys.updatedAt.nanos

string

required

nanos field

users.apiKeys.expirationSeconds

string

Optional window (in seconds) indicating how long the API Key should last.

users.userTags

array

required

A list of User Tag IDs.

Show userTags details

users.userTags.item

string

required

item field

users.oauthProviders

array

required

A list of Oauth Providers.

Show oauthProviders details

users.oauthProviders.providerId

string

required

Unique identifier for an OAuth Provider

users.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

users.oauthProviders.issuer

string

required

The issuer of the token, typically a URL indicating the authentication server, e.g https://accounts.google.com

users.oauthProviders.audience

string

required

Expected audience (‘aud’ attribute of the signed token) which represents the app ID

users.oauthProviders.subject

string

required

Expected subject (‘sub’ attribute of the signed token) which represents the user ID

users.oauthProviders.createdAt

object

required

createdAt field

Show createdAt details

users.oauthProviders.createdAt.seconds

string

required

seconds field

users.oauthProviders.createdAt.nanos

string

required

nanos field

users.oauthProviders.updatedAt

object

required

updatedAt field

Show updatedAt details

users.oauthProviders.updatedAt.seconds

string

required

seconds field

users.oauthProviders.updatedAt.nanos

string

required

nanos field

users.createdAt

object

required

createdAt field

Show createdAt details

users.createdAt.seconds

string

required

seconds field

users.createdAt.nanos

string

required

nanos field

users.updatedAt

object

required

updatedAt field

Show updatedAt details

users.updatedAt.seconds

string

required

seconds field

users.updatedAt.nanos

string

required

nanos field

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/list_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>"
}'

{
  "users": [
    {
      "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>"
      }
    }
  ]
}

List User Tags List Wallets

Activities

Queries

Authorizations

Body

Response