Skip to main content
GET
Get settings

Authorizations

Authorization
string
header
required

JWT bearer token obtained via the OAuth2 client-credentials grant from the platform Authentication API. The token's scopes gate the endpoints it may call, and its audience names the Guardian instance. This is the standard way to authenticate to Guardian.

Response

Success response

mode
enum<string>
required

The operating mode of this instance. self_managed means you upload and manage your own Apple identity and certificates; sf_operated means Starfish operates the Apple Developer relationship and mounts the identity and certificates.

Available options:
self_managed,
sf_operated
merchant_identifier
string | null
Example:

"merchant.com.example"

display_name
string | null
Example:

"Example Store"

domain_association_content
string | null

The body of the domain-association file served at /.well-known/apple-developer-merchantid-domain-association.txt.

Example:

"7B227073704964223A2242463632..."

csr_common_name
string | null
Example:

"Example Store"

created_at
string<date-time> | null
Example:

"2026-02-01T09:00:00Z"

updated_at
string<date-time> | null
Example:

"2026-02-01T09:00:00Z"