Create Authenticators

Create Authenticators to authenticate requests to Turnkey

POST

/

public

/

v1

/

submit

/

create_authenticators

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.authenticators · array · required

A list of Authenticators.

Show item details

parameters.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

parameters.authenticators.challenge

string

required

Challenge presented for authentication purposes.

parameters.authenticators.attestation · object · required

attestation field

Show details

parameters.authenticators.attestation.credentialId

string

required

The cbor encoded then base64 url encoded id of the credential.

parameters.authenticators.attestation.clientDataJson

string

required

A base64 url encoded payload containing metadata about the signing context and the challenge.

parameters.authenticators.attestation.attestationObject

string

required

A base64 url encoded payload containing authenticator data and any attestation the webauthn provider chooses.

parameters.authenticators.attestation.transports

enum<string[]>

required

Enum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

parameters.userId

string

required

Unique identifier for a given User.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createAuthenticatorsIntent

object

required

The createAuthenticatorsIntent object

Show createAuthenticatorsIntent details

activity.intent.createAuthenticatorsIntent.authenticators

array

required

A list of Authenticators.

Show authenticators details

activity.intent.createAuthenticatorsIntent.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

activity.intent.createAuthenticatorsIntent.authenticators.userId

string

required

Unique identifier for a given User.

activity.intent.createAuthenticatorsIntent.authenticators.attestation

object

required

attestation field

Show attestation details

activity.intent.createAuthenticatorsIntent.authenticators.attestation.id

string

required

id field

activity.intent.createAuthenticatorsIntent.authenticators.attestation.type

enum

required

type field

Enum options: public-key

activity.intent.createAuthenticatorsIntent.authenticators.attestation.rawId

string

required

rawId field

activity.intent.createAuthenticatorsIntent.authenticators.attestation.authenticatorAttachment

enum

authenticatorAttachment field

Enum options: cross-platform, platform

activity.intent.createAuthenticatorsIntent.authenticators.attestation.response

object

required

response field

Show response details

activity.intent.createAuthenticatorsIntent.authenticators.attestation.response.clientDataJson

string

required

clientDataJson field

activity.intent.createAuthenticatorsIntent.authenticators.attestation.response.attestationObject

string

required

attestationObject field

activity.intent.createAuthenticatorsIntent.authenticators.attestation.response.transports

array

transports field

Show transports details

activity.intent.createAuthenticatorsIntent.authenticators.attestation.response.transports.item

enum

required

item field

Enum options: AUTHENTICATOR_TRANSPORT_BLE, AUTHENTICATOR_TRANSPORT_INTERNAL, AUTHENTICATOR_TRANSPORT_NFC, AUTHENTICATOR_TRANSPORT_USB, AUTHENTICATOR_TRANSPORT_HYBRID

activity.intent.createAuthenticatorsIntent.authenticators.attestation.response.authenticatorAttachment

enum

authenticatorAttachment field

Enum options: cross-platform, platform

activity.intent.createAuthenticatorsIntent.authenticators.attestation.clientExtensionResults

object

required

clientExtensionResults field

Show clientExtensionResults details

activity.intent.createAuthenticatorsIntent.authenticators.attestation.clientExtensionResults.appid

boolean

appid field

activity.intent.createAuthenticatorsIntent.authenticators.attestation.clientExtensionResults.appidExclude

boolean

appidExclude field

activity.intent.createAuthenticatorsIntent.authenticators.attestation.clientExtensionResults.credProps

object

credProps field

Show credProps details

activity.intent.createAuthenticatorsIntent.authenticators.attestation.clientExtensionResults.credProps.rk

boolean

required

rk field

activity.intent.createAuthenticatorsIntent.authenticators.challenge

string

required

Challenge presented for authentication purposes.

activity.intent.createAuthenticatorsIntent.userId

string

required

Unique identifier for a given User.

activity.result

object

required

The result of the activity

Show result details

activity.result.createAuthenticatorsResult

object

required

The createAuthenticatorsResult object

Show createAuthenticatorsResult details

activity.result.createAuthenticatorsResult.authenticatorIds

array

required

A list of Authenticator IDs.

Show authenticatorIds details

activity.result.createAuthenticatorsResult.authenticatorIds.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_authenticators \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "authenticators": [
            {
                "authenticatorName": "<string>",
                "challenge": "<string>",
                "attestation": {
                    "credentialId": "<string>",
                    "clientDataJson": "<string>",
                    "attestationObject": "<string>",
                    "transports": [
                        "<AUTHENTICATOR_TRANSPORT_BLE>"
                    ]
                }
            }
        ],
        "userId": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createAuthenticatorsIntent": {
            "authenticators": [
              {
                "authenticatorName": "<string>",
                "userId": "<string>",
                "attestation": {
                  "id": "<string>",
                  "type": "<public-key>",
                  "rawId": "<string>",
                  "authenticatorAttachment": "<cross-platform>",
                  "response": {
                    "clientDataJson": "<string>",
                    "attestationObject": "<string>",
                    "transports": [
                      "<AUTHENTICATOR_TRANSPORT_BLE>"
                    ],
                    "authenticatorAttachment": "<cross-platform>"
                  },
                  "clientExtensionResults": {
                    "appid": true,
                    "appidExclude": true,
                    "credProps": {
                      "rk": true
                    }
                  }
                },
                "challenge": "<string>"
              }
            ],
            "userId": "<string>"
          }
        },
        "result": {
          "createAuthenticatorsResult": {
            "authenticatorIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}