Skip to main content

ConfirmUserEmail

Confirm the changed email address

Description​

  • It is called when the URL sent to the email address specified as the change destination is clicked.
  • The existence of the changed e-mail address is confirmed, and the user is redirected to the page after the e-mail address change.

Method​

GET

Request URL Format​

/api/v0/users/confirmations/:confirmation_id

URL Params​

confirmation_id : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx //Required Confirmation ID included in the email

Request URL Sample​

GET https://api.xxx.com/api/v0/users/confirmations/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Response Sample​

{
   "user":{
      "confirmation_id":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",//Confirmation ID above
      "email_confirmed":bool, //true = email address change confirmed; false = unconfirmed
      "isElapsed":bool, // false: Confirmation completed within the time limit; true: Error due to time limit exceeded
      "email":"[email protected]", //Email before changing
      "tmp_email":"[email protected]",//Modified email
      "id":"5f25952c28dc5c55b463bc76",//System internal userID
      "username":"ユーザー名",
      "confirmed":bool, //true = initial registration completed; false = initial registration not completed
      "current_workspace_id":"5f25956428dc5c55b463bc78", // Current workspace ID
      "workspace":{
         "name":"Group name" //Name of the invited group
         "display_id":"GROUP_ID",//ID of the invited group
         "g_id":"60014c5128dc5c09a8c44d4d",
         "id":"60014c5128dc5c09a8c44d4d",
         "disable_ui_access":true,
         "index":0,
         "is_root":false,
         "access_key":"60014c5128dc5c09a8c44d4e",
         "created_at":"2021-01-15T17:03:29.2573655+09:00",
      }
   }