User Data

The graphiteConnect public API provides endpoints to synchronize information about your organization's graphiteConnect users and the roles assigned to them. For organizations with a large number of users, pagination is supported to return data in manageable chunks.

Users API

GET /api/public/api/v1/users

Returns a list of graphiteConnect users for your organization. User data is returned in JSON format.

Authentication: Bearer JWT (OAuth 2.0)

Query Parameters

Example Request

curl --location 'https://poc.projectgraphite.com/api/public/api/v1/users?limit=500&page=0' \
  --header 'Authorization: Bearer <your_access_token>'

Example Response

{
  "total": 342,
  "results": [
    {
      "_id": "5d8aec25c25758d37debdc7a",
      "email": "[email protected]",
      "name": "Jane Smith",
      "roles": ["admin", "viewer"]
    }
  ]
}

The _id field for each user can be used as the forUserId parameter in the Events API to filter audit events for a specific user.

User Roles API

GET /api/public/api/v1/users/roles

Returns the list of roles defined in your graphiteConnect organization. Role data is also returned in JSON format.

graphiteConnect uses roles for access control. This endpoint lets integrations audit which roles are configured and available.

Example Request

curl --location 'https://poc.projectgraphite.com/api/public/api/v1/users/roles' \
  --header 'Authorization: Bearer <your_access_token>'

Pagination

Both the Users API and the Roles API support pagination for large result sets. Use the limit and page query parameters and check the total field in the response.

See Pagination for full details.

Related Documentation

• Pagination — Pagination query parameters
• Events API — Filter events by user ID using the forUserId parameter