SHshorebird
app-store-connect

Set the organization's App Store Connect key.

Stores an App Store Connect team API key for the organization, replacing any it had. Create the key in App Store Connect under Users and Access, Integrations, Team Keys, with the narrowest role the integration needs.

The key is checked with App Store Connect first, by listing one of the team's apps, and stored only if Apple accepts it. The private key is encrypted before it is stored and is never returned.

Requires the storeCredentials.update permission, which only the admin and owner roles hold. Personal access tokens and federated (OIDC-exchanged) tokens are refused whatever their role: sign in to the console instead.

put/organizations/{organizationId}/app-store-connect-credential

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

issuer_idstring uuid required

The issuer id App Store Connect shows above its team keys.

key_idstring required

The key id App Store Connect shows beside the key.

private_keystring required

The contents of the .p8 file App Store Connect downloaded: a PEM P-256 private key beginning -----BEGIN PRIVATE KEY-----.

Response

The organization's key, replacing any it had.

idinteger required

The credential's ID.

organization_idinteger required

The organization the key belongs to.

issuer_idstring uuid required

The App Store Connect issuer id, in lowercase.

key_idstring required

The App Store Connect key id.

uploaded_by_user_idinteger nullable required

The person who last uploaded the key, while they still exist.

created_atstring date-time required

When the organization first gave Shorebird a key.

updated_atstring date-time required

When the key was last uploaded.

rejected_atstring date-time nullable required

When Apple refused the key, if it has since it was uploaded. App Store statuses stop updating until a new key is uploaded.

rejection'unauthorized' | 'forbidden' | 'null' nullable required

How Apple refused the key: unauthorized when it no longer accepts the key at all, forbidden when the key's role may not read the team's builds.

Changes

No recorded changes to this operation across all 1 revision of this API.