diff --git a/templates/zerver/help/include/api-members-only.md b/templates/zerver/help/include/api-members-only.md deleted file mode 100644 index fe10333f81..0000000000 --- a/templates/zerver/help/include/api-members-only.md +++ /dev/null @@ -1,4 +0,0 @@ -!!! warn "" - - This endpoint is only available to Members and Administrators; - bots and guests cannot use this endpoint. diff --git a/templates/zerver/help/include/can-create-users-only.md b/templates/zerver/help/include/can-create-users-only.md deleted file mode 100644 index 870d28a7e8..0000000000 --- a/templates/zerver/help/include/can-create-users-only.md +++ /dev/null @@ -1,13 +0,0 @@ -!!! warn "" - - This endpoint is limited to organizations administrators who - additionally have the `can_create_users` permission for the Zulip organization. - - Zulip Cloud users can request the `can_create_users` permission for a bot by contacting - [Zulip Cloud support](/help/contact-support) with an explanation for why it is needed. - - Self-hosted installations can toggle `can_create_users` on an account using - the `manage.py change_user_role` command. - - **Changes**: Before Zulip 4.0 (feature level 36), this endpoint was - available to all organization administrators. diff --git a/zerver/openapi/zulip.yaml b/zerver/openapi/zulip.yaml index f9114d8ea1..6de586388c 100644 --- a/zerver/openapi/zulip.yaml +++ b/zerver/openapi/zulip.yaml @@ -64,8 +64,8 @@ paths: **Note:** If you signed up using passwordless authentication and never had a password, you can [reset your password](/help/change-your-password). - See the [API keys](/api/api-keys) documentation for - more details on how to download API key manually. + See the [API keys](/api/api-keys) documentation for more details + on how to download an API key manually. In a [Zulip development environment](https://zulip.readthedocs.io/en/latest/development/overview.html), see also [the unauthenticated variant](/api/dev-fetch-api-key). @@ -6319,11 +6319,24 @@ paths: summary: Create a user tags: ["users"] description: | - {!can-create-users-only.md!} - Create a new user account via the API. `POST {{ api_url }}/v1/users` + + !!! warn "" + + **Note**: This endpoint is limited to organization administrators + who additionally have the `can_create_users` permission for the Zulip + organization. Zulip Cloud users can request the `can_create_users` + permission for a bot by contacting [Zulip Cloud support][support] + with an explanation for why it is needed. Self-hosted installations + can toggle `can_create_users` on an account using the `manage.py + change_user_role` command. + + **Changes**: Before Zulip 4.0 (feature level 36), this endpoint was + available to all organization administrators. + + [support]: /help/contact-support x-requires-administrator: true parameters: - name: email @@ -13962,11 +13975,15 @@ paths: summary: Get user groups tags: ["users"] description: | - {!api-members-only.md!} - Fetches all of the user groups in the organization. `GET {{ api_url }}/v1/user_groups` + + !!! warn "" + + **Note**: This endpoint is only available to [members and + administrators](/help/roles-and-permissions); bots and guests + cannot use this endpoint. responses: "200": description: Success.