Role Definitions - List Role Definitions

List role definitions.

GET {endpoint}/roleDefinitions?api-version=2020-12-01
GET {endpoint}/roleDefinitions?api-version=2020-12-01&isBuiltIn={isBuiltIn}&scope={scope}

URI Parameters

Name In Required Type Description
endpoint
path True

string

The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.

api-version
query True

string

The Synapse client API Version.

isBuiltIn
query

boolean

Is a Synapse Built-In Role or not.

scope
query

string

Scope of the Synapse Built-in Role.

Responses

Name Type Description
200 OK

SynapseRoleDefinition[]

Success response.

Media Types: "application/json", "text/json"

Other Status Codes

ErrorContract

Error response describing why the operation failed.

Media Types: "application/json", "text/json"

Examples

List role definitions

Sample Request

GET exampleWorkspace.dev.azuresynapse.net/roleDefinitions?api-version=2020-12-01

Sample Response

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Synapse role name 1",
    "isBuiltIn": true,
    "description": "Role description 1",
    "permissions": [
      {
        "actions": [
          "Action 1",
          "Action 2"
        ],
        "dataActions": [
          "Data Action 1",
          "Data Action 2"
        ],
        "notActions": [
          "Not Action 1",
          "Not Action 2"
        ],
        "notDataActions": [
          "Data Action 1",
          "Data Action 2"
        ]
      }
    ],
    "scopes": [
      "scope 1",
      "scope 2"
    ],
    "availabilityStatus": "AvailabilityStatusValue"
  },
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "Synapse role name 2",
    "isBuiltIn": true,
    "description": "Role description 2",
    "permissions": [
      {
        "actions": [
          "Action 1",
          "Action 2"
        ],
        "dataActions": [
          "Data Action 1",
          "Data Action 2"
        ],
        "notActions": [
          "Not Action 1",
          "Not Action 2"
        ],
        "notDataActions": [
          "Data Action 1",
          "Data Action 2"
        ]
      }
    ],
    "scopes": [
      "scope 1",
      "scope 2"
    ],
    "availabilityStatus": "AvailabilityStatusValue"
  }
]
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorContract

Error details.

ErrorResponse

Error Response

SynapseRbacPermission

Synapse role definition details

SynapseRoleDefinition

Synapse role definition details

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorContract

Error details.

Name Type Description
error

ErrorResponse

Error Response
The error details.

ErrorResponse

Error Response

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorResponse[]

The error details.

message

string

The error message.

target

string

The error target.

SynapseRbacPermission

Synapse role definition details

Name Type Description
actions

string[]

List of actions

dataActions

string[]

List of data actions

notActions

string[]

List of Not actions

notDataActions

string[]

List of Not data actions

SynapseRoleDefinition

Synapse role definition details

Name Type Description
availabilityStatus

string

Availability of the Synapse role

description

string

Description for the Synapse role

id

string

Role Definition ID

isBuiltIn

boolean

Is a built-in role or not

name

string

Name of the Synapse role

permissions

SynapseRbacPermission[]

Permissions for the Synapse role

scopes

string[]

Allowed scopes for the Synapse role