Poll the Challenge for Email Magic Link

MyAccount Management

Poll the Challenge for Email Magic Link

Request

OAuth 2.0 scope:

okta.myAccount.email.read

Polls for the email challenge's status

Path

idstringrequired

The email ID

Use the GET /idp/myaccount/emails or POST /idp/myaccount/emails operations to obtain the ID when adding a new email address.

Example:00T196qTp3LIMZQ0L0g3

challengeIdstringrequired

The challengeId of the email

Use the POST /idp/myaccount/emails/{id}/challenge/ operation to obtain the challengeId when creating a new challenge.

Example:x1MDGzUb

Acceptstringrequired

Specifies the API version. Current version: 1.0.0

Example:application/json; okta-version=1.0.0

GET

/idp/myaccount/emails/{id}/challenge/{challengeId}

curl -i -X GET \
  https://okta-subdomain.pixtulate.com/idp/myaccount/emails/00T196qTp3LIMZQ0L0g3/challenge/x1MDGzUb \
  -H 'Accept: application/json; okta-version=1.0.0'

Responses

Bodyapplication/json;okta-version=1.0.0

idstring, non-emptyrequired

The email ID

Example:"myaccount.DDvNA6XORA2dIfB894o32g"

statusstring, non-emptyrequired

The challenge status of the caller's email

Enum:"VERIFIED""UNVERIFIED"

Example:"UNVERIFIED"

expiresAtstring, non-emptyrequired

The time at which the challenge expires. The lifetime of a challenge is five minutes.

Example:"2022-02-01T00:41:25.497Z"

profileobjectrequired

Defines the email address on the profile

Example:

{
  "email": "s.jackson@example.com"
}

_linksobjectrequired

Discoverable resources related to the poll for the email challenge's status

Example:

{
  "verify": {
    "href": "https://okta-example.pixtulate.com/idp/myaccount/emails/da03e945d44d8b714da2b9fded39e851/challenge/myaccount.DDvNA6XORA2dIfB894o32g/verify",
    "hints": { … }
  },
  "poll": {
    "href": "https://okta-example.pixtulate.com/idp/myaccount/emails/da03e945d44d8b714da2b9fded39e851/challenge/myaccount.DDvNA6XORA2dIfB894o32g",
    "hints": { … }
  }
}

Response

{
  "id": "myaccount.DDvNA6XORA2dIfB894o32g",
  "status": "UNVERIFIED",
  "expiresAt": "2022-02-01T00:41:25.497Z",
  "profile": {
    "email": "s.jackson@example.com"
  },
  "_links": {
    "verify": { … },
    "poll": { … }
  }
}