Approval Workflows

List users who can vote on a workflow type

GET/approval-workflows/eligible-users
approval-workflows:readlist_eligible_approver_usersRead-only

Lists the users of the organisation, and of its linked client and provider organisations, who may be named as voters for a workflow type: those holding one of the permissions that type needs. filter[type] is required. Suspended users and service identities are left out. Changes nothing. Use it to pick voter_ids for PUT /approval-workflows/{id}.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • sortstring#

    The only sort is id (the user's internal order), ascending. Prefix it with - for descending.

  • filter[type]stringRequired#

    The workflow type to find voters for, one value only. client_invite: users who can invite or create users. incoming_connect, internal_publish and provider_approval: users who can publish deals. internal_provider_publish: any user.

    One of: client_invite, incoming_connect, internal_provider_publish, internal_publish, provider_approval
  • filter[q]string#

    Only users whose username, name or email contains this text, ignoring case.

Responses

200

The users who can vote on the type.

ApprovalEligibleUser[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "email": "string"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/approval-workflows/eligible-users?filter[type]={filter[type]}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"