Microsoft Azure

Azure Key Vault: Administration

The Azure Key Vault Administration service client performs administrative operations including RBAC, BackupRestore, and settings management against the Azure…

Identity & security#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Azure Key Vault Administration service client performs administrative operations
including RBAC, BackupRestore, and settings management
against the Azure Key Vault service.

Endpoints 18

  • GETRoleAssignments_ListForScope/:scope/providers/Microsoft.Authorization/roleAssignments?api-version=string&$filter=stringGets role assignments for a scope.
  • GETRoleAssignments_Get/:scope/providers/Microsoft.Authorization/roleAssignments/:roleAssignmentName?api-version=stringGet the specified role assignment.
  • PUTRoleAssignments_Create/:scope/providers/Microsoft.Authorization/roleAssignments/:roleAssignmentName?api-version=stringCreates a role assignment.
  • DELETERoleAssignments_Delete/:scope/providers/Microsoft.Authorization/roleAssignments/:roleAssignmentName?api-version=stringDeletes a role assignment.
  • GETRoleDefinitions_List/:scope/providers/Microsoft.Authorization/roleDefinitions?api-version=string&$filter=stringGet all role definitions that are applicable at scope and above.
  • GETRoleDefinitions_Get/:scope/providers/Microsoft.Authorization/roleDefinitions/:roleDefinitionName?api-version=stringGet the specified role definition.
  • PUTRoleDefinitions_CreateOrUpdate/:scope/providers/Microsoft.Authorization/roleDefinitions/:roleDefinitionName?api-version=stringCreates or updates a custom role definition.
  • DELETERoleDefinitions_Delete/:scope/providers/Microsoft.Authorization/roleDefinitions/:roleDefinitionName?api-version=stringDeletes a custom role definition.
  • POSTFullBackup/backup?api-version=stringCreates a full backup using a user-provided SAS token to an Azure blob storage container.
  • GETFullBackupStatus/backup/:jobId/pending?api-version=stringReturns the status of full backup operation
  • PUTSelectiveKeyRestoreOperation/keys/:keyName/restore?api-version=stringRestores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder
  • POSTPreFullBackup/prebackup?api-version=stringPre-backup operation for checking whether the customer can perform a full backup operation.
  • PUTPreFullRestoreOperation/prerestore?api-version=stringPre-restore operation for checking whether the customer can perform a full restore operation.
  • PUTFullRestoreOperation/restore?api-version=stringRestores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder
  • GETRestoreStatus/restore/:jobId/pending?api-version=stringReturns the status of restore operation
  • GETList account settings./settings?api-version=stringRetrieves a list of all the available account settings that can be configured.
  • GETGet specified account setting object./settings/:setting-name?api-version=stringRetrieves the setting object of a specified setting name.
  • PATCHUpdates key vault account setting, stores it, then returns the setting name and value to the client./settings/:setting-name?api-version=stringDescription of the pool setting to be updated

API details

Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
18 operations on 13 pathsGET 8PUT 5POST 2DELETE 2PATCH 1
Response formats
application/json
Description format
Swagger 2.0, API version 7.6

How to test the Azure Key Vault: Administration in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Key Vault: Administration collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “RoleAssignments_ListForScope” (GET /:scope/providers/Microsoft.Authorization/roleAssignments?api-version=string&$filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Key Vault: Administration?

The Azure Key Vault Administration service client performs administrative operations including RBAC, BackupRestore, and settings management against the Azure… It is listed under Identity & security and has 18 endpoints.

Who publishes the Azure Key Vault: Administration?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Key Vault: Administration?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Key Vault: Administration have?

18 operations on 13 paths (8 GET, 5 PUT, 2 POST, 2 DELETE, 1 PATCH).

Is forking the Azure Key Vault: Administration free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.