Added OAuth2 GET and POST to GraphRBAC.json spec (#3563)

* Cleaned up graphrbac.json and rebase * Add description to post body for OAuth2 Permissions
Azure · Aug 22, 2018 · 146bc8c · 146bc8c
1 parent ccef195
commit 146bc8c
Showing 1 changed file with 119 additions and 1 deletion.
diff --git a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json
@@ -1003,7 +1003,7 @@
           "ServicePrincipal"
         ],
         "operationId": "ServicePrincipals_Get",
-        "description": "Gets service principal information from the directory.",
+        "description": "Gets service principal information from the directory. Query by objectId or pass a filter to query by appId",
         "parameters": [
           {
             "name": "objectId",
@@ -1592,6 +1592,78 @@
           }
         }
       }
+    },
+    "/{tenantID}/oauth2PermissionGrants" : {
+      "get" : {
+       "tags": [
+         "OAuth2Permissions_get"
+       ],
+        "operationId": "OAuth2_Get",
+        "description": "Queries OAuth2 permissions for the relevant SP ObjectId of an app.",
+        "produces" : [ "application/json" ],
+        "parameters" : [
+        {
+          "name" : "$filter",
+          "in" : "query",
+          "required" : false,
+          "type" : "string",
+          "x-example" : "clientId+eq+'61ed44c3-5a1d-4639-a215-07f25129c6c3'",
+          "description": "This is the Service Principal ObjectId associated with the app"
+        },
+        {
+          "$ref": "#/parameters/ApiVersionParameter"
+        },
+        {
+          "$ref": "#/parameters/tenantIDInPath"
+        }
+       ],
+        "responses" : {
+          "200" : {
+            "description" : "OK. The operation was successful.",
+            "schema" : {
+              "$ref" : "#/definitions/Permissions"
+            }
+          }
+        }
+      },
+      "post" : {
+       "tags": [
+         "OAuth2Permissions_post"
+       ],
+        "consumes" : [ "application/json" ],
+        "operationId": "OAuth2_Post",
+        "description": "Grants OAuth2 permissions for the relevant resource Ids of an app.",
+        "produces" : [ "application/json" ],
+        "parameters" : [ 
+          {
+          "in" : "body",
+          "name" : "body",
+          "required" : false,
+          "description": "The relevant app Service Principal Object Id and the Service Principal Objecit Id you want to grant.",
+          "schema" : {
+            "$ref" : "#/definitions/Permissions"
+              },
+              "x-examples" : {
+                  "application/json" : "{\n\t\"odata.type\": \"Microsoft.DirectoryServices.OAuth2PermissionGrant\",\n\t\"clientId\": \"39afbaa2-4a5c-4f5b-9ee3-2c83f09bbc87\", \n\t\"consentType\": \"AllPrincipals\",\n\t\"principalId\": null,\n\t\"resourceId\": \"d3247842-c517-4520-80a7-332690ae2fe4\",\n\t\"scope\": \"user_impersonation\",\n    \"startTime\": \"0001-01-01T00:00:00\",\n    \"expiryTime\": \"9000-01-01T00:00:00\"\n}",
+                  "description": "These are the values required to grant permission to a resourceId for an app, only one operation is allowed per request"
+                }
+          },
+          {
+          "$ref": "#/parameters/ApiVersionParameter"
+          },
+          {
+              "$ref": "#/parameters/tenantIDInPath"
+          }
+        ],
+        "responses" : {
+          "201" : {
+            "description" : "OK. The operation was successful.",
+            "schema" : {
+              "$ref" : "#/definitions/Permissions"
+            }
+          }
+        }
+      }
     }
   },
   "x-ms-paths": {
@@ -2985,6 +3057,52 @@
         }
       },
       "description": "Server response for Get tenant domains API call."
+    },
+    "Permissions" : {
+      "properties" : {
+        "odata.type" : {
+          "type" : "string",
+          "description": "Microsoft.DirectoryServices.OAuth2PermissionGrant"
+        },
+        "clientId" : {
+          "type" : "string",
+          "description": "The objectId of the Service Principal associated with the app"
+        },
+        "consentType" : {
+          "type" : "string",
+          "description": "Typically set to AllPrincipals"
+        },
+        "principalId" : {
+          "type" : "object",
+          "description": "Set to null if AllPrincipals is set"
+        },
+        "resourceId" : {
+          "type" : "string",
+          "description" : "Service Principal Id of the resource you want to grant"
+        },
+        "scope" : {
+          "type" : "string",
+          "description": "Typically set to user_impersonation"
+        },
+        "startTime" : {
+          "type" : "string",
+          "description" : "Start time for TTL"
+        },
+        "expiryTime" : {
+          "type" : "string",
+          "description" : "Expiry time for TTL"
+        }
+      },
+      "example" : {
+        "odata.type" : "odata.type",
+        "resourceId" : "resourceId",
+        "clientId" : "clientId",
+        "scope" : "scope",
+        "expiryTime" : "expiryTime",
+        "consentType" : "consentType",
+        "principalId" : "",
+        "startTime" : "startTime"
+      }
     }
   },
   "parameters": {