Role Assignments - List For Scope

Reference

Service:: Key Vault

API Version:: 7.4

Gets role assignments for a scope.

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=7.4

With optional parameters:

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?$filter={$filter}&api-version=7.4

URI Parameters

Name	In	Required	Type	Description
scope	path	True	string	The scope of the role assignments.
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.
$filter	query		string	The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.

Responses

Name	Type	Description
200 OK	RoleAssignmentListResult	OK - Returns an array of role assignments.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

ListRoleAssignments

Sample request

HTTP

GET https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleAssignments?api-version=7.4

Sample response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
        "principalId": "principalId",
        "scope": "/keys"
      },
      "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId",
      "type": "Microsoft.Authorization/roleAssignments",
      "name": "roleAssignmentId"
    }
  ]
}

Definitions

Name	Description
Error	The key vault server error.
KeyVaultError	The key vault error exception.
RoleAssignment	Role Assignments
RoleAssignmentListResult	Role assignment list operation result.
RoleAssignmentPropertiesWithScope	Role assignment properties with scope.
RoleScope	The role scope.

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

RoleAssignment

Role Assignments

Name	Type	Description
id	string	The role assignment ID.
name	string	The role assignment name.
properties	RoleAssignmentPropertiesWithScope	Role assignment properties.
type	string	The role assignment type.

RoleAssignmentListResult

Role assignment list operation result.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	RoleAssignment[]	Role assignment list.

RoleAssignmentPropertiesWithScope

Role assignment properties with scope.

Name	Type	Description
principalId	string	The principal ID.
roleDefinitionId	string	The role definition ID.
scope	RoleScope	The role scope.

RoleScope

The role scope.

Name	Type	Description
/	string	Global scope
/keys	string	Keys scope

Share via