Skip to main content
Theme
Home

Search Users

GEThttps://api.coralogix.com/mgmt/openapi/5/aaa/users/v2

Searches for team members by query.

Authorizations

Authorizationstringheaderrequired
API key authentication
The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request​

Query Parameters

    team_id# int64

    Possible values: >= 0

    Team ID to search within. Optional on the /aaa/users/v2 routes, which bind no team in the path: omit it and the team of the API key making the call is used.

    username# string

    Optional filter by username (partial match supported)

    status# any

    Possible values: [USER_STATUS_UNSPECIFIED, USER_STATUS_ACTIVE, USER_STATUS_INACTIVE]

    Optional filter by user status (e.g., 'active', 'inactive')

    page_size# int64

    Possible values: >= 0

    Number of results per page

    page_token# int64

    Possible values: >= 0

    Token for pagination to retrieve the next page of results

Response

application/json

Response containing a paginated list of users matching the search criteria, along with pagination tokens and total count.

    nextPageToken#int64

    Token for the next page of results. Empty if no more pages available.

    Possible values: >= 0

    totalCount#int64

    Total number of users matching the search criteria across all pages

    Possible values: >= 0

    List of users matching the search criteria