Skip to main content

Retrieve users in all associated accounts

GET 

https://api.logz.io/v1/user-management/recursive

Returns a list of users in the main account and all associated sub accounts as an array of JSON objects per account.

If a user appears in multiple accounts, it will be listed separately under each account.

Note: Must be run with an API token belonging to the main account. Please ensure to change the region in the URL to match your account's region.

Request

Responses

successful operation

Schema
  • Array [
  • id int32

    ID of the user

    username string

    Email address used to sign in to Logz.io

    fullName string

    First and last name of the user

    accountID int32

    Logz.io account ID.

    role string

    User role. Can be USER_ROLE_READONLY, USER_ROLE_REGULAR or USER_ROLE_ACCOUNT_ADMIN.

    active boolean

    If the user is active, true. If the user is suspended, false.

  • ]

Authorization: X-API-TOKEN

name: X-API-TOKENtype: apiKeydescription: You can manage your API tokens from the [Logz.io API tokens](https://app.logz.io/#/dashboard/settings/manage-tokens/api) page.

API tokens are account-specific. You will need to be logged into the relevant Log Management or SIEM account to view the API tokens associated with it.

To manage your API tokens, log into the relevant account in your Logz.io platform, click the gear in the top-right menu, and select [**Tools > Manage tokens > API tokens**](https://app.logz.io/#/dashboard/settings/manage-tokens/api).

It's important to keep your tokens secure. API tokens carry privileges to make changes to users and accounts, so if you believe an API token has been compromised, delete it, and replace it with a new token in your integrations.in: header
curl -L -X GET 'https://api.logz.io/v1/user-management/recursive' \
-H 'Accept: application/json' \
-H 'X-API-TOKEN: <API_KEY_VALUE>'
Request Collapse all
Base URL
https://api.logz.io
Auth