View Source Jiraffe.Permissions (Jiraffe v0.1.2)

This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.

Summary

Functions

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.

Types

Link to this type

my_permissions_params()

View Source
@type my_permissions_params() :: [
  project_key: String.t(),
  project_id: String.t(),
  issue_key: String.t(),
  issue_id: String.t(),
  permissions: [String.t()],
  project_uuid: String.t(),
  project_configuration_uuid: String.t(),
  comment_id: String.t()
]

Functions

Link to this function

my_permissions(client, params)

View Source
@spec my_permissions(
  client :: Jiraffe.Client.t(),
  params :: my_permissions_params()
) :: {:ok, map()} | {:error, Jiraffe.Error.t()}

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, issue or comment context.

Params

  • project_key - The project key for the project.
  • project_id - The project id for the project.
  • issue_key - The issue key for the issue.
  • issue_id - The issue id for the issue.
  • permissions - (Required) A list of permission keys.
  • project_uuid - The UUID of the project.
  • project_configuration_uuid - The UUID of the project configuration.
  • comment_id - The ID of the comment.