api docs: Use Help Center syntax for restricted endpoints.

This commit is contained in:
Tim Abbott 2019-07-29 16:17:54 -07:00
parent c85640d6b1
commit 8c9dd6198f
4 changed files with 9 additions and 5 deletions

View File

@ -1,8 +1,8 @@
# Create a user
Create a new user in a realm.
{!api-admin-only.md!}
**Note**: The requesting user must be an administrator.
Create a new user account via the API.
`POST {{ api_url }}/v1/users`

View File

@ -1,9 +1,8 @@
# Get user groups
Fetches all of the user groups in the organization.
{!api-members-only.md!}
**Note**: Only organization members or admins can contact this
endpoint; bots and guests cannot contact this endpoint.
Fetches all of the user groups in the organization.
`GET {{ api_url }}/v1/user_groups`

View File

@ -0,0 +1,2 @@
!!! warn ""
This endpoint is only available to organization administrators.

View File

@ -0,0 +1,3 @@
!!! warn ""
This endpoint is only available to Members and Administrators;
bots and guests cannot use this endpoint.