List bulk import users

Paginated API to get bulk import users

GET/appid-{appId}/bulk-import/users

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Path parameters

appIdstringrequired

The application ID. Omit the entire `appid-{appId}` prefix to use `public`.

Query parameters

paginationTokenstring

limitnumber

statusbulkImportUserStatus

Allowed:NEWPROCESSINGFAILED

Header parameters

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Responses

200Paginated Bulk Import Users

statusstatusOK

Allowed:OK

usersbulkImportUserResponse[]

Show properties

Array of bulkImportUserResponse

idbulkImportUserId

statusbulkImportUserStatus

Allowed:NEWPROCESSINGFAILED

primaryUserIdstring

The ID of the primary user created from this staged user, when available.

errorMessagestring

The reason the staged user failed to import, when the status is FAILED.

createdAttimeJoined

updatedAttimeJoined

externalUserIduserId

userMetadatauserMetadata

should be a JSON object (not a JSON literal nor an array)

userRolesbulkImportUserRole[]

Show properties

Array of bulkImportUserRole

rolerolerequired

tenantIdstenantId[]required

totpDevicesbulkImportTotpDevice[]

Show properties

Array of bulkImportTotpDevice

secretKeystringrequired

skewnumber

periodnumber

deviceNamestring

loginMethodsbulkImportUserEmailPasswordLoginMethod | bulkImportUserThirdPartyLoginMethod | bulkImportUserPasswordlessLoginMethod[]required

min items 1

Show properties

Array of bulkImportUserEmailPasswordLoginMethod | bulkImportUserThirdPartyLoginMethod | bulkImportUserPasswordlessLoginMethod

One of:

bulkImportUserEmailPasswordLoginMethod

tenantIdstenantId[]

List of tenant IDs this login method is associated with

isVerifiedboolean

Indicates whether the email is verified

isPrimaryboolean

Indicates whether the login method is the primary login method

timeJoinedInMSSinceEpochinteger

Time joined in milliseconds since the epoch

recipeIdstringrequired

Allowed:emailpassword

emailemailrequired

passwordHashpasswordHash

plainTextPasswordstring

hashingAlgorithmhashingAlgorithm

Allowed:argon2bcryptfirebase_scrypt

bulkImportUserThirdPartyLoginMethod

tenantIdstenantId[]

List of tenant IDs this login method is associated with

isVerifiedboolean

Indicates whether the email is verified

isPrimaryboolean

Indicates whether the login method is the primary login method

timeJoinedInMSSinceEpochinteger

Time joined in milliseconds since the epoch

recipeIdstringrequired

Allowed:thirdparty

emailemailrequired

thirdPartyIdthirdPartyIdrequired

thirdPartyUserIdthirdPartyUserIdrequired

bulkImportUserPasswordlessLoginMethod

tenantIdstenantId[]

List of tenant IDs this login method is associated with

isVerifiedboolean

Indicates whether the email is verified

isPrimaryboolean

Indicates whether the login method is the primary login method

timeJoinedInMSSinceEpochinteger

Time joined in milliseconds since the epoch

recipeIdstringrequired

Allowed:passwordless

emailemail

phoneNumberphoneNumber

nextPaginationTokenpaginationToken

400error code 400

string

401error code 401

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

appIdpath*The application ID. Omit the entire `appid-{appId}` prefix to use `public`.cdi-versionheaderX.Y of the X.Y.Z CDI version.paginationTokenquerylimitquerystatusquery

Request

curl -X GET "/appid-public/bulk-import/users" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-public/bulk-import/users", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-public/bulk-import/users",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "users": [
    {
      "id": "fa7a0841-b533-4478-9253-0fde890c576",
      "status": "NEW",
      "primaryUserId": "string",
      "errorMessage": "string",
      "createdAt": 1623918032231,
      "updatedAt": 1623918032231,
      "externalUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
      "userMetadata": {
        "preferences": {
          "theme": "dark"
        },
        "notifications": {
          "email": true
        },
        "todos": [
          "example"
        ]
      },
      "userRoles": [
        {
          "role": "admin",
          "tenantIds": [
            "customer1"
          ]
        }
      ],
      "totpDevices": [
        {
          "secretKey": "2PRXZWZAYYDAWCD",
          "skew": 0,
          "period": 30,
          "deviceName": "My Authy App"
        }
      ],
      "loginMethods": [
        {
          "tenantIds": [
            "customer1"
          ],
          "isVerified": true,
          "isPrimary": true,
          "timeJoinedInMSSinceEpoch": 0,
          "recipeId": "emailpassword",
          "email": "[email protected]",
          "passwordHash": "$argon2d$v=19$m=12,t=3,p=1$aGI4enNvMmd0Zm0wMDAwMA$r6p7qbr6HD+8CD7sBi4HVw",
          "plainTextPassword": "passwordExample",
          "hashingAlgorithm": "argon2"
        }
      ]
    }
  ],
  "nextPaginationToken": "ZmE3YTA4ND...OzE2MjM5MTgwMzIyMzE="
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"