AM
ZH-CN
免费开始
菜单

Contents

User email credential management

GET/api/users/{user_id}/credentials

List all email credentials for a user. Returns paginated results with credential details.

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemEmailCredentialrequired
Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.
idstringrequired
user_idstringrequired
Unique identifier for a user.
emailEmailAddress | nullEmailAddress
A valid, normalized email address.
hashed_emailstring | null
email_verified_atstring | null
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/users/{user_id}/credentials

Create a new email credential for a user. Users can have multiple email addresses.

Body application/json
passwordstring
Responses
200application/json
OK
schemaobject
dataEmailCredentialrequired
Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.
idstringrequired
user_idstringrequired
Unique identifier for a user.
emailEmailAddress | nullEmailAddress
A valid, normalized email address.
hashed_emailstring | null
email_verified_atstring | null
linksobjectrequired
selfstringrequired
URL of the created resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
DELETE/api/users/{user_id}/credentials/{credential_id}

Delete an email credential from a user.

Responses
200application/json
OK
schemaobject
dataEmailCredentialrequired
Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.
idstringrequired
user_idstringrequired
Unique identifier for a user.
emailEmailAddress | nullEmailAddress
A valid, normalized email address.
hashed_emailstring | null
email_verified_atstring | null
linksobjectrequired
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/users/{user_id}/credentials/{credential_id}

Get a single email credential for a user.

Responses
200application/json
OK
schemaobject
dataEmailCredentialrequired
Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.
idstringrequired
user_idstringrequired
Unique identifier for a user.
emailEmailAddress | nullEmailAddress
A valid, normalized email address.
hashed_emailstring | null
email_verified_atstring | null
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
PATCH/api/users/{user_id}/credentials/{credential_id}

Update an email credential’s password. Only application admins can change passwords via this endpoint; users should use /auth/ endpoints. Email changes are not supported—create a new credential and delete the old one instead.

Body application/json
passwordstring
Responses
200application/json
OK
schemaobject
dataEmailCredentialrequired
Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.
idstringrequired
user_idstringrequired
Unique identifier for a user.
emailEmailAddress | nullEmailAddress
A valid, normalized email address.
hashed_emailstring | null
email_verified_atstring | null
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring

Models

EmailAddress
string · email
A valid, normalized email address.
EmailCredential
idstringrequired
user_idstringrequired
Unique identifier for a user.
emailEmailAddress | nullEmailAddress
A valid, normalized email address.
hashed_emailstring | null
email_verified_atstring | null
ProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
ValidationProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring