Skip to content

OAuth documentation for GET /api/v2/users/me/ appears inconsistent with required global read scope #10201

Open

Description

@rohith-doradla

Page:
Developer Docs → API Reference → v2 → Authentication → Who am I

Problem

The documentation states:

"An OAuth token needs the global read scope; a token with only fine-grained scopes such as projects.states:read cannot call it."

However, the example response for the endpoint shows:

"principal_kind": "oauth",
"scopes": [
"projects.work_items:read",
"projects.states:read"
]

These are only fine-grained scopes, which seems to contradict the statement above.

Question

If GET /api/v2/users/me requires the global read scope, why does the sample response show only fine-grained scopes?

Is this:

an incorrect example response,

expected behavior that needs additional explanation?

Suggested improvement

Either:

Update the sample response to include the required global read scope, or

Add a note explaining why the response displays only fine-grained scopes even though the endpoint requires the global read scope.

Thank you!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions