Edit

Share via

sensor: getDeploymentAccessKey

  • Article

Namespace: microsoft.graph.security

Get the deployment access key for Microsoft Defender for Identity that is required to install sensors associated with the workspace.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) SecurityIdentitiesSensors.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application SecurityIdentitiesSensors.ReadWrite.All Not available.

HTTP request

GET /security/identities/sensors/getDeploymentAccessKey

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this function returns a 200 OK response code and a microsoft.graph.security.deploymentAccessKeyType in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/security/identities/sensors/getDeploymentAccessKey

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": {
    "@odata.type": "microsoft.graph.security.deploymentAccessKeyType",
    "sensorDeploymentAccessKey": "<Deployment access key (Secret)>"
  }
}