List Users

GET 
/organizations/:organizationId/users

List users for organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

joinRequest string

Return join request users.

maxResults string

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array of user data objects.
Array [
id stringrequired
sub stringrequired
organizationId stringrequired
emailVerified stringrequired
familyName stringrequired
givenName stringrequired
email stringrequired
appRole stringrequired
status stringrequired
picture string
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "sub": "string",
      "organizationId": "string",
      "emailVerified": "string",
      "familyName": "string",
      "givenName": "string",
      "email": "string",
      "appRole": "string",
      "status": "string",
      "picture": "string",
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedAtDateString": "string",
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "id": "53abe59e-xxxx-xxxx-xxxx-11aa5d05dd6e",
      "sub": "53abe59e-xxxx-xxxx-xxxx-11aa5d05dd6e",
      "organizationId": "o-organizationId",
      "emailVerified": "true",
      "familyName": "Kevin",
      "givenName": "Ashton",
      "email": "example@infodeck.io",
      "appRole": "RequesterAndViewer",
      "status": "ACTIVE",
      "picture": "https://app.infodeck.io/public/organizations/o-orgId/users/userId/defaultimage.jpg",
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "updatedAtDateString": "2024-01-31T00:00:00.000Z",
      "updatedAt": 1706659200000
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...