Перейти к содержимому
Войти
Справочник API
Ресурс

API Key Custom Role

The custom roles an API key is given. The key holds every permission of the role except those with the Owned scope: a key owns nothing.

Модель API Key Custom Role

Свойства

  • Название
    _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.

  • Название
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

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

    ID of your OneUptime Project in which this object belongs

  • Название
    apiKey
    Тип
    API Key
    Описание

    The API key given the role.

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

    ID of the API key given the role.

  • Название
    customRole
    Тип
    Custom Role
    Описание

    The custom role given to the API key.

  • Название
    customRoleId
    Тип
    Object ID Обязательно
    Описание

    ID of the custom role given to the API key.

  • Название
    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)

GET или POST
/api/api-key-custom-role/get-list

Список

Эта конечная точка позволяет получить разбитый на страницы список всех ваших API Key Custom Role. По умолчанию на каждой странице отображается максимум десять API Key Custom Role.

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

  • Limit
    limit
    Тип
    number
    Описание
    Количество объектов для получения. По умолчанию 10, вы можете увеличить это значение до 100
  • Skip
    skip
    Тип
    number
    Описание
    Количество объектов для пропуска. Это может быть полезно при пагинации

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

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

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

Ответ

{
    "count": 10,
    "limit": 10,
    "skip": 0,
    "data": [
        {
            "_id": "ca5aa8ba-782d-4304-889d-386a65e07dc0",
            "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
            "customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
            "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
            "apiKey": "Production API Key",
            "createdByUser": "admin@company.com"
        },
        {
            "_id": "c688c628-06a0-401d-aa44-22d0e0a988db",
            "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
            "customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
            "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
            "apiKey": "Production API Key",
            "createdByUser": "admin@company.com"
        },
        {
            "_id": "005b200c-002c-4055-8ae1-25961b146c20",
            "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
            "customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
            "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
            "apiKey": "Production API Key",
            "createdByUser": "admin@company.com"
        }
    ]
}
GET или POST
/api/api-key-custom-role/:id/get-item

Получить элемент по ID

Эта конечная точка позволяет получить API Key Custom Role по ID.

Обязательные параметры запроса

  • ID
    id
    Тип
    text
    Описание
    ID объекта

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

Запрос получения элемента

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

Ответ

{
    "_id": "ca5aa8ba-782d-4304-889d-386a65e07dc0",
    "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
    "apiKey": "Production API Key",
    "createdByUser": "admin@company.com"
}
POST
/api/api-key-custom-role/count

Количество

Эта конечная точка позволяет получить количество всех ваших API Key Custom Role.

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

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

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

Ответ

{
    "count": 107
}
POST
/api/api-key-custom-role

Создать API Key Custom Role

Эта конечная точка позволяет создать новый объект.

Тело запроса

  • Data
    data
    Тип
    JSON
    Описание
    Объект для создания в формате JSON

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

POST
/api/api-key-custom-role
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
    "apiKey": "Production API Key",
    "customRole": "Incident Responder"
  }
}

Ответ

{
    "_id": "ca5aa8ba-782d-4304-889d-386a65e07dc0",
    "apiKeyId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "customRoleId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "projectId": "a3f9c8e2-d4b6-4a7c-9e5f-1a2b3c4d5e6f",
    "apiKey": "Production API Key",
    "createdByUser": "admin@company.com"
}
PUT
/api/api-key-custom-role/:id

Обновить по ID

Эта конечная точка позволяет обновить объект по его ID.

Тело запроса

  • Data
    data
    Тип
    JSON
    Описание
    Объект для обновления в формате JSON

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

Для клиентов, которые не поддерживают запросы PUT, вы можете использовать POST или GET с теми же заголовками запроса и телом:

POST /api/api-key-custom-role/:id/update-item

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

PUT
/api/api-key-custom-role/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {}
}

Ответ

{}
DELETE
/api/api-key-custom-role/:id

Удалить по ID

Эта конечная точка позволяет удалить объект по его ID.

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

Для клиентов, которые не поддерживают запросы DELETE, вы можете использовать POST или GET с теми же заголовками запроса и телом:

POST /api/api-key-custom-role/:id/delete-item

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

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

Ответ

{}

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

Вашему API-токену нужны права доступа для создания, обновления, чтения или удаления этого ресурса. Если у вас нет прав на выполнение запроса, в качестве ответа будет отправлен статус 4xx.

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

Требуется для чтения API Key Custom Role

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • ReadProjectApiKey
    Read API Key
    This permission can read api keys of this project.

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

Требуется для создания API Key Custom Role

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • EditProjectApiKeyPermissions
    Edit API Key Permissions
    This permission can edit api key permissions of this project.

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

Требуется для обновления API Key Custom Role

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • EditProjectApiKeyPermissions
    Edit API Key Permissions
    This permission can edit api key permissions of this project.

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

Требуется для удаления API Key Custom Role

  • ProjectOwner
    Project Owner
    Owner of this project. Does everything Project Admin does, and also manages billing and payment methods, sets up SCIM, and can delete the project.
  • ProjectAdmin
    Project Admin
    Admin of this project. Creates, changes and deletes everything in it, including team members and their permissions, API keys, labels, SSO, rules and custom fields, and reads the audit log. Cannot manage billing, set up SCIM or delete the project.
  • DeleteProjectApiKey
    Delete API Key
    This permission can delete api keys of this project.
  • EditProjectApiKeyPermissions
    Edit API Key Permissions
    This permission can edit api key permissions of this project.