list_vertical_users

VerticalsApi.list_vertical_users(id, action, role_id=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List BI users on a vertical

Returns users who have this vertical in AllowedApps and owner or editor ACL on the vertical. Requires verticals.view on role_id and some ACL on the vertical. Query action must be list-qs-users; any other or missing action returns HTTP 400 with Message “Unsupported action: ‘{action}’ for this endpoint.” (no error code prefix). Response body is a JSON array (not a wrapped object). User objects have UserId, FullName, EmailId, and AllowedApps. QuickSightRole is not populated on this endpoint. This Lambda maps InvalidInputException and UnauthorizedUserException to HTTP 400. Example: GET /verticals/{id}/users?action=list-qs-users

Parameters:

  • id (str) – VerticalId to list attached BI-capable users for. (required)

  • action (str) – Must be list-qs-users. (required)

  • role_id (str) – Amorphic role ID used to authorize the request. Must grant verticals.view. The caller must belong to the role.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

List[VerticalSystemUser]

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /verticals/{id}/users

Parameter examples

Name

In

Example

id

path

"11111111-2222-3333-4444-555555555555"

action

query

"list-qs-users"

role_id

header

"custom-role-123e4567-e89b-12d3-a456-426614174000"

Success (HTTP 200)

Array of users with owner or editor access on the vertical.

Request / response example

[
  {
    "UserId": "jane.doe",
    "FullName": "Jane Doe",
    "EmailId": "jane.doe@example.com",
    "AllowedApps": [
      "amorphic",
      "bi"
    ]
  }
]

Errors

Documented error codes: AUTH-1001.

HTTP 400

InvalidInputException or UnauthorizedUserException. Body is {“Message”: “<CODE> - <text>”}. Unsupported or missing action returns Message “Unsupported action: ‘{action}’ for this endpoint.” without an error-code prefix.

missingRole

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

HTTP 500

GenericFailure, InconsistentMetadata, or unhandled exception. Body is {“Message”: “<CODE> - <text>”} or a raw exception string.

unexpected

{
  "Message": "Unexpected error - <exception text>"
}