List native apps
GET/v1/native-apps
Parameters
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
Responses
200NativeAppList400401403404409412413415422428429503
API reference
Native apps
Registration of SDK apps and device keys.
Register a native app
POST/v1/native-apps
Registers a native application of the tenant. One active registration per platform and app identifier.
Request bodyNativeAppCreate
| Field | Type | Required |
|---|---|---|
platform | enum: ios, android | yes |
app_identifier | string | yes |
apple_team_id | string | no |
signing_certificate_sha256 | array of string | no |
app_attest_environment | enum: production, development | no |
minimum_version | string | yes |
revoked_versions | array of string | yes |
attestation | enum: required, optional | yes |
Responses
201NativeApp400401403404409412413415422428429503
Update a native app
PATCH/v1/native-apps/{native_app_id}
Changes the allowed versions and the attestation requirement; applies to every later use of the app keys.
Parameters
| Field | Type | Required |
|---|---|---|
native_app_idpath | string (uuid) | yes |
Request bodyNativeAppUpdate
| Field | Type | Required |
|---|---|---|
minimum_version | string | yes |
revoked_versions | array of string | yes |
attestation | enum: required, optional | yes |
Responses
200NativeApp400401403404409412413415422428429503
Revoke a native app
POST/v1/native-apps/{native_app_id}/revoke
Revokes the application: its keys are no longer accepted and new keys are not registered. Irreversible.
Parameters
| Field | Type | Required |
|---|---|---|
native_app_idpath | string (uuid) | yes |
Responses
200NativeApp400401403404409412413415422428429503
Revoke an app key
POST/v1/app-keys/{app_key_id}/revoke
Revokes one app instance key (for example a compromised device): transcripts signed with it are no longer accepted.
Parameters
| Field | Type | Required |
|---|---|---|
app_key_idpath | string (uuid) | yes |
Responses
200AppKey400401403404409412413415422428429503