Skip to content
This repository was archived by the owner on Sep 28, 2026. It is now read-only.

Commit fcfd0be

Browse files
elliot-huffmanelliot-huffman
committed
Update Permission Wording
Makes it more clear.
1 parent ea5f146 commit fcfd0be

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

‎specs/Url-Shortener.json‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@
511511
"/Api/Redirect": {
512512
"get": {
513513
"summary": "Retrieves All Redirect Configuration Records",
514-
"description": "Retrieves all redirect records matching the requested filters, if any.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
514+
"description": "Retrieves all redirect records matching the requested filters, if any.\n\nThis endpoint requires that the principal has an RBAC assignment to view the associated records or have the role `Everything.ReadWrite.All`, or `Redirect.ReadWrite.All` assigned in Entra to view all regardless of RBAC.",
515515
"operationId": "/Api/Redirect/Get",
516516
"parameters": [
517517
{
@@ -662,7 +662,7 @@
662662
},
663663
"post": {
664664
"summary": "Creates New Redirect Configuration Record",
665-
"description": "Creates new URL redirect record in the database and returns information enriched with created metadata.\n\nThis endpoint does not have scope (permission) restrictions.",
665+
"description": "Creates new URL redirect record in the database and returns information enriched with created metadata.\n\nThis endpoint does not have scope (permission) restrictions. Creating principal is set as RBAC owner of the newly created URL.",
666666
"operationId": "/Api/Redirect/Post",
667667
"requestBody": {
668668
"required": true,
@@ -782,7 +782,7 @@
782782
"/Api/Redirect/{id}": {
783783
"get": {
784784
"summary": "Retrieves Specific Redirect Configuration Record",
785-
"description": "Retrieves all information from the database of the redirect record.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
785+
"description": "Retrieves all information from the database of the redirect record.\n\nTo view the specific record, the principal has to be a part of an RBAC assignment or one of the following Entra roles: `Everything.ReadWrite.All`, or `Redirect.ReadWrite.All`.",
786786
"operationId": "/Api/Redirect/:id/Get",
787787
"parameters": [
788788
{
@@ -813,7 +813,7 @@
813813
},
814814
"patch": {
815815
"summary": "Updates Specific Redirect Configuration Record",
816-
"description": "Updates one or more properties of the redirect record based on which fields are provided.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
816+
"description": "Updates one or more properties of the redirect record based on which fields are provided.\n\nThis endpoint requires either of the following RBAC assignments: `Owner` or `Contributor` on the specific record, or have the role `Everything.ReadWrite.All`, or `Redirect.ReadWrite.All` assigned in Entra to update regardless of RBAC.",
817817
"operationId": "/Api/Redirect/:id/Patch",
818818
"parameters": [
819819
{
@@ -863,7 +863,7 @@
863863
},
864864
"delete": {
865865
"summary": "Removes Specific Redirect Configuration Record",
866-
"description": "Deletes the redirect record from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
866+
"description": "Deletes the redirect record from the database.\n\nThis endpoint requires an RBAC assignment of `Owner` or `Contributor` on the specific record, or the `Everything.ReadWrite.All`, or `Redirect.ReadWrite.All` scope (permission) regardless of permissions.",
867867
"operationId": "/Api/Redirect/:id/Delete",
868868
"parameters": [
869869
{
@@ -886,7 +886,7 @@
886886
"/Api/BannedName": {
887887
"get": {
888888
"summary": "Retrieves All Banned Name Records",
889-
"description": "Retrieves all records of the banned terms that are not allowed to be used as targets.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
889+
"description": "Retrieves all records of the banned terms that are not allowed to be used as targets.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments to be able to view bans.",
890890
"operationId": "/Api/BannedName/Get",
891891
"parameters": [
892892
{
@@ -987,7 +987,7 @@
987987
"/Api/BannedName/{id}": {
988988
"get": {
989989
"summary": "Retrieves Specific Banned Name Record",
990-
"description": "Retrieves all information from the database of the banned name record.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
990+
"description": "Retrieves all information from the database of the banned name record.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments to view the specific ban.",
991991
"operationId": "/Api/BannedName/:id/Get",
992992
"parameters": [
993993
{
@@ -1018,7 +1018,7 @@
10181018
},
10191019
"delete": {
10201020
"summary": "Removes Specific Banned Name Record",
1021-
"description": "Deletes the banned name record from the database.\n\nThis endpoint requires an RBAC assignment or the `BanList.ReadWrite.All` or `Everything.ReadWrite.All` scope (permission).",
1021+
"description": "Deletes the banned name record from the database.\n\nThis endpoint requires an RBAC assignment and the `BanList.ReadWrite.All` or `Everything.ReadWrite.All` scope (permission).",
10221022
"operationId": "/Api/BannedName/:id/Delete",
10231023
"parameters": [
10241024
{
@@ -1041,7 +1041,7 @@
10411041
"/Api/Domain": {
10421042
"get": {
10431043
"summary": "Retrieves All Domain Name Records",
1044-
"description": "Retrieves all domain name records from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
1044+
"description": "Retrieves all domain name records from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments.",
10451045
"operationId": "/Api/Domain/Get",
10461046
"parameters": [
10471047
{
@@ -1172,7 +1172,7 @@
11721172
"/Api/Domain/{id}": {
11731173
"get": {
11741174
"summary": "Retrieves Specific Domain Name Record",
1175-
"description": "Retrieves all information from the database of the domain name record.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
1175+
"description": "Retrieves all information from the database of the domain name record.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments.",
11761176
"operationId": "/Api/Domain/:id/Get",
11771177
"parameters": [
11781178
{
@@ -1275,7 +1275,7 @@
12751275
"/Api/Rbac": {
12761276
"get": {
12771277
"summary": "Retrieves All RBAC Assignment Records",
1278-
"description": "Retrieves all RBAC assignment records from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
1278+
"description": "Retrieves all RBAC assignment records from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments.",
12791279
"operationId": "/Api/Rbac/Get",
12801280
"parameters": [
12811281
{
@@ -1376,7 +1376,7 @@
13761376
},
13771377
"post": {
13781378
"summary": "Creates New RBAC Assignment Record",
1379-
"description": "Create new RBAC assignment record in the database and returns information enriched with created metadata.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
1379+
"description": "Create new RBAC assignment record in the database and returns information enriched with created metadata.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments.",
13801380
"operationId": "/Api/Rbac/Post",
13811381
"requestBody": {
13821382
"required": true,
@@ -1462,7 +1462,7 @@
14621462
},
14631463
"delete": {
14641464
"summary": "Removes Specific RBAC Assignment Record",
1465-
"description": "Deletes the RBAC assignment record from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's access level.",
1465+
"description": "Deletes the RBAC assignment record from the database.\n\nThis endpoint does not have implicit scope (permission) restrictions but includes an internal check on user's RBAC assignments.",
14661466
"operationId": "/Api/Rbac/:id/Delete",
14671467
"parameters": [
14681468
{

0 commit comments

Comments
 (0)