Retry user PII sync

POST

/api/admin/users/{id}/retry-pii

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/users/example/retry-pii \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "name": "User Example", "given_name": "User", "family_name": "Example" }'

Writes canonical PII values for a user whose PII status needs repair.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body ^required

JSON request body.

Media type application/json

object

email

required

string format: email

name

string

given_name

string

family_name

string

nickname

string

preferred_username

string

phone_number

string

picture

string

website

string

gender

string

birthdate

string

locale

string

zoneinfo

string

address_formatted

string

address_street_address

string

address_locality

string

address_region

string

address_postal_code

string

address_country

string

declared_residence

string

key

additional properties

Example

{
  "email": "[email protected]",
  "name": "User Example",
  "given_name": "User",
  "family_name": "Example"
}

Responses

200

Successful JSON response.

Media type application/json

object

success

required

boolean

message

required

string

user_id

required

string

pii_status

required

string

key

additional properties

Example

{
  "success": true,
  "message": "Canonical PII values updated successfully",
  "user_id": "user_123",
  "pii_status": "active"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}