Status200
Ресурс

Status Page SCIM

Manage SCIM auto-provisioning for your status page

Модель Status Page SCIM

Свойства

  • Имя
    _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 Project in which this object belongs

  • Имя
    statusPage
    Тип
    Status Page
    Описание

    Relation to Status Page Resource in which this object belongs

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

    ID of your Status Page resource where this object belongs

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

    Any friendly name for this SCIM configuration

  • Имя
    description
    Тип
    Long Text
    Описание

    Friendly description to help you remember

  • Имя
    bearerToken
    Тип
    Long TextОбязательно
    Описание

    Bearer token for SCIM authentication. Keep this secure.

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

    Automatically create status page users when they are added via SCIM

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

    Automatically remove status page users when they are removed via SCIM

  • Имя
    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)

GETorPOST/api/status-page-scim/get-list

Список

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

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

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

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

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

POST
/api/status-page-scim/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "bearerToken": true,
    "name": true,
    "projectId": true,
    "statusPageId": true,
    "_id": true
  },
  "query": {
    "bearerToken": "Example bearer token"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377d0360-28fe-11f1-b591-3fdcef396aba",
      "bearerToken": "Example bearer token",
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "statusPageId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "377d0361-28fe-11f1-b591-3fdcef396aba",
      "bearerToken": "Example bearer token",
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "statusPageId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "377d0362-28fe-11f1-b591-3fdcef396aba",
      "bearerToken": "Example bearer token",
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "statusPageId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}
GETorPOST/api/status-page-scim/:id/get-item

Получить по ID

Возвращает объект «Status Page SCIM» по идентификатору.

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

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

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

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

POST
/api/status-page-scim/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "bearerToken": true,
    "name": true,
    "projectId": true,
    "statusPageId": true,
    "_id": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "bearerToken": "Example bearer token",
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "statusPageId": "550e8400-e29b-41d4-a716-446655440000"
}
POST/api/status-page-scim/count

Количество

Возвращает количество ваших объектов «Status Page SCIM».

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

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

POST
/api/status-page-scim/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "bearerToken": "Example bearer token"
  }
}

Ответ

{
  "count": 107
}
POST/api/status-page-scim

Создать Status Page SCIM

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

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

POST
/api/status-page-scim
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "bearerToken": "Example bearer token",
    "name": "Example name",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "statusPageId": "550e8400-e29b-41d4-a716-446655440000",
    "autoDeprovisionUsers": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "bearerToken": "Example bearer token",
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "statusPageId": "550e8400-e29b-41d4-a716-446655440000"
}
PUT/api/status-page-scim/:id

Обновить по ID

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

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

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

POST/api/status-page-scim/:id/update-item
GET/api/status-page-scim/:id/update-item

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

PUT
/api/status-page-scim/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "bearerToken": "Example bearer token",
    "name": "Example name",
    "autoDeprovisionUsers": true
  }
}

Ответ

{}
DELETE/api/status-page-scim/:id

Удалить по ID

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

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

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

POST/api/status-page-scim/:id/delete-item
GET/api/status-page-scim/:id/delete-item

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

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

Ответ

{}

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

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

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

Нужны для чтения Status Page SCIM

  • Project Owner
  • Project Admin
  • Project Member
  • Read Status Page SSO
  • Read All Project Resources

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

Нужны для создания Status Page SCIM

  • Project Owner
  • Project Admin
  • Create Status Page SSO

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

Нужны для обновления Status Page SCIM

  • Project Owner
  • Project Admin
  • Edit Status Page SSO

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

Нужны для удаления Status Page SCIM

  • Project Owner
  • Project Admin
  • Delete Status Page SSO