Create a Google Pass template
Creates a Google Pass template based on the provided .zip
file. Refer to our Design a Google Pass template guide for more information on how to design the template and how to structure the .zip
file.
Analytic events
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_START
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_SUCCESS
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_CREATE_FAIL
Request Body schema: multipart/form-datarequired
Google Pass template created
Bad Request
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 201
- 400
{- "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
- "passType": "apple",
- "name": "Certificate of participation",
- "metadata": {
- "issuerId": "3388000000012346000",
- "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
- "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
}
}
Retrieve all Google Pass templates
Retrieves a list of all Google Pass templates available on your tenant.
Analytic events
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_START
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_SUCCESS
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_LIST_FAIL
Google Pass templates retrieved
Bad Request
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h",
- "data": [
- {
- "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
- "passType": "apple",
- "name": "Certificate of participation",
- "metadata": {
- "issuerId": "3388000000012346000",
- "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
- "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
}
}
]
}
Update a Google Pass template
Updates a existing Google Pass template by providing its ID and a .zip
file. Refer to our Design a Google Pass template guide for more information on how to design the template and how to structure the .zip
file.
Analytic events
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_START
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_SUCCESS
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_UPDATE_FAIL
Request Body schema: multipart/form-datarequired
Google Pass template updated
Bad Request
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
{- "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
- "passType": "apple",
- "name": "Certificate of participation",
- "metadata": {
- "issuerId": "3388000000012346000",
- "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
- "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
}
}
Retrieve a Google Pass template
Retrieves an existing Google Pass template by providing its ID.
Analytic events
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_START
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_SUCCESS
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_RETRIEVE_FAIL
Google Pass templated retrieved
Bad Request
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 200
- 400
- 404
{- "id": "3812166c-ac9f-4e4e-96dd-c1336b5be378",
- "passType": "apple",
- "name": "Certificate of participation",
- "metadata": {
- "issuerId": "3388000000012346000",
- "serviceAccountClientEmail": "app-user@myproject.iam.gserviceaccount.com",
- "payPassId": "3388000000012345678.a0bbe92f-c85e-4081-94c3-f842bcd5e463"
}
}
Delete a Google Pass template
Deletes an existing Google Pass template by providing its ID.
Analytic events
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_START
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_SUCCESS
- CREDENTIAL_COMPACT_GOOGLE_PASS_TEMPLATE_DELETE_FAIL
Google Pass template deleted
Bad Request
Not Found
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- 400
- 404
{- "code": "string",
- "message": "string",
- "details": [
- {
- "value": "string",
- "msg": "Invalid value",
- "param": "id",
- "location": "body"
}
]
}