Claim a username

Claim a globally unique username.

Claiming is one-time: once you have a username, this endpoint returns 409. Changing it afterwards goes through PUT /auth/username, which is subject to a 14-day cooldown.

POST

https://truememory-auth.mvstg.com/auth/username/claim

View as Markdown

Authorization

HTTPBearerHTTPrequired

Request bodyJSONrequired

usernamestringrequired
Desired username. 3-30 chars, lowercase alphanumeric, hyphens, underscores.

Returns

200

Successful Response

JSON

idstringrequired
format: uuid
gip_uidstringrequired
tenant_idoptional
One of the following:
string
null
}
emailoptional
One of the following:
string
null
}
email_verifiedoptionalboolean
default: false
usernameoptional
One of the following:
string
null
}
display_nameoptional
One of the following:
string
null
}
photo_urloptional
One of the following:
string
null
}
phone_numberoptional
One of the following:
string
null
}
disabledoptionalboolean
default: false
roleoptionalstring
default: "user"
metadataoptionalobject
raw_app_meta_dataoptionalobject
custom_claimsoptionalobject
last_sign_in_atoptional
One of the following:
string
null
}
created_atoptional
One of the following:
string
null
}
updated_atoptional
One of the following:
string
null
}
deleted_atoptional
One of the following:
string
null
}
deletion_completed_atoptional
One of the following:
string
null
}

422

Validation Error

JSON

detailoptionalarray ofobject
- locarray ofrequired
  One of the following:
  string
  integer
- msgstringrequired
- typestringrequired
- inputoptionalunknown
- ctxoptionalobject
}

curl --request POST \ --url https://truememory-auth.mvstg.com/auth/username/claim \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "username": "jane_doe" } '

{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "gip_uid": "string", "email": "string", "email_verified": false, "username": "string", "display_name": "string", "photo_url": "string", "phone_number": "string", "disabled": false, "role": "user", "metadata": {}, "raw_app_meta_data": {}, "custom_claims": {}, "last_sign_in_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "deletion_completed_at": "2019-08-24T14:15:22Z" }