0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-30 20:33:54 -05:00

chore: add changeset and api doc

This commit is contained in:
Gao Sun 2024-03-20 13:39:22 +08:00
parent 6feb531435
commit abffb9f95e
No known key found for this signature in database
GPG key ID: 13EBE123E4773688
2 changed files with 42 additions and 0 deletions

View file

@ -0,0 +1,18 @@
---
"@logto/core-kit": minor
"@logto/schemas": minor
"@logto/core": minor
"@logto/phrases-experience": patch
"@logto/integration-tests": patch
---
full oidc standard claims support
We have added support for the remaining [OpenID Connect standard claims](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims). Now, these claims are accessible in both ID tokens and the response from the `/me` endpoint.
Additionally, we adhere to the standard scopes - claims mapping. This means that you can retrieve most of the profile claims using the `profile` scope, and the `address` claim can be obtained by using the `address` scope.
For all newly introduced claims, we store them in the `user.profile` field.
> ![Note]
> Unlike other database fields (e.g. `name`), the claims stored in the `profile` field will fall back to `undefined` rather than `null`. We refrain from using `?? null` here to reduce the size of ID tokens, since `undefined` fields will be stripped in tokens.

View file

@ -108,6 +108,30 @@
"description": "Update custom data for the given user ID. This method performs a partial update of the custom data object."
}
},
"/api/users/{userId}/profile": {
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"profile": {
"description": "Partial profile object to update for the given user ID."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Updated profile in JSON for the given user ID."
}
},
"summary": "Update user profile",
"description": "Update profile for the given user ID. This method performs a partial update of the profile object."
}
},
"/api/users": {
"post": {
"requestBody": {