-
Notifications
You must be signed in to change notification settings - Fork 809
API Users and external access to the Management API #6628
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.
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
API Users and external access to the Management API #6628
Conversation
…nal-access # Conflicts: # 15/umbraco-cms/SUMMARY.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took the liberty to fix some minor grammar issues and a couple of typos.
I've also made a couple of suggestions for small rewrites.
Let me know if something doesn't make sense.
And you've hit the nail on the head with the change to the SUMMARY file 👏
The idea is that we only add the updated and new articles to the SUMMARY file while the RC is out. When the final release comes, I'll merge the SUMMARY file with the one from 14, and.. yeah, we can call it magic! I like that 😎
Protip:
Use the GitBook preview to check that your articles have been added correctly ⭐

It's the link with the "docs.umbraco.com" at the end 👏
|
Makes a lot of sense 👍 thanks!
tors. 7. nov. 2024 13.28 skrev sofietoft ***@***.***>:
… ***@***.**** requested changes on this pull request.
I took the liberty to fix some minor grammar issues and a couple of typos.
I've also made a couple of suggestions for small rewrites.
Let me know if something doesn't make sense.
And you've hit the nail on the head with the change to the SUMMARY file 👏
The idea is that we only add the updated and new articles to the SUMMARY
file while the RC is out. When the final release comes, I'll merge the
SUMMARY file with the one from 14, and.. yeah, we can call it magic! I like
that 😎
Protip:
Use the GitBook preview to check that your articles have been added
correctly ⭐
image.png (view on web)
<https://github.com/user-attachments/assets/530d4902-0924-4461-8896-d23c9bf983aa>
It's the link with the "docs.umbraco.com" at the end 👏
------------------------------
In 15/umbraco-cms/reference/management-api/external-access.md
<#6628 (comment)>:
> +The token endpoint response looks like this:
+
+```json
+{
+ "access_token": "ZnEAKg5YwDc7621y6xZlEdT9kwp_ULGQPc5mnY9cDw0",
+ "token_type": "Bearer",
+ "expires_in": 299
+}
+```
+
+As shown, the access token should be used as a Bearer token when consuming the Management API.
+
+Also, notice that access tokens have a fixed expiry. While you can keep issuing new tokens for the Client Credentials, please reuse tokens within their lifespan. This will be more performant and avoid flooding the Umbraco database with tokens.
+
+{% hint style="info" %}
+The Management API does not support OIDC Discovery. This is reserved for accessing protected for Members via the [Delivery API](../content-delivery-api/protected-content-in-the-delivery-api.md).
A suggestion to avoid using an acronym here, and then I believe the word
"content" was missing 🙈
⬇️ Suggested change
-The Management API does not support OIDC Discovery. This is reserved for accessing protected for Members via the [Delivery API](../content-delivery-api/protected-content-in-the-delivery-api.md).
+The Management API does not support OpenID Connect Discovery. This is reserved for Members accessing protected content via the [Delivery API](../content-delivery-api/protected-content-in-the-delivery-api.md).
------------------------------
In 15/umbraco-cms/reference/management-api/external-access.md
<#6628 (comment)>:
> +The following code sample demonstrates how to consume the Management API by:
+
+1. Obtaining an access token from the token endpoint.
+2. Fetching data from the "current user" endpoint.
Tiny rewrite! Let me know if it makes sense.
⬇️ Suggested change
-The following code sample demonstrates how to consume the Management API by:
-
-1. Obtaining an access token from the token endpoint.
-2. Fetching data from the "current user" endpoint.
+The following code sample demonstrates how to consume the Management API by
+
+1. Obtaining an access token from the token endpoint, and
+2. Fetching data from the "current user" endpoint.
—
Reply to this email directly, view it on GitHub
<#6628 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABYP6CUPEOP4B7UCUSMKBQTZ7NMHRAVCNFSM6AAAAABRJRXGVGVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIMRQHAZDENJWGQ>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Co-authored-by: sofietoft <stk@umbraco.com>
Co-authored-by: sofietoft <stk@umbraco.com>
Description
Added docs for API Users and external access to the Management API.
Please pay special attention to the changes in
SUMMARY.md- I don't know if I did that correctly... I have only added the new/changed articles in there. Should everything in the[Data]and[Management API]from the V14 version ofSUMMARY.mdhave been copied over to the V15 version, or will they "just" merge magically?Type of suggestion
Product & version (if relevant)
V15
Deadline (if relevant)
Ideally before the release of V15 😄