ENЗапросить демонстрацию

Справочник API

Нативные приложения

Регистрация приложений с SDK и ключей устройств.

Нативные приложения

GET/v1/native-apps

Области доступа
apps:read

Параметры

ПолеТипОбязательно
cursorзапросstringнет
limitзапросintegerнет

Ответы

  • 200NativeAppList
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Зарегистрировать приложение

POST/v1/native-apps

Области доступа
apps:write
Обязательный заголовок
Idempotency-Key

Registers a native application of the tenant. One active registration per platform and app identifier.

Тело запросаNativeAppCreate

ПолеТипОбязательно
platformenum: ios, androidда
app_identifierstringда
apple_team_idstringнет
signing_certificate_sha256array of stringнет
app_attest_environmentenum: production, developmentнет
minimum_versionstringда
revoked_versionsarray of stringда
attestationenum: required, optionalда

Ответы

  • 201NativeApp
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Изменить приложение

PATCH/v1/native-apps/{native_app_id}

Области доступа
apps:write
Обязательный заголовок
Idempotency-Key
Обязательный заголовок
If-Match

Changes the allowed versions and the attestation requirement; applies to every later use of the app keys.

Параметры

ПолеТипОбязательно
native_app_idпутьstring (uuid)да

Тело запросаNativeAppUpdate

ПолеТипОбязательно
minimum_versionstringда
revoked_versionsarray of stringда
attestationenum: required, optionalда

Ответы

  • 200NativeApp
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Отозвать приложение

POST/v1/native-apps/{native_app_id}/revoke

Области доступа
apps:write
Обязательный заголовок
Idempotency-Key

Revokes the application: its keys are no longer accepted and new keys are not registered. Irreversible.

Параметры

ПолеТипОбязательно
native_app_idпутьstring (uuid)да

Ответы

  • 200NativeApp
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503

Отозвать ключ устройства

POST/v1/app-keys/{app_key_id}/revoke

Области доступа
apps:write
Обязательный заголовок
Idempotency-Key

Revokes one app instance key (for example a compromised device): transcripts signed with it are no longer accepted.

Параметры

ПолеТипОбязательно
app_key_idпутьstring (uuid)да

Ответы

  • 200AppKey
  • 400
  • 401
  • 403
  • 404
  • 409
  • 412
  • 413
  • 415
  • 422
  • 428
  • 429
  • 503