-
Notifications
You must be signed in to change notification settings - Fork 197
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
clarify sm cookie auth for tasklist api #5258
base: main
Are you sure you want to change the base?
Conversation
👋 🤖 🤔 Hello, @christinaausley! Did you make your changes in all the right places? These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in docs/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
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.
This seems to answer the questions in the original ticket, so I don't have any problem approving from a TW perspective, but this currently only applies to the GraphQL docs. It's not clear to me if this was meant/should apply to the Tasklist REST API?
It looks like it used to exist there in 8.4, but was removed at some point: https://docs.camunda.io/docs/8.4/apis-tools/tasklist-api-rest/tasklist-api-rest-authentication/#authentication-via-cookie
We've had so much back and forth on the cookie auth discussions, I am not sure where it should apply, and I'm not sure if listing it there, too, should be addressed in a follow-up.
@marcosgvieira can we have your input and review here? |
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.
LGTM!
❓ do we need the same in 8.8 docs?
|
||
:::note | ||
When authenticating via cookie, note that Cross-Site Request Forgery (CSRF) protection must be disabled to allow this method of authentication. In a Camunda Self-Managed cluster, set the configuration property `camunda.tasklist.csrfPreventionEnabled` to `false`. | ||
::: | ||
|
||
Another way to access the Tasklist API in a Self-Managed cluster is to send cookie headers in each request. The cookie can be obtained by using the API endpoint `/api/login`. Take the following steps: | ||
Another way to access the Tasklist API in a Self-Managed cluster is to send cookie headers in each request. This works for scenarios where authentication is not managed by Identity. The cookie can be obtained by using the API endpoint `/api/login`: |
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.
To emphasis that it is managed by Tasklist itself
Another way to access the Tasklist API in a Self-Managed cluster is to send cookie headers in each request. This works for scenarios where authentication is not managed by Identity. The cookie can be obtained by using the API endpoint `/api/login`: | |
Another way to access the Tasklist API in a Self-Managed cluster is to send cookie headers in each request. This works for scenarios where authentication is managed by Tasklist and not by Identity. The cookie can be obtained by using the API endpoint `/api/login`: |
Description
Closes https://github.com/camunda/documentation-team/issues/260.
Cookie authentication works only for SM, and in case the customer is not using Identity (in case Identity is up, is not possible to use it).
We can copy this from Operate docs: https://docs.camunda.io/docs/apis-tools/operate-api/operate-api-authentication/#authentication-via-cookie-self-managed-only and just highlight that this works for scenarios where authentication is not managed by Identity.
When should this change go live?
bug
orsupport
label)available & undocumented
label)hold
label)low prio
label)PR Checklist
/docs
directory (version 8.8)./versioned_docs/version-8.7/
directory (version 8.7)./versioned_docs
directory.@camunda/tech-writers
unless working with an embedded writer.