Verify and apply an email address addition or replacement.

POST

/api/account/identifier-replacements/complete

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/account/identifier-replacements/complete \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "challenge_id": "example", "code": "example" }'

Consumes the new-address code. Initial additions publish the verified email route and complete immediately; replacements create a durable replacement operation and return after completion or durable forward repair handoff.

Authorizations

• accountSessionCookie

Parameters

Header Parameters

Idempotency-Key

required

string

>= 8 characters <= 200 characters

Request Body ^required

Media type application/json

object

challenge_id

required

string

code

required

string

/^[0-9]{6}$/

key

additional properties

Example ^generated

{
  "challenge_id": "example",
  "code": "example"
}

Responses

200

Durable identifier replacement operation response.

Media type application/json

object

operation

required

object

id

required

string

state

required

string

Allowed values: processing directory_pending authoritative_switch_pending authoritative_switched revocation_pending completed blocked_forward_repair canceled

status_url

string

error_code

string | null

created_at

integer

updated_at

integer

completed_at

integer | null

key

additional properties

key

additional properties

Example

{
  "operation": {
    "state": "processing"
  }
}

202

Durable identifier replacement operation response.

Media type application/json

object

operation

required

object

id

required

string

state

required

string

Allowed values: processing directory_pending authoritative_switch_pending authoritative_switched revocation_pending completed blocked_forward_repair canceled

status_url

string

error_code

string | null

created_at

integer

updated_at

integer

completed_at

integer | null

key

additional properties

key

additional properties

Example

{
  "operation": {
    "state": "processing"
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

error_code

Stable Authrim error category that can be provided to support.

string

/^AR[0-9]{6}$/

error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}