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

Jira Access Request: teleportAccessRequestId custom field is unused #48552

Open
bernardjkim opened this issue Nov 6, 2024 · 1 comment
Open

Comments

@bernardjkim
Copy link
Contributor

Expected behavior:

The Teleport Jira documentation indicates that the teleportAccessRequestId custom field is required and set in new Jira issues by the Teleport plugin.

Current behavior:

The custom field is neither required or even used by the Teleport Access Request plugin. The current implementation attempts to set the custom field by using the properties request field, but the proper way to set the custom field is to set the custom field id under the fields request field.

Example:
This is the current implementation that does not properly assign the custom field

{
  "fields": {
    "issuetype": {
        "name": "Task"
    },
    "project": {
        "key": "TAR"
    },
    "summary": "user requested role",
    "description": "user requested role ..."
  },
  "properties": [
    {
        "key": "teleportAccessRequestId",
        "value": "test-id"
    }
  ]
}

This would be the proper way to assign the custom field

{
  "fields": {
    "issuetype": {
        "name": "Task"
    },
    "project": {
        "key": "TAR"
    },
    "summary": "user requested role",
    "description": "user requested role ...",
    "customfield_10038": "test-id"
  }
}

Suggested Change

The custom teleportAccessRequestId field was never being used in the first place. The simplest fix would be to remove this requirement from the documentation.

Bug details:

  • Teleport version: 17.0.0-alpha.4
  • Recreation steps: Follow Teleport documentation to enroll a Jira Access Request plugin. Create a new access request. Observe that the created Jira issue has an empty value for the custom teleportAccessRequestId.
ptgott added a commit that referenced this issue Nov 19, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
@ptgott
Copy link
Contributor

ptgott commented Nov 19, 2024

I've addressed the docs side of this here: #49229

If this looks okay, we can remove the documentation label.

ptgott added a commit that referenced this issue Nov 19, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-merge-queue bot pushed a commit that referenced this issue Nov 20, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-actions bot pushed a commit that referenced this issue Nov 20, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-actions bot pushed a commit that referenced this issue Nov 20, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-actions bot pushed a commit that referenced this issue Nov 20, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-merge-queue bot pushed a commit that referenced this issue Nov 22, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-merge-queue bot pushed a commit that referenced this issue Nov 22, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
github-merge-queue bot pushed a commit that referenced this issue Nov 22, 2024
Partially addresses #48552

Remove the instructions to create a `teleportAccessRequestId`, which the
plugin does not use. While the plugin attempts to assign this field when
submitting an issue, it does not use the field, and since the new issue
request is not formatted properly, the field never receives a value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants