Get details about a User
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"userId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677461)",
"result": {
"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_element>"
],
"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>"
}
}
}
}
}
Unique identifier for a given Organization.
Unique identifier for a given User.
A successful response returns the following fields:
user field
Show user details
A list of Authenticator parameters.
Show authenticators details
Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).
credential field
Show credential details
The public component of a cryptographic key pair used to sign messages and transactions.
type field
Enum 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
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
credential field
Show credential details
The public component of a cryptographic key pair used to sign messages and transactions.
type field
Enum 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
A list of Oauth Providers.
Show oauthProviders details
The issuer of the token, typically a URL indicating the authentication server, e.g https://accounts.google.com
Expected audience (‘aud’ attribute of the signed token) which represents the app ID
Expected subject (‘sub’ attribute of the signed token) which represents the user ID
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"userId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677461)",
"result": {
"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_element>"
],
"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>"
}
}
}
}
}
Was this page helpful?
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"userId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677461)",
"result": {
"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_element>"
],
"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>"
}
}
}
}
}
Get details about a User
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"userId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677461)",
"result": {
"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_element>"
],
"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>"
}
}
}
}
}
Unique identifier for a given Organization.
Unique identifier for a given User.
A successful response returns the following fields:
user field
Show user details
A list of Authenticator parameters.
Show authenticators details
Types of transports that may be used by an Authenticator (e.g., USB, NFC, BLE).
credential field
Show credential details
The public component of a cryptographic key pair used to sign messages and transactions.
type field
Enum 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
A list of API Key parameters. This field, if not needed, should be an empty array in your request body.
Show apiKeys details
credential field
Show credential details
The public component of a cryptographic key pair used to sign messages and transactions.
type field
Enum 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
A list of Oauth Providers.
Show oauthProviders details
The issuer of the token, typically a URL indicating the authentication server, e.g https://accounts.google.com
Expected audience (‘aud’ attribute of the signed token) which represents the app ID
Expected subject (‘sub’ attribute of the signed token) which represents the user ID
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"userId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677461)",
"result": {
"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_element>"
],
"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>"
}
}
}
}
}
Was this page helpful?
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: <YOUR_API_KEY.YOUR_API_SECRET>" \
--data '{
"organizationId": "<string>",
"userId": "<string>"
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_UNKNOWN_V1",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g., 1745474677461)",
"result": {
"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_element>"
],
"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>"
}
}
}
}
}