Create Users

Create Users in an existing Organization

POST

/

public

/

v1

/

submit

/

create_users

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_USERS_V3

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.users · array · required

A list of Users.

Show item details

parameters.users.userName

string

required

Human-readable name for a User.

parameters.users.userEmail

string

The user’s email address.

parameters.users.userPhoneNumber

string

The user’s phone number in E.164 format e.g. [phone]

parameters.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 item details

parameters.users.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

parameters.users.apiKeys.publicKey

string

required

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

parameters.users.apiKeys.curveType

enum<string>

required

Enum options: API_KEY_CURVE_P256, API_KEY_CURVE_SECP256K1, API_KEY_CURVE_ED25519

parameters.users.apiKeys.expirationSeconds

string

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

parameters.users.authenticators · array · required

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

Show item details

parameters.users.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

parameters.users.authenticators.challenge

string

required

Challenge presented for authentication purposes.

parameters.users.authenticators.attestation · object · required

attestation field

Show details

parameters.users.authenticators.attestation.credentialId

string

required

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

parameters.users.authenticators.attestation.clientDataJson

string

required

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

parameters.users.authenticators.attestation.attestationObject

string

required

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

parameters.users.authenticators.attestation.transports

enum<string[]>

required

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

parameters.users.oauthProviders · array · required

A list of Oauth providers. This field, if not needed, should be an empty array in your request body.

Show item details

parameters.users.oauthProviders.providerName

string

required

Human-readable name to identify a Provider.

parameters.users.oauthProviders.oidcToken

string

required

Base64 encoded OIDC token

parameters.users.userTags · array · required

A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.

Show item details

Array item type: string

item field

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.createUsersIntent

object

required

The createUsersIntent object

Show createUsersIntent details

activity.intent.createUsersIntent.users

array

required

A list of Users.

Show users details

activity.intent.createUsersIntent.users.userName

string

required

Human-readable name for a User.

activity.intent.createUsersIntent.users.userEmail

string

The user’s email address.

activity.intent.createUsersIntent.users.accessType

enum

required

accessType field

Enum options: ACCESS_TYPE_WEB, ACCESS_TYPE_API, ACCESS_TYPE_ALL

activity.intent.createUsersIntent.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

activity.intent.createUsersIntent.users.apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

activity.intent.createUsersIntent.users.apiKeys.publicKey

string

required

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

activity.intent.createUsersIntent.users.apiKeys.expirationSeconds

string

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

activity.intent.createUsersIntent.users.authenticators

array

required

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

Show authenticators details

activity.intent.createUsersIntent.users.authenticators.authenticatorName

string

required

Human-readable name for an Authenticator.

activity.intent.createUsersIntent.users.authenticators.userId

string

required

Unique identifier for a given User.

activity.intent.createUsersIntent.users.authenticators.attestation

object

required

attestation field

Show attestation details

activity.intent.createUsersIntent.users.authenticators.attestation.id

string

required

id field

activity.intent.createUsersIntent.users.authenticators.attestation.type

enum

required

type field

Enum options: public-key

activity.intent.createUsersIntent.users.authenticators.attestation.rawId

string

required

rawId field

activity.intent.createUsersIntent.users.authenticators.attestation.authenticatorAttachment

enum

authenticatorAttachment field

Enum options: cross-platform, platform

activity.intent.createUsersIntent.users.authenticators.attestation.response

object

required

response field

Show response details

activity.intent.createUsersIntent.users.authenticators.attestation.response.clientDataJson

string

required

clientDataJson field

activity.intent.createUsersIntent.users.authenticators.attestation.response.attestationObject

string

required

attestationObject field

activity.intent.createUsersIntent.users.authenticators.attestation.response.transports

array

transports field

Show transports details

activity.intent.createUsersIntent.users.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.createUsersIntent.users.authenticators.attestation.response.authenticatorAttachment

enum

authenticatorAttachment field

Enum options: cross-platform, platform

activity.intent.createUsersIntent.users.authenticators.attestation.clientExtensionResults

object

required

clientExtensionResults field

Show clientExtensionResults details

activity.intent.createUsersIntent.users.authenticators.attestation.clientExtensionResults.appid

boolean

appid field

activity.intent.createUsersIntent.users.authenticators.attestation.clientExtensionResults.appidExclude

boolean

appidExclude field

activity.intent.createUsersIntent.users.authenticators.attestation.clientExtensionResults.credProps

object

credProps field

Show credProps details

activity.intent.createUsersIntent.users.authenticators.attestation.clientExtensionResults.credProps.rk

boolean

required

rk field

activity.intent.createUsersIntent.users.authenticators.challenge

string

required

Challenge presented for authentication purposes.

activity.intent.createUsersIntent.users.userTags

array

required

A list of User Tag IDs. This field, if not needed, should be an empty array in your request body.

Show userTags details

activity.intent.createUsersIntent.users.userTags.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.createUsersResult

object

required

The createUsersResult object

Show createUsersResult details

activity.result.createUsersResult.userIds

array

required

A list of User IDs.

Show userIds details

activity.result.createUsersResult.userIds.item

string

required

item field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_users \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "users": [
            {
                "userName": "<string>",
                "userEmail": "<string>",
                "userPhoneNumber": "<string>",
                "apiKeys": [
                    {
                        "apiKeyName": "<string>",
                        "publicKey": "<string>",
                        "curveType": "<API_KEY_CURVE_P256>",
                        "expirationSeconds": "<string>"
                    }
                ],
                "authenticators": [
                    {
                        "authenticatorName": "<string>",
                        "challenge": "<string>",
                        "attestation": {
                            "credentialId": "<string>",
                            "clientDataJson": "<string>",
                            "attestationObject": "<string>",
                            "transports": [
                                "<AUTHENTICATOR_TRANSPORT_BLE>"
                            ]
                        }
                    }
                ],
                "oauthProviders": [
                    {
                        "providerName": "<string>",
                        "oidcToken": "<string>"
                    }
                ],
                "userTags": [
                    "<string_element>"
                ]
            }
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_USERS_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createUsersIntent": {
            "users": [
              {
                "userName": "<string>",
                "userEmail": "<string>",
                "accessType": "<ACCESS_TYPE_WEB>",
                "apiKeys": [
                  {
                    "apiKeyName": "<string>",
                    "publicKey": "<string>",
                    "expirationSeconds": "<string>"
                  }
                ],
                "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>"
                  }
                ],
                "userTags": [
                  "<string_element>"
                ]
              }
            ]
          }
        },
        "result": {
          "createUsersResult": {
            "userIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}