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.

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

Inconsistency in Zero Trust permission naming #17351

Open
tomasbedrich opened this issue Oct 6, 2024 · 1 comment
Open

Inconsistency in Zero Trust permission naming #17351

tomasbedrich opened this issue Oct 6, 2024 · 1 comment
Assignees
Labels
Backlog PR has a related JIRA ticket content:edit Request for content edits documentation Documentation edits product:API product:fundamentals

Comments

@tomasbedrich
Copy link

tomasbedrich commented Oct 6, 2024

Existing documentation URL(s)

https://developers.cloudflare.com/fundamentals/api/reference/permissions/

What changes are you suggesting?

There is a permission called "Zero Trust Write", which is available in the UI to assign to the API token. All good so far. ✅

However, when I try to assign this permission to the API token using Terraform (-> using API under the hood), it fails due to "Zero Trust Write" missing in the list of available permissions. I am using the suggested pattern. 😳

I traced it down using List Token Permission Groups endpoint, where the mentioned "Zero Trust Write" permission is not present at all. This is a clear inconsistency between docs and API. Likely there are more of the "Zero Trust ***" permissions which are incorrect.

Using reverse-engineering – i.e. by setting the permissions using UI, refreshing the Terraform resource and reading the Terraform state - I discovered the "Zero Trust Edit" (UI) permission corresponds to the "Teams Write" (API) permission.

I can see two possible resolutions:

  1. Unify permissions used in UI and API. (preferably)
  2. Provide a translation table in the docs.

Additional information

No response

@tomasbedrich tomasbedrich added content:edit Request for content edits documentation Documentation edits labels Oct 6, 2024
@ranbel ranbel added the Backlog PR has a related JIRA ticket label Oct 17, 2024
@ranbel
Copy link
Contributor

ranbel commented Oct 17, 2024

Hey @tomasbedrich thanks for flagging. I've opened an internal ticket (PCX-14250) to track this issue. We're investigating what it would take to update the permission names used by the API/Terraform, as they're not something the dev docs team can update directly.

@cloudflare cloudflare deleted a comment from Uthinkugood82 Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backlog PR has a related JIRA ticket content:edit Request for content edits documentation Documentation edits product:API product:fundamentals
Projects
None yet
Development

No branches or pull requests

5 participants