docs: Storage policies: endpoints only accessible by admin (#330)

* Add information on access and auth * Correct wording --------- Co-authored-by: Barbara Czyż <[email protected]>
box · Aug 21, 2023 · e2b4e45 · e2b4e45
1 parent 739416b
commit e2b4e45
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 0 deletions.
diff --git a/content/paths/storage_policies__get_storage_policies.yml b/content/paths/storage_policies__get_storage_policies.yml
@@ -10,6 +10,8 @@ x-box-tag: storage_policies
 
 description: |-
   Fetches all the storage policies in the enterprise.
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
 
 parameters:
   - $ref: '../attributes/fields.yml'

diff --git a/content/paths/storage_policies__get_storage_policies_id.yml b/content/paths/storage_policies__get_storage_policies_id.yml
@@ -9,6 +9,8 @@ tags:
 x-box-tag: storage_policies
 
 description: Fetches a specific storage policy.
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
 
 parameters:
   - $ref: '../attributes/storage_policy_id.yml'

diff --git a/content/paths/storage_policy_assignments__delete_storage_policy_assignments_id.yml b/content/paths/storage_policy_assignments__delete_storage_policy_assignments_id.yml
@@ -18,6 +18,9 @@ description: |-
   There is a rate limit for calling this endpoint of only
   twice per user in a 24 hour time frame.
 
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
+
 parameters:
   - $ref: '../attributes/storage_policy_assignment_id.yml'
 

diff --git a/content/paths/storage_policy_assignments__get_storage_policy_assignments.yml b/content/paths/storage_policy_assignments__get_storage_policy_assignments.yml
@@ -10,6 +10,8 @@ x-box-tag: storage_policy_assignments
 
 description: |-
   Fetches all the storage policy assignment for an enterprise or user.
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
 
 parameters:
   - $ref: '../attributes/marker.yml'

diff --git a/content/paths/storage_policy_assignments__get_storage_policy_assignments_id.yml b/content/paths/storage_policy_assignments__get_storage_policy_assignments_id.yml
@@ -9,6 +9,8 @@ tags:
 x-box-tag: storage_policy_assignments
 
 description: Fetches a specific storage policy assignment.
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
 
 parameters:
   - $ref: '../attributes/storage_policy_assignment_id.yml'

diff --git a/content/paths/storage_policy_assignments__post_storage_policy_assignments.yml b/content/paths/storage_policy_assignments__post_storage_policy_assignments.yml
@@ -10,6 +10,8 @@ x-box-tag: storage_policy_assignments
 
 description: |-
   Creates a storage policy assignment for an enterprise or user.
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
 
 requestBody:
   content:

diff --git a/content/paths/storage_policy_assignments__put_storage_policy_assignments_id.yml b/content/paths/storage_policy_assignments__put_storage_policy_assignments_id.yml
@@ -9,6 +9,8 @@ tags:
 x-box-tag: storage_policy_assignments
 
 description: Updates a specific storage policy assignment.
+  Only a Primary Admin can access this endpoint. The user
+  needs to generate a token for an account to authenticate this request.
 
 parameters:
   - $ref: '../attributes/storage_policy_assignment_id.yml'