Status Page SSO

Configure Status Page SSO

Permissions

Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.

Read Permissions

You need one of these permissions to read Status Page SSO:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectUser
    Type
    Project User
    Description

    User of this project.

  • Name
    Public
    Type
    Public
    Description

    Non registered user. Typically used for sign up or log in.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    CanReadStatusPageSSO
    Type
    Can Read Status Page SSO
    Description

    This permission can read Status Page SSO in this project.

Create Permissions

You need one of these permissions to create Status Page SSO:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    CanCreateStatusPageSSO
    Type
    Can Create Status Page SSO
    Description

    This permission can create Status Page SSO in this project.

Update Permissions

You need one of these permissions to update Status Page SSO:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    CanEditStatusPageSSO
    Type
    Can Edit Status Page SSO
    Description

    This permission can edit Status Page SSO in this project.

Delete Permissions

You need one of these permissions to delete Status Page SSO:

  • Name
    ProjectOwner
    Type
    Project Owner
    Description

    Owner of this project. Manages billing, inviting other admins to this project, and can delete this project.

  • Name
    ProjectAdmin
    Type
    Project Admin
    Description

    Admin of this project. Manages team members in this project, however cannot manage billing or delete this project.

  • Name
    CanDeleteStatusPageSSO
    Type
    Can Delete Status Page SSO
    Description

    This permission can delete Status Page SSO in this project.

The Status Page SSO model

Properties

  • Name
    _id
    Type
    Object ID
    Description

    ID of this object

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectUser or Public or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    createdAt
    Type
    Date
    Description

    Date and Time when the object was created.

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectUser or Public or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    updatedAt
    Type
    Date
    Description

    Date and Time when the object was updated.

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectUser or Public or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    project
    Type
    Entity
    Description

    Relation to Project Resource in which this object belongs

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectUser or Public or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
  • Name
    projectId
    Type
    Object ID (Required)
    Description

    ID of your OneUptime Project in which this object belongs

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectUser or Public or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
  • Name
    statusPage
    Type
    Entity
    Description

    Relation to Status Page Resource in which this object belongs

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
  • Name
    statusPageId
    Type
    Object ID (Required)
    Description

    ID of your Status Page resource where this object belongs

    Permissions to Create:  ProjectOwner or ProjectAdmin or ProjectMember or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectMember or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
  • Name
    name
    Type
    Text (Required)
    Description

    Any friendly name of this object

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectUser or Public or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    description
    Type
    Long Text (Required)
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectUser or Public or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    signatureMethod
    Type
    Text (Required)
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    digestMethod
    Type
    Text (Required)
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    signOnURL
    Type
    URL (Required)
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO or ProjectUser or Public
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    issuerURL
    Type
    URL (Required)
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    publicCertificate
    Type
    Very Long Text (Required)
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    createdByUser
    Type
    Entity
    Description

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

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
  • Name
    createdByUserId
    Type
    Object ID
    Description

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

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
  • Name
    isEnabled
    Type
    Boolean
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or ProjectUser or Public or CanReadStatusPageSSO
    Permissions to Update:  ProjectOwner or ProjectAdmin or CanEditStatusPageSSO
  • Name
    isTested
    Type
    Boolean
    Description

    Permissions to Create:  ProjectOwner or ProjectAdmin or CanCreateStatusPageSSO
    Permissions to Read:  ProjectOwner or ProjectAdmin or CanReadStatusPageSSO
    Permissions to Update:  This property cannot be updated.
GET or POST/api/status-page-sso/get-list

List

This endpoint allows you to retrieve a paginated list of all your Status Page SSO. By default, a maximum of ten Status Page SSO are shown per page.

Optional Query Params

  • Limit
    limit
    Type
    number
    Description

    Number of objects to fetch. By default 10, you can increase this count up to 100

  • Skip
    skip
    Type
    number
    Description

    Number of objects to skip. This can be useful in pagination

Optional Request Body

  • Query
    query
    Type
    query
    Description

    If you would like to filter on Status Page SSO. You can specify include a query here. For more information, please check out writing queries here.

  • Select
    select
    Type
    select
    Description

    By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

  • Sort
    sort
    Type
    sort
    Description

    Objects will be sorted based on created date by default. You can change the sort order by passing please check how to select here.

Example List Request

POST
/api/status-page-sso/get-list?skip=0&limit=10 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "select": {
        // select object  (optional, if left optional it'll only fetch ID). 
    },
    "query": {
        // query object (optional, if left optional it'll select everything)
    },
    "sort": {
        // sort object (optional)
    }
}

Example List Response

{
    "count": 10,
    "limit": 10,
    "skip": 0,
    "data": [
        {
            "_id": "p39d997a-026c-44b2-8b02-7b2814d886d2",
            // ...
        },
        {
            "_id": "l34e743e-1af5-4b0a-998f-1d421c22f7a1",
            // ...
        },
        {
            "_id": "6a5aa129-0b3e-45b7-a7f6-b4b6df338a19",
            // ...
        }
    ]
}
GET or POST/api/status-page-sso/:id/get-item

Get item by ID

This endpoint allows you to retrieve Status Page SSO by ID.

Required Query Params

  • ID
    id
    Type
    text
    Description

    ID of the Object

Optional Request Body

  • Select
    select
    Type
    select
    Description

    By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

Example Item Request

POST
/api/status-page-sso/3599ee69-43a7-42d7/get-item 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body: 

{
    "select": {
        // select object  (optional, if left optional it'll only fetch ID). 
    },
}

Example Item Response

{
    "_id": "3599ee69-43a7-42d7",
    // ... other object fields.
}
POST/api/status-page-sso/count

Count

This endpoint allows you to retrieve the count of all your Status Page SSO.

Optional Request Body

Example Count Request

POST
/api/status-page-sso/count 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "query": {
        // query object (optional, if left optional it'll select everything)
    },
}

Example Count Response

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

Create Status Page SSO

This endpoint allows you to create a new object.

Request Body

  • Data
    data
    Type
    JSON
    Description

    Object to update as JSON

Example Create Request

POST
/api/status-page-sso 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "data": {
        // properties to update as JSON.
    }
}

Example Create Response

{
    "_id": "xxx-xxx-xxxx-xxxx",
    // other object fields.
}
PUT/api/status-page-sso/:id

Update by ID

This endpoint allows you to update object by its ID.

Request Body

  • Data
    data
    Type
    JSON
    Description

    Object to update as JSON

Example Update Request

PUT
/api/status-page-sso/3599ee69-43a7-42d7 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Request Body:

{
    "data": {
        // properties to update as JSON.
    }
}

Example Update Response

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

Delete by ID

This endpoint allows you to delete object by its ID.

Example Delete Request

DELETE
/api/status-page-sso/3599ee69-43a7-42d7 
Request Headers: 

ApiKey: {secret-api-key}
ProjectID: {project-id}

Example Delete Response

{}