Skip to main content

Activate/Revoke Users

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

Updates the active status of multiple team members.

Authorizations

Authorizationstringheaderrequired
API key authentication

Request​

Body

application/json

Request to activate or revoke (deactivate) one or more users within a team. This operation changes the user status to either Active (enables access) or Inactive (disables access).

    status#UserStatus

    New status for the users: Active (enables system access) or Inactive (disables system access)

    Possible values: [USER_STATUS_UNSPECIFIED, USER_STATUS_ACTIVE, USER_STATUS_INACTIVE]

    teamId#int64

    Team ID containing the users to update. 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.

    Possible values: >= 0

    userAccountIds#int64[]

    List of user account IDs to update. All users will be set to the same status.

    userIds#string[]

    Stable ids of the users to update, as an alternative to userAccountIds. All users will be set to the same status. Mutually exclusive with userAccountIds: set exactly one of the two.

    Possible values: >= 1, <= 1000

Response

application/json

Response confirming the successful status update of users. Contains the user account IDs of all users whose status was changed.

    userAccountIds#int64[]

    List of user account IDs for users whose status was successfully updated