Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document userinfo endpoint #6849

Merged
merged 4 commits into from
Feb 5, 2025
Merged

Document userinfo endpoint #6849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c32cf68
Update README.md
bjarnef Feb 4, 2025
e9ad643
Update README.md
bjarnef Feb 4, 2025
74f17e8
Update protected-content-in-the-delivery-api.md
bjarnef Feb 4, 2025
73955ee
Update protected-content-in-the-delivery-api.md
bjarnef Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions ...aco-cms/reference/content-delivery-api/protected-content-in-the-delivery-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,28 @@ To terminate the active session for any given member, you must redirect the brow
GET /umbraco/delivery/api/v1/security/member/signout?post_logout_redirect_uri={valid URL from LogoutRedirectUrls}
```

### User info

The "user info" endpoint is part of the OpenId Connect core spec.

This implementation returns a few of the standard claims, all of which are subject of availability:

- `sub` (required claim)
- `name` (if available)
- `email` (if available)

On top of this, the member groups (if any) are returned in the role claim.

The implementation is build to be extendable, so custom claims can be added to these claims - and the core claims can be removed, too.

```http
GET /umbraco/delivery/api/v1/security/member/userinfo
```

{% hint style="info" %}
This was introduced in Umbraco 13.6.0.
{% endhint %}

## Testing with Swagger

The Delivery API Swagger document can be configured to support member authentication.
Expand Down
18 changes: 18 additions & 0 deletions .../reference/content-delivery-api/protected-content-in-the-delivery-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,24 @@ To terminate the active session for any given member, you must redirect the brow
GET /umbraco/delivery/api/v1/security/member/signout?post_logout_redirect_uri={valid URL from LogoutRedirectUrls}
```

### User info

The "user info" endpoint is part of the OpenId Connect core spec.

This implementation returns a few of the standard claims, all of which are subject of availability:

- `sub` (required claim)
- `name` (if available)
- `email` (if available)

On top of this, the member groups (if any) are returned in the role claim.

The implementation is build to be extendable, so custom claims can be added to these claims - and the core claims can be removed, too.

```http
GET /umbraco/delivery/api/v1/security/member/userinfo
```

## Testing with Swagger

The Delivery API Swagger document can be configured to support member authentication.
Expand Down