Create Users

Create Users in an existing Organization

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_USERS_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.users · array · required

A list of Users.

Show item details

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.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.attestation · object · required

attestation field

Show details

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

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

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_V2",
    "timestampMs": "<string> (e.g., 1745474677468)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "users": [
            {
                "userName": "<string>",
                "userEmail": "<string>",
                "apiKeys": [
                    {
                        "apiKeyName": "<string>",
                        "publicKey": "<string>",
                        "expirationSeconds": "<string>"
                    }
                ],
                "authenticators": [
                    {
                        "authenticatorName": "<string>",
                        "challenge": "<string>",
                        "attestation": {
                            "credentialId": "<string>",
                            "clientDataJson": "<string>",
                            "attestationObject": "<string>",
                            "transports": [
                                "<AUTHENTICATOR_TRANSPORT_BLE>"
                            ]
                        }
                    }
                ],
                "userTags": [
                    "<string_element>"
                ]
            }
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_USERS_V2",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g., 1745474677468)",
    "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>"
            ]
          }
        }
      }
    }
  }
}