Retrieve the full configuration details of a EFRP payload item

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get Android Enterprise Factory Reset Protect policy payload

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

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

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidefrppolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the 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

Full configuration details of EFRP payload item

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

Duration: 1 minute | Threshold: 120 | 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.