latestOpenAPI 3.1.02026-08-1051813.2 KB

a38c15dd49ef

Profile

Overwrite the list of denylisted usernames

This endpoint replaces the current denylist with the provided list of usernames. If the operation cannot be completed due to some usernames already being in use, the response will contain a list of those usernames. In this case, the denylist will not be modified, and an admin can first overwrite the usernames being used (see the POST api/profile/deny endpoint), and then try again.

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.

put/username/denylist/

Headers

x-m2-organization-idstring required

The ID of an organization

Request body

string[] required

An array of usernames to add to the denylist

Response

Default Response

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