string
required
Unique identifier for a given organization.
string
required
Unique identifier for a given user.
string
required
Unique identifier for a given MFA policy.
object
required
mfaPolicy field
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_mfa_policy \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"userId": "<string>",
"mfaPolicyId": "<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().getMfaPolicy({
organizationId: "<string> (Unique identifier for a given organization.)",
userId: "<string> (Unique identifier for a given user.)",
mfaPolicyId: "<string> (Unique identifier for a given MFA policy.)"
});
{
"mfaPolicy": {
"mfaPolicyId": "<string>",
"mfaPolicyName": "<string>",
"condition": "<string>",
"requiredAuthenticationMethods": [
{
"any": [
{
"type": "<AUTHENTICATION_TYPE_EMAIL_OTP>",
"id": "<string>"
}
]
}
],
"order": "<number>",
"notes": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
}
Get a single MFA policy for a user.
Show mfaPolicy details
curl --request POST \
--url https://api.turnkey.com/public/v1/query/get_mfa_policy \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"organizationId": "<string>",
"userId": "<string>",
"mfaPolicyId": "<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().getMfaPolicy({
organizationId: "<string> (Unique identifier for a given organization.)",
userId: "<string> (Unique identifier for a given user.)",
mfaPolicyId: "<string> (Unique identifier for a given MFA policy.)"
});
{
"mfaPolicy": {
"mfaPolicyId": "<string>",
"mfaPolicyName": "<string>",
"condition": "<string>",
"requiredAuthenticationMethods": [
{
"any": [
{
"type": "<AUTHENTICATION_TYPE_EMAIL_OTP>",
"id": "<string>"
}
]
}
],
"order": "<number>",
"notes": "<string>",
"createdAt": {
"seconds": "<string>",
"nanos": "<string>"
},
"updatedAt": {
"seconds": "<string>",
"nanos": "<string>"
}
}
}
Was this page helpful?