roleAssignments.json

{
  "swagger": "2.0",
  "info": {
    "version": "2020-02-01-preview",
    "title": "AccessControlClient"
  },
  "x-ms-parameterized-host": {
    "hostTemplate": "{endpoint}",
    "useSchemePrefix": false,
    "parameters": [
      {
        "$ref": "#/parameters/Endpoint"
      }
    ]
  },
  "schemes": [
    "https"
  ],
  "paths": {
    "/rbac/roleAssignments": {
      "post": {
        "tags": [
          "RoleAssignments"
        ],
        "operationId": "CreateRoleAssignment",
        "description": "Create role assignment.",
        "x-ms-examples": {
          "Create role assignment": {
            "$ref": "./examples/RoleAssignments_CreateRoleAssignment.json"
          }
        },
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "createRoleAssignmentOptions",
            "in": "body",
            "required": true,
            "description": "Details of role id and object id.",
            "schema": {
              "$ref": "#/definitions/RoleAssignmentOptions"
            }
          },
          {
            "$ref": "#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Success response.",
            "schema": {
              "$ref": "#/definitions/RoleAssignmentDetails"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorContract"
            }
          }
        }
      },
      "get": {
        "tags": [
          "RoleAssignments"
        ],
        "operationId": "GetRoleAssignments",
        "description": "List role assignments.",
        "x-ms-examples": {
          "Get role assignment information": {
            "$ref": "./examples/RoleAssignments_ListRoleAssignments.json"
          }
        },
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "#/parameters/RoleIdParameterInQuery"
          },
          {
            "$ref": "#/parameters/PrincipalIdParameter"
          },
          {
            "$ref": "#/parameters/XMsContinuationToken"
          }
        ],
        "responses": {
          "200": {
            "description": "Success response.",
            "headers": {
              "x-ms-continuation": {
                "description": "If the number of role assignments to be listed exceeds the maxResults limit, a continuation token is returned in this response header.  When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the role assignments.",
                "type": "string"
              }
            },
            "schema": {
              "$ref": "#/definitions/RoleAssignmentDetailsList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorContract"
            }
          }
        }
      }
    },
    "/rbac/roleAssignments/{roleAssignmentId}": {
      "get": {
        "tags": [
          "RoleAssignments"
        ],
        "operationId": "GetRoleAssignmentById",
        "description": "Get role assignment by role assignment Id.",
        "x-ms-examples": {
          "Get role assignment information": {
            "$ref": "./examples/RoleAssignments_GetRoleAssignmentById.json"
          }
        },
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/RoleAssignmentIdParameter"
          },
          {
            "$ref": "#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Success response.",
            "schema": {
              "$ref": "#/definitions/RoleAssignmentDetails"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorContract"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "RoleAssignments"
        ],
        "operationId": "DeleteRoleAssignmentById",
        "description": "Delete role assignment by role assignment Id.",
        "x-ms-examples": {
          "Delete role assignment": {
            "$ref": "./examples/RoleAssignments_DeleteRoleAssignmentById.json"
          }
        },
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/RoleAssignmentIdParameter"
          },
          {
            "$ref": "#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Success response."
          },
          "204": {
            "description": "No Content."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorContract"
            }
          }
        }
      }
    },
    "/rbac/getMyAssignedRoles": {
      "post": {
        "tags": [
          "RoleAssignments"
        ],
        "operationId": "GetCallerRoleAssignments",
        "description": "List role assignments of the caller.",
        "x-ms-examples": {
          "Get caller role assignments": {
            "$ref": "./examples/RoleAssignments_ListCallerRoleAssignments.json"
          }
        },
        "consumes": [],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Success response.",
            "schema": {
              "type": "array",
              "items": {
                "description": "Role ID of the Synapse Built-In Role",
                "type": "string"
              }
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/ErrorContract"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "ErrorContract": {
      "title": "Error details.",
      "description": "Contains details when the response code indicates an error.",
      "type": "object",
      "properties": {
        "error": {
          "description": "The error details.",
          "$ref": "#/definitions/ErrorResponse"
        }
      }
    },
    "ErrorResponse": {
      "required": [
        "code",
        "message"
      ],
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "target": {
          "type": "string"
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ErrorDetail"
          }
        }
      }
    },
    "ErrorDetail": {
      "required": [
        "code",
        "message"
      ],
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "target": {
          "type": "string"
        }
      }
    },
    "RoleAssignmentDetailsList": {
      "description": "A list of role assignments",
      "type": "array",
      "items": {
        "$ref": "#/definitions/RoleAssignmentDetails"
      }
    },
    "RoleAssignmentOptions": {
      "description": "Role Assignment request details",
      "type": "object",
      "properties": {
        "roleId": {
          "description": "Role ID of the Synapse Built-In Role",
          "type": "string"
        },
        "principalId": {
          "description": "Object ID of the AAD principal or security-group",
          "type": "string"
        }
      },
      "required": [
        "roleId",
        "principalId"
      ]
    },
    "RoleAssignmentDetails": {
      "description": "Role Assignment response details",
      "type": "object",
      "properties": {
        "id": {
          "description": "Role Assignment ID",
          "type": "string"
        },
        "roleId": {
          "description": "Role ID of the Synapse Built-In Role",
          "type": "string"
        },
        "principalId": {
          "description": "Object ID of the AAD principal or security-group",
          "type": "string"
        }
      }
    }
  },
  "parameters": {
    "Endpoint": {
      "name": "endpoint",
      "description": "The workspace development endpoint, for example `https://myworkspace.dev.azuresynapse.net`.",
      "required": true,
      "type": "string",
      "in": "path",
      "x-ms-skip-url-encoding": true,
      "x-ms-parameter-location": "client"
    },
    "ApiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "required": true,
      "type": "string",
      "description": "The Synapse client API Version."
    },
    "RoleIdParameterInQuery": {
      "name": "roleId",
      "in": "query",
      "required": false,
      "type": "string",
      "description": "Synapse Built-In Role Id.",
      "x-ms-parameter-location": "method"
    },
    "PrincipalIdParameter": {
      "name": "principalId",
      "in": "query",
      "required": false,
      "type": "string",
      "description": "Object ID of the AAD principal or security-group.",
      "x-ms-parameter-location": "method"
    },
    "RoleAssignmentIdParameter": {
      "name": "roleAssignmentId",
      "in": "path",
      "required": true,
      "type": "string",
      "description": "The ID of the role assignment.",
      "minLength": 1,
      "x-ms-parameter-location": "method"
    },
    "XMsContinuationToken": {
      "name": "x-ms-continuation",
      "x-ms-client-name": "continuationToken",
      "in": "header",
      "required": false,
      "type": "string",
      "description": "Continuation token.",
      "x-ms-parameter-location": "method"
    }
  }
}