Skip to content
Authrim

Read asynchronous account provisioning status.

POST
/api/v1/auth/account-provisioning/status
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/v1/auth/account-provisioning/status \
  --header 'Content-Type: application/json' \
  --data '{ "provisioning_token": "example" }'

Reads the tenant-bound operation referenced by an opaque, short-lived resume token. The response never exposes operation, account, user, shard, or binding identifiers.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
provisioning_token
required
string
/^[A-Za-z0-9_-]{43}$/
key
additional properties
Example generated
{
  "provisioning_token": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Public status for an opaque account-provisioning resume token.

Media type application/json
object
status
required
string
Allowed values: pending ready
retry_after_ms
integer
>= 250 <= 2000
restart_required

When true, start a fresh anonymous-login challenge after provisioning is ready.

boolean
key
additional properties
Example 
{
  "status": "pending"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

409

Section titled “409 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}