latestOpenAPI 3.1.02026-08-1051813.2 KB

a38c15dd49ef

Profile

Ban and replace usernames

This endpoint adds the provided list of usernames to the (possibly already existing) denylist. If a username is already in use, it is replaced with the provided replacement username. The request must contain a list of pairs of usernames: one to be added to the denylist, and the other to replace it if it is already in use. If a username is already in the denylist, it is skipped.

This operation can be totally or partially successful. If some usernames could not be added to the denylist, the response will contain a list of those usernames.

None of the usernames in the request need to obey the restrictions regarding length and allowed characters.

Important note: denylists rely on unique usernames being enforced at the organization level.

post/username/deny/

Headers

x-m2-organization-idstring required

The ID of an organization

Request body

object required

A record of usernames to add to the denylist, specifying replacements if they are already in use

Response

Default Response

{"stackTrail":"paths:/username/deny/:post:responses:204:content:application/json:schema","oasType":"schema","type":"unknown"}