Azure Key Vault Providers API

The Providers API from Azure Key Vault — 4 operation(s) for providers.

GitHub OpenAPI

Operations 8

GET /{scope}/providers/Microsoft.Authorization/roleAssignments Role assignments list for scope #
GET /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Role assignments get #
PUT /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Role assignments create #
DELETE /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Role assignments delete #
GET /{scope}/providers/Microsoft.Authorization/roleDefinitions Role definitions list #
GET /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName} Role definitions get #
PUT /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName} Role definitions create or update #
DELETE /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName} Role definitions delete #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-key-vault:microsoft-azure-key-vault-providers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-azure-key-vault-providers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: KeyVaultClient Providers API
  version: '7.6'
  description: 'The Azure Key Vault Administration service client performs administrative operations

    including RBAC, BackupRestore, and settings management

    against the Azure Key Vault service.'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://vault.azure.net/.default
tags:
- name: Providers
paths:
  /{scope}/providers/Microsoft.Authorization/roleAssignments:
    get:
      operationId: RoleAssignments_ListForScope
      description: Gets role assignments for a scope.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role assignments.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: $filter
        in: query
        description: 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.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignmentListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Providers
      summary: Role assignments list for scope
      x-summary-source: derived
  /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}:
    get:
      operationId: RoleAssignments_Get
      description: Get the specified role assignment.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role assignment.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: roleAssignmentName
        in: path
        description: The name of the role assignment to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Providers
      summary: Role assignments get
      x-summary-source: derived
    put:
      operationId: RoleAssignments_Create
      description: Creates a role assignment.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role assignment to create.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: roleAssignmentName
        in: path
        description: The name of the role assignment to create. It can be any valid GUID.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleAssignmentCreateParameters'
        description: Parameters for the role assignment.
        required: true
      tags:
      - Providers
      summary: Role assignments create
      x-summary-source: derived
    delete:
      operationId: RoleAssignments_Delete
      description: Deletes a role assignment.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role assignment to delete.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: roleAssignmentName
        in: path
        description: The name of the role assignment to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Providers
      summary: Role assignments delete
      x-summary-source: derived
  /{scope}/providers/Microsoft.Authorization/roleDefinitions:
    get:
      operationId: RoleDefinitions_List
      description: Get all role definitions that are applicable at scope and above.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role definition.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: $filter
        in: query
        description: The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinitionListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - Providers
      summary: Role definitions list
      x-summary-source: derived
  /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}:
    get:
      operationId: RoleDefinitions_Get
      description: Get the specified role definition.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role definition to get. Managed HSM only supports '/'.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: roleDefinitionName
        in: path
        description: The name of the role definition to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinition'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Providers
      summary: Role definitions get
      x-summary-source: derived
    put:
      operationId: RoleDefinitions_CreateOrUpdate
      description: Creates or updates a custom role definition.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role definition to create or update. Managed HSM only supports '/'.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: roleDefinitionName
        in: path
        description: The name of the role definition to create or update. It can be any valid GUID.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinition'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleDefinitionCreateParameters'
        description: Parameters for the role definition.
        required: true
      tags:
      - Providers
      summary: Role definitions create or update
      x-summary-source: derived
    delete:
      operationId: RoleDefinitions_Delete
      description: Deletes a custom role definition.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: scope
        in: path
        description: The scope of the role definition to delete. Managed HSM only supports '/'.
        required: true
        x-ms-skip-url-encoding: true
        schema:
          type: string
      - name: roleDefinitionName
        in: path
        description: The name (GUID) of the role definition to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleDefinition'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyVaultError'
      tags:
      - Providers
      summary: Role definitions delete
      x-summary-source: derived
components:
  schemas:
    RoleAssignmentListResult:
      type: object
      description: Role assignment list operation result.
      properties:
        value:
          type: array
          description: Role assignment list.
          items:
            $ref: '#/components/schemas/RoleAssignment'
        nextLink:
          type: string
          description: The URL to use for getting the next set of results.
    Error:
      type:
      - object
      - 'null'
      properties:
        code:
          type: string
          description: The error code.
          readOnly: true
        message:
          type: string
          description: The error message.
          readOnly: true
        innererror:
          $ref: '#/components/schemas/Error'
          description: The key vault server error.
          readOnly: true
          x-ms-client-name: innerError
    KeyVaultError:
      type: object
      description: The key vault error exception.
      properties:
        error:
          $ref: '#/components/schemas/Error'
          description: The key vault server error.
          readOnly: true
    RoleAssignment:
      type: object
      description: Role Assignments
      properties:
        id:
          type: string
          description: The role assignment ID.
          readOnly: true
        name:
          type: string
          description: The role assignment name.
          readOnly: true
        type:
          type: string
          description: The role assignment type.
          readOnly: true
        properties:
          $ref: '#/components/schemas/RoleAssignmentPropertiesWithScope'
          description: Role assignment properties.
    RoleDefinition:
      type: object
      description: Role definition.
      properties:
        id:
          type: string
          description: The role definition ID.
          readOnly: true
        name:
          type: string
          description: The role definition name.
          readOnly: true
        type:
          $ref: '#/components/schemas/RoleDefinitionType'
          description: The role definition type.
          readOnly: true
        properties:
          $ref: '#/components/schemas/RoleDefinitionProperties'
          description: Role definition properties.
          x-ms-client-flatten: true
    RoleDefinitionListResult:
      type: object
      description: Role definition list operation result.
      properties:
        value:
          type: array
          description: Role definition list.
          items:
            $ref: '#/components/schemas/RoleDefinition'
        nextLink:
          type: string
          description: The URL to use for getting the next set of results.
    RoleDefinitionProperties:
      type: object
      description: Role definition properties.
      properties:
        roleName:
          type: string
          description: The role name.
        description:
          type: string
          description: The role definition description.
        type:
          $ref: '#/components/schemas/RoleType'
          description: The role type.
          x-ms-client-name: roleType
        permissions:
          type: array
          description: Role definition permissions.
          items:
            $ref: '#/components/schemas/Permission'
        assignableScopes:
          type: array
          description: Role definition assignable scopes.
          items:
            $ref: '#/components/schemas/RoleScope'
    RoleAssignmentProperties:
      type: object
      description: Role assignment properties.
      properties:
        roleDefinitionId:
          type: string
          description: The role definition ID used in the role assignment.
        principalId:
          type: string
          description: The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group.
      required:
      - roleDefinitionId
      - principalId
    Permission:
      type: object
      description: Role definition permissions.
      properties:
        actions:
          type: array
          description: Action permissions that are granted.
          items:
            type: string
        notActions:
          type: array
          description: Action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.
          items:
            type: string
        dataActions:
          type: array
          description: Data action permissions that are granted.
          items:
            $ref: '#/components/schemas/DataAction'
        notDataActions:
          type: array
          description: Data action permissions that are excluded but not denied. They may be granted by other role definitions assigned to a principal.
          items:
            $ref: '#/components/schemas/DataAction'
    RoleDefinitionType:
      type: string
      description: The role definition type.
      enum:
      - Microsoft.Authorization/roleDefinitions
      x-ms-enum:
        name: RoleDefinitionType
        modelAsString: true
        values:
        - name: Microsoft.Authorization/roleDefinitions
          value: Microsoft.Authorization/roleDefinitions
          description: Microsoft-defined role definitions.
    RoleType:
      type: string
      description: The role type.
      enum:
      - AKVBuiltInRole
      - CustomRole
      x-ms-enum:
        name: RoleType
        modelAsString: true
        values:
        - name: BuiltInRole
          value: AKVBuiltInRole
          description: Built in role.
        - name: CustomRole
          value: CustomRole
          description: Custom role.
    RoleAssignmentPropertiesWithScope:
      type: object
      description: Role assignment properties with scope.
      properties:
        scope:
          $ref: '#/components/schemas/RoleScope'
          description: The role scope.
        roleDefinitionId:
          type: string
          description: The role definition ID.
        principalId:
          type: string
          description: The principal ID.
    DataAction:
      type: string
      description: Supported permissions for data actions.
      enum:
      - Microsoft.KeyVault/managedHsm/keys/read/action
      - Microsoft.KeyVault/managedHsm/keys/write/action
      - Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action
      - Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action
      - Microsoft.KeyVault/managedHsm/keys/backup/action
      - Microsoft.KeyVault/managedHsm/keys/restore/action
      - Microsoft.KeyVault/managedHsm/roleAssignments/delete/action
      - Microsoft.KeyVault/managedHsm/roleAssignments/read/action
      - Microsoft.KeyVault/managedHsm/roleAssignments/write/action
      - Microsoft.KeyVault/managedHsm/roleDefinitions/read/action
      - Microsoft.KeyVault/managedHsm/roleDefinitions/write/action
      - Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action
      - Microsoft.KeyVault/managedHsm/keys/encrypt/action
      - Microsoft.KeyVault/managedHsm/keys/decrypt/action
      - Microsoft.KeyVault/managedHsm/keys/wrap/action
      - Microsoft.KeyVault/managedHsm/keys/unwrap/action
      - Microsoft.KeyVault/managedHsm/keys/sign/action
      - Microsoft.KeyVault/managedHsm/keys/verify/action
      - Microsoft.KeyVault/managedHsm/keys/create
      - Microsoft.KeyVault/managedHsm/keys/delete
      - Microsoft.KeyVault/managedHsm/keys/export/action
      - Microsoft.KeyVault/managedHsm/keys/release/action
      - Microsoft.KeyVault/managedHsm/keys/import/action
      - Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete
      - Microsoft.KeyVault/managedHsm/securitydomain/download/action
      - Microsoft.KeyVault/managedHsm/securitydomain/download/read
      - Microsoft.KeyVault/managedHsm/securitydomain/upload/action
      - Microsoft.KeyVault/managedHsm/securitydomain/upload/read
      - Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read
      - Microsoft.KeyVault/managedHsm/backup/start/action
      - Microsoft.KeyVault/managedHsm/restore/start/action
      - Microsoft.KeyVault/managedHsm/backup/status/action
      - Microsoft.KeyVault/managedHsm/restore/status/action
      - Microsoft.KeyVault/managedHsm/rng/action
      x-ms-enum:
        name: DataAction
        modelAsString: true
        values:
        - name: ReadHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/read/action
          description: Read HSM key metadata.
        - name: WriteHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/write/action
          description: Update an HSM key.
        - name: ReadDeletedHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action
          description: Read deleted HSM key.
        - name: RecoverDeletedHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action
          description: Recover deleted HSM key.
        - name: BackupHsmKeys
          value: Microsoft.KeyVault/managedHsm/keys/backup/action
          description: Backup HSM keys.
        - name: RestoreHsmKeys
          value: Microsoft.KeyVault/managedHsm/keys/restore/action
          description: Restore HSM keys.
        - name: DeleteRoleAssignment
          value: Microsoft.KeyVault/managedHsm/roleAssignments/delete/action
          description: Delete role assignment.
        - name: GetRoleAssignment
          value: Microsoft.KeyVault/managedHsm/roleAssignments/read/action
          description: Get role assignment.
        - name: WriteRoleAssignment
          value: Microsoft.KeyVault/managedHsm/roleAssignments/write/action
          description: Create or update role assignment.
        - name: ReadRoleDefinition
          value: Microsoft.KeyVault/managedHsm/roleDefinitions/read/action
          description: Get role definition.
        - name: WriteRoleDefinition
          value: Microsoft.KeyVault/managedHsm/roleDefinitions/write/action
          description: Create or update role definition.
        - name: DeleteRoleDefinition
          value: Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action
          description: Delete role definition.
        - name: EncryptHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/encrypt/action
          description: Encrypt using an HSM key.
        - name: DecryptHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/decrypt/action
          description: Decrypt using an HSM key.
        - name: WrapHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/wrap/action
          description: Wrap using an HSM key.
        - name: UnwrapHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/unwrap/action
          description: Unwrap using an HSM key.
        - name: SignHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/sign/action
          description: Sign using an HSM key.
        - name: VerifyHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/verify/action
          description: Verify using an HSM key.
        - name: CreateHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/create
          description: Create an HSM key.
        - name: DeleteHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/delete
          description: Delete an HSM key.
        - name: ExportHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/export/action
          description: Export an HSM key.
        - name: ReleaseKey
          value: Microsoft.KeyVault/managedHsm/keys/release/action
          description: Release an HSM key using Secure Key Release.
        - name: ImportHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/import/action
          description: Import an HSM key.
        - name: PurgeDeletedHsmKey
          value: Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete
          description: Purge a deleted HSM key.
        - name: DownloadHsmSecurityDomain
          value: Microsoft.KeyVault/managedHsm/securitydomain/download/action
          description: Download an HSM security domain.
        - name: DownloadHsmSecurityDomainStatus
          value: Microsoft.KeyVault/managedHsm/securitydomain/download/read
          description: Check status of HSM security domain download.
        - name: UploadHsmSecurityDomain
          value: Microsoft.KeyVault/managedHsm/securitydomain/upload/action
          description: Upload an HSM security domain.
        - name: ReadHsmSecurityDomainStatus
          value: Microsoft.KeyVault/managedHsm/securitydomain/upload/read
          description: Check the status of the HSM security domain exchange file.
        - name: ReadHsmSecurityDomainTransferKey
          value: Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read
          description: Download an HSM security domain transfer key.
        - name: StartHsmBackup
          value: Microsoft.KeyVault/managedHsm/backup/start/action
          description: Start an HSM backup.
        - name: StartHsmRestore
          value: Microsoft.KeyVault/managedHsm/restore/start/action
          description: Start an HSM restore.
        - name: ReadHsmBackupStatus
          value: Microsoft.KeyVault/managedHsm/backup/status/action
          description: Read an HSM backup status.
        - name: ReadHsmRestoreStatus
          value: Microsoft.KeyVault/managedHsm/restore/status/action
          description: Read an HSM restore status.
        - name: RandomNumbersGenerate
          value: Microsoft.KeyVault/managedHsm/rng/action
          description: Generate random numbers.
    RoleScope:
      type: string
      description: The role scope.
      enum:
      - /
      - /keys
      x-ms-enum:
        name: RoleScope
        modelAsString: true
        values:
        - name: Global
          value: /
          description: Global scope
        - name: Keys
          value: /keys
          description: Keys scope
    RoleDefinitionCreateParameters:
      type: object
      description: Role definition create parameters.
      properties:
        properties:
          $ref: '#/components/schemas/RoleDefinitionProperties'
          description: Role definition properties.
      required:
      - properties
    RoleAssignmentCreateParameters:
      type: object
      description: Role assignment create parameters.
      properties:
        properties:
          $ref: '#/components/schemas/RoleAssignmentProperties'
          description: Role assignment properties.
      required:
      - properties
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://vault.azure.net/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
  hostTemplate: '{vaultBaseUrl}'
  useSchemePrefix: false
  parameters:
  - name: vaultBaseUrl
    in: path
    description: The base URL of the Key Vault instance (e.g. https://myvault.vault.azure.net/)
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true
x-ms-paths:
  /restore/{jobId}/pending?_overload=selectiveKeyRestoreStatus:
    get:
      operationId: SelectiveKeyRestoreStatus
      description: Returns the status of the selective key restore operation
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: jobId
        in: path
        description: The Job Id returned part of the restore operation
        required: true
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/components/schemas/SelectiveKeyRestoreOperation'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/components/schemas/KeyVaultError'