From e2b4e455d35bb2794115db415b2cc0f0a34ccbbe Mon Sep 17 00:00:00 2001 From: Justyna Sztyper Date: Mon, 21 Aug 2023 14:46:41 +0200 Subject: [PATCH] docs: Storage policies: endpoints only accessible by admin (#330) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add information on access and auth * Correct wording --------- Co-authored-by: Barbara Czyż --- content/paths/storage_policies__get_storage_policies.yml | 2 ++ content/paths/storage_policies__get_storage_policies_id.yml | 2 ++ ...olicy_assignments__delete_storage_policy_assignments_id.yml | 3 +++ ...rage_policy_assignments__get_storage_policy_assignments.yml | 2 ++ ...e_policy_assignments__get_storage_policy_assignments_id.yml | 2 ++ ...age_policy_assignments__post_storage_policy_assignments.yml | 2 ++ ...e_policy_assignments__put_storage_policy_assignments_id.yml | 2 ++ 7 files changed, 15 insertions(+) diff --git a/content/paths/storage_policies__get_storage_policies.yml b/content/paths/storage_policies__get_storage_policies.yml index cf977a49..91aee0ae 100644 --- 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 index 55091c0c..d511b1de 100644 --- 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 index 7d732bcf..58db6790 100644 --- 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 index 2c049172..fbd9b8cd 100644 --- 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 index 3da51f2d..8d02d2f3 100644 --- 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 index 96cf1180..9bae96d4 100644 --- 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 index a8ba5563..770d09e4 100644 --- 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'