Status200
Ресурс

API Key Permission

Permissions for your API Keys

Модель API Key Permission

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    apiKey
    Тип
    API Key
    Описание

    Relation to API Key resource in which this object belongs

  • Имя
    apiKeyId
    Тип
    Object IDОбязательно
    Описание

    ID of API Key resource in which this object belongs

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    permission
    Тип
    PermissionОбязательно
    Описание

    Permission. You can find list of permissions on the Permissions page.

  • Имя
    labels
    Тип
    Label
    Описание

    Relation to Labels Array where this permission is scoped at.

  • Имя
    isBlockPermission
    Тип
    Boolean
    Описание

GETorPOST/api/api-key-permission/get-list

Список

Этот метод возвращает постраничный список ваших объектов «API Key Permission». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/api-key-permission/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "apiKeyId": true,
    "permission": true,
    "projectId": true,
    "apiKey": true,
    "createdByUser": true
  },
  "query": {},
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376a65c0-28fe-11f1-b591-3fdcef396aba",
      "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
      "permission": "ProjectOwner",
      "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
      "apiKey": "Production API Key",
      "createdByUser": "admin@company.com"
    },
    {
      "_id": "376a65c1-28fe-11f1-b591-3fdcef396aba",
      "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
      "permission": "ProjectOwner",
      "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
      "apiKey": "Production API Key",
      "createdByUser": "admin@company.com"
    },
    {
      "_id": "376a65c2-28fe-11f1-b591-3fdcef396aba",
      "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
      "permission": "ProjectOwner",
      "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
      "apiKey": "Production API Key",
      "createdByUser": "admin@company.com"
    }
  ]
}
GETorPOST/api/api-key-permission/:id/get-item

Получить по ID

Возвращает объект «API Key Permission» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/api-key-permission/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "apiKeyId": true,
    "permission": true,
    "projectId": true,
    "apiKey": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "376a65c0-28fe-11f1-b591-3fdcef396aba",
  "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
  "permission": "ProjectOwner",
  "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
  "apiKey": "Production API Key",
  "createdByUser": "admin@company.com"
}
POST/api/api-key-permission/count

Количество

Возвращает количество ваших объектов «API Key Permission».

Необязательное тело запроса

Запрос количества

POST
/api/api-key-permission/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {}
}

Ответ

{
  "count": 107
}
POST/api/api-key-permission

Создать API Key Permission

Создаёт новый объект.

Запрос создания

POST
/api/api-key-permission
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "permission": "ProjectOwner",
    "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
    "apiKey": "Production API Key",
    "createdByUser": "admin@company.com"
  }
}

Ответ

{
  "_id": "376a65c0-28fe-11f1-b591-3fdcef396aba",
  "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
  "permission": "ProjectOwner",
  "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
  "apiKey": "Production API Key",
  "createdByUser": "admin@company.com"
}
PUT/api/api-key-permission/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/api-key-permission/:id/update-item
GET/api/api-key-permission/:id/update-item

Запрос обновления

PUT
/api/api-key-permission/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "permission": "ProjectOwner",
    "apiKey": "Production API Key",
    "isBlockPermission": false
  }
}

Ответ

{}
DELETE/api/api-key-permission/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/api-key-permission/:id/delete-item
GET/api/api-key-permission/:id/delete-item

Запрос удаления

DELETE
/api/api-key-permission/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения API Key Permission

  • Project Owner
  • Project Admin
  • Read API Key
  • Read All Project Resources

Права на создание

Нужны для создания API Key Permission

  • Project Owner
  • Project Admin
  • Create API Key
  • Edit API Key Permissions

Права на обновление

Нужны для обновления API Key Permission

  • Project Owner
  • Project Admin
  • Edit API Key Permissions
  • Edit API Key

Права на удаление

Нужны для удаления API Key Permission

  • Project Owner
  • Project Admin
  • Delete API Key
  • Edit API Key Permissions