v2

latestSwagger 2.02026-07-26109144190.4 KB

Users

Remove a user

Remove a user from your organization. You can choose a user to act as a replacement or let VictorOps handle finding the replacement. User will be replaced in their on-call rotations, escalation policies and scheduled overrides.

This API may be called a maximum of 2 times per second.

delete/api-public/v1/user/{user}

Path parameters

userstring required

The VictorOps user to be deleted

Headers

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

Request body

replacementstring

The user to take the place of the deleted user in escalations

replacementStrategy'specifiedUser' | 'globalAdmin' | 'teamAdmin' | 'findReplacement'

The strategy you would like to use to replace the user. They work as follows specifiedUser - replace the deleted user with a specific user. If using this strategy, you MUST provide the replacement field as well. This is also the default strategy. So, if you provide no replacementStrategy in your request, you are still required to provide a replacement field. globalAdmin - replace the deleted user with the first Global Admin for the organization. teamAdmin - replace the deleted user in rotations/escalation policies with the team admin for the team related to that rotation or escalation policy. This strategy REQUIRES that every team have an admin that is not the deleted user. findReplacement - This strategy will attempt to find the best replacement based on roles within the team, paging policy configuration and other factors. Selected replacement user will be notified by email. You cannot delete the last active user on any team or last Global Admin user using this strategy.

Response

User was deleted