Push Credentials API

Mobile push credential management API

List mobile push credentials

List mobile push credentials

SecuritybearerAuth
Request
query Parameters
filter[type]
string

type of mobile push credentials

Enum: "ios" "android"
Example: filter[type]=ios
filter[alias]
string

Unique mobile push credential alias

Example: filter[alias]=LucyCredential
page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

page[number]
integer >= 1
Default: 1

The page number to load

Responses
200

Mobile mobile push credentials

Response Schema: application/json
Array of objects (Successful response with details about a push credential)
object (PaginationMeta)
401

Unauthorized request

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/mobile_push_credentials
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "alias": "LucyCredential",
      • "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
      • "created_at": "2021-03-26T17:51:59.588408Z",
      • "id": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7",
      • "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
      • "record_type": "push_credential",
      • "server_key": "",
      • "type": "ios",
      • "updated_at": "2021-03-26T17:51:59.588408Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Creates a new mobile push credential
Creates a new mobile push credential


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Mobile push credential parameters that need to be sent in the request


One of:
alias
required
string
Alias to uniquely identify the credential


 
certificate
required
string
Certificate as received from APNs


 
private_key
required
string
Corresponding private key to the certificate as received from APNs


 
type
required
string
Type of mobile push credential. Should be ios here


 Value: "ios"  
Responses 
200
Mobile push credential created


Response Schema: application/json
object (PushCredential) 
 
alias
required
string
Alias to uniquely identify a credential


 
certificate
required
string
Apple certificate for sending push notifications. For iOS only


 
created_at
required
string <datetime> 
ISO 8601 timestamp when the room was created


 
id
required
string
Unique identifier of a push credential


 
private_key
required
string
Apple private key for a given certificate for sending push notifications. For iOS only


 
record_type
required
string
 
server_key
required
string
Google server key for sending push notifications. For Android only


 
type
required
string
Type of mobile push credential. Either ios or android


 
updated_at
required
string <datetime> 
ISO 8601 timestamp when the room was updated.


 
401
Unauthorized request


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
422
Unable to process request


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/mobile_push_credentials
Request samples 
application/json
{
  • "alias": "LucyIosCredential",
  • "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
  • "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
  • "type": "ios"
}
Response samples 
application/json
{
  • "data": {
    • "alias": "LucyCredential",
    • "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
    • "created_at": "2021-03-26T17:51:59.588408Z",
    • "id": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7",
    • "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
    • "record_type": "push_credential",
    • "server_key": "",
    • "type": "ios",
    • "updated_at": "2021-03-26T17:51:59.588408Z"
    }
}
Deletes a mobile push credential
Deletes a mobile push credential based on the given push_credential_id


SecuritybearerAuth 
Request 
path Parameters
push_credential_id
required
string <uuid> 
The unique identifier of a mobile push credential


 
 Example:  0ccc7b76-4df3-4bca-a05a-3da1ecc389f0
Responses 
204
The mobile push credential was deleted successfully


401
Unauthorized request


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
404
Resource not found


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
422
Unable to process request


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/mobile_push_credentials/{push_credential_id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    • {
      • "code": "string",
      • "detail": "string",
      • "meta": { },
      • "source": {
        • "parameter": "string",
        • "pointer": "/json/pointer"
        },
      • "title": "string"
      }
    ]
}
Retrieves a mobile push credential
Retrieves mobile push credential based on the given push_credential_id


SecuritybearerAuth 
Request 
path Parameters
push_credential_id
required
string <uuid> 
The unique identifier of a mobile push credential


 
 Example:  0ccc7b76-4df3-4bca-a05a-3da1ecc389f0
Responses 
200
Successful get mobile push credential response


Response Schema: application/json
object (PushCredential) 
 
alias
required
string
Alias to uniquely identify a credential


 
certificate
required
string
Apple certificate for sending push notifications. For iOS only


 
created_at
required
string <datetime> 
ISO 8601 timestamp when the room was created


 
id
required
string
Unique identifier of a push credential


 
private_key
required
string
Apple private key for a given certificate for sending push notifications. For iOS only


 
record_type
required
string
 
server_key
required
string
Google server key for sending push notifications. For Android only


 
type
required
string
Type of mobile push credential. Either ios or android


 
updated_at
required
string <datetime> 
ISO 8601 timestamp when the room was updated.


 
401
Unauthorized request


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
404
Resource not found


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
422
Unable to process request


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/mobile_push_credentials/{push_credential_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "alias": "LucyCredential",
    • "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
    • "created_at": "2021-03-26T17:51:59.588408Z",
    • "id": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7",
    • "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
    • "record_type": "push_credential",
    • "server_key": "",
    • "type": "ios",
    • "updated_at": "2021-03-26T17:51:59.588408Z"
    }
}