Skip to main content

MobileFlashPassAPIApi

MethodHTTP requestDescription
cancel_mobile_flash_pass_bulk_operationDELETE /api/web/v1/mobileFlashPass/cancel/{id}Cancel mobile flash pass bulk operation
download_apple_mobile_flash_passGET /api/web/v1/mobileFlashPass/downloads/apple/{enrollmentId}/{claimToken}Download Apple Wallet mobile flash pass.
download_google_mobile_flash_passGET /api/web/v1/mobileFlashPass/downloads/google/{enrollmentId}/{claimToken}Download Google Wallet mobile flash pass.
download_mfp_bulk_operation_logsGET /api/web/v1/mobileFlashPass/download/logs/{id}Download mobile flash pass bulk operation logs
download_mfp_logs_v2GET /api/web/v2/mobileFlashPass/download/logs/{id}Download mobile flash pass logs V2
get_flash_pass_download_uriGET /api/web/v1/mobileFlashPass/downloadUri/{walletType}/{enrollmentId}Get mobile flash pass download URI
get_issue_mfp_bulk_operation_detailsGET /api/web/v1/mobileFlashPassGet all issued bulk mobile flash pass request(s)
get_mobile_flash_pass_request_detailsGET /api/web/v1/mobileFlashPass/{id}Get mobile flash pass request details
issue_mobile_flash_pass_bulk_operationPOST /api/web/v1/mobileFlashPassCreate bulk mobile flash pass request (Deprecated)
issue_mobile_flash_pass_bulk_operation_v2POST /api/web/v2/mobileFlashPassCreate bulk mobile flash pass request V2

cancel_mobile_flash_pass_bulk_operation​

cancel_mobile_flash_pass_bulk_operation(id)

Cancel mobile flash pass bulk operation

Cancel mobile flash pass bulk operation. Caller requires the issuance remove permission to access this resource.

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe bulk operation ID

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

download_apple_mobile_flash_pass​

bytearray download_apple_mobile_flash_pass(enrollment_id, claim_token)

Download Apple Wallet mobile flash pass.

Downloads a single Apple Wallet mobile flash pass. Caller requires the ISSUANCE:VIEW permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_idstrThe unique enrollment ID obtained from Read Enrollments request.
claim_tokenstrThe Apple Wallet random claim token.

Return type​

bytearray

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/vnd.apple.pkpass, application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

download_google_mobile_flash_pass​

str download_google_mobile_flash_pass(enrollment_id, claim_token)

Download Google Wallet mobile flash pass.

Returns a single Google Wallet mobile flash pass URL for download. Caller requires the ISSUANCE:VIEW permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_idstrThe unique enrollment ID obtained from Read Enrollments request.
claim_tokenstrThe Google Wallet random claim token.

Return type​

str

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

download_mfp_bulk_operation_logs​

download_mfp_bulk_operation_logs(id)

Download mobile flash pass bulk operation logs

Download logs for mobile flash pass bulk operation. Caller requires the issuance view permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe bulk operation ID

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

download_mfp_logs_v2​

bytearray download_mfp_logs_v2(id)

Download mobile flash pass logs V2

Download logs for mobile flash pass. Produces a JSON file attachment. Caller requires the issuance view permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe bulk operation ID

Return type​

bytearray

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/octet-stream, application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

get_flash_pass_download_uri​

str get_flash_pass_download_uri(wallet_type, enrollment_id)

Get mobile flash pass download URI

Retrieves the Mobile Flash Pass download URI for the specified wallet and enrollment. Caller requires the ISSUANCE:VIEW permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
wallet_typestrThe wallet to retrieve the download URI for.
enrollment_idstrThe unique enrollment ID obtained from Read Enrollments request.

Return type​

str

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

get_issue_mfp_bulk_operation_details​

List[IssueMobileFlashPassBulkOperationDetails] get_issue_mfp_bulk_operation_details()

Get all issued bulk mobile flash pass request(s)

Get all issued bulk mobile flash pass request(s). Caller requires the issuance view permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

This endpoint does not need any parameter.

Return type​

List[IssueMobileFlashPassBulkOperationDetails]

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

get_mobile_flash_pass_request_details​

MobileFlashPassRequestDetails get_mobile_flash_pass_request_details(id)

Get mobile flash pass request details

Get mobile flash pass request details. Caller requires the issuance view permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
idstrThe mobile flash pass request id

Return type​

MobileFlashPassRequestDetails

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
403Forbidden-
404The specified resource was not found-
409Conflict-
500Unexpected error-

issue_mobile_flash_pass_bulk_operation​

IssueMobileFlashPassBulkOperationDetails issue_mobile_flash_pass_bulk_operation(enrollment_multi_flash_pass_api_request_v1)

Create bulk mobile flash pass request (Deprecated)

Create bulk mobile flash pass request. Caller requires the issuance add permission to access this resource.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_multi_flash_pass_api_request_v1EnrollmentMultiFlashPassApiRequestV1

Return type​

IssueMobileFlashPassBulkOperationDetails

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

issue_mobile_flash_pass_bulk_operation_v2​

IssueMobileFlashPassBulkOperationDetails issue_mobile_flash_pass_bulk_operation_v2(enrollment_multi_flash_pass_api_request_v2)

Create bulk mobile flash pass request V2

Create bulk mobile flash pass request. Caller requires the ISSUANCE:ADD permission to access this resource.

Note: Request body payload must not exceed 200 KB.

Example​

  • Api Key Authentication (AdminAPIAuthentication):

Parameters​

NameTypeDescriptionNotes
enrollment_multi_flash_pass_api_request_v2EnrollmentMultiFlashPassApiRequestV2

Return type​

IssueMobileFlashPassBulkOperationDetails

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-