Add a new EFRP payload configuration to an existing profile

Create Android Enterprise Factory Reset Protection configuration payload

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

efrp_detailsJSON ArrayMandatory

List of Google accounts authorized to bypass Factory Reset Protection after a device reset

Show Sub-Attributes

JSON Object

Show Sub-Attributes

email_idstringOptional

Google account email address authorized to bypass Factory Reset Protection after a device reset

email_user_idstringOptional

20-30 digit numeric Google account user ID associated with the authorized email

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"efrp_details":[{"email_id":"admin@zylker.com","email_user_id":"123456789012345678901"}]}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"efrp_details\":[{\"email_id\":\"admin@zylker.com\",\"email_user_id\":\"123456789012345678901\"}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"efrp_details\":[{\"email_id\":\"admin@zylker.com\",\"email_user_id\":\"123456789012345678901\"}]}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data_efrp_details=List();
    data_efrp_details_item1=Map();
    data_efrp_details_item1.put("email_id","value");
    data_efrp_details_item1.put("email_user_id","value");
    data_efrp_details.add(data_efrp_details_item1);
    data.put("efrp_details",data_efrp_details);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"efrp_details":[{"email_id":"admin@zylker.com","email_user_id":"123456789012345678901"}]}'

Sample Request Body

Add EFRP payload to the profile

Copied!

  {
    "efrp_details": [
      {
        "email_id": "admin@zylker.com",
        "email_user_id": "123456789012345678901"
      }
    ]
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

efrp_detailsJSON Array

List of Google accounts authorized to bypass Factory Reset Protection after a device reset

Show Sub-Attributes

JSON Object

Show Sub-Attributes

email_idstring

Google account email address authorized to bypass Factory Reset Protection after a device reset

email_user_idstring

20-30 digit numeric Google account user ID associated with the authorized email

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

EFRP payload successfully added

Copied!

  {
    "efrp_details": [
      {
        "email_id": "admin@zylker.com",
        "email_user_id": "123456789012345678901"
      }
    ],
    "payload_id": 9007199254741000
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.