Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListKxUsers

Lists all the users in a kdb environment.

Request Syntax


GET /kx/environments/environmentId/users?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

environmentId

A unique identifier for the kdb environment.

Length Constraints: Minimum length of 1. Maximum length of 26.

Pattern: ^[a-zA-Z0-9]{1,26}$

Required: Yes

maxResults

The maximum number of results to return in this request.

Valid Range: Minimum value of 0. Maximum value of 100.

nextToken

A token that indicates where a results page should begin.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "users": [ 
      { 
         "createTimestamp": number,
         "iamRole": "string",
         "updateTimestamp": number,
         "userArn": "string",
         "userName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

A token that indicates where a results page should begin.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

users

A list of users in a kdb environment.

Type: Array of KxUser objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400