Sign in

v1

latestOpenAPI 3.0.02026-08-045822.7 KB
web-integrations

Create web integration

Creates a web integration.

post/api/v1/web-integrations

Request body

namestring required

The name of the web integration to create.

validOriginsstring[]

The origins that are allowed to make requests to the tenant.

Example request

{
  "name": "My Web Integration",
  "validOrigins": [
    "https://thirdPartyApp.com"
  ]
}

Response

Web integration created successfully.

idstring uid

The unique web integration identifier.

namestring

The name of the newly created web integration.

createdstring date-time

The time the web integration was created.

tenantIdstring uid

The tenant that the web integration belongs to.

createdBystring uid

The user that created the web integration.

lastUpdatedstring date-time

The time the web integration was last updated.

validOriginsstring[]

The origins that are allowed to make requests to the tenant.

Example response

{
  "name": "My Web Integration",
  "links": {
    "self": {
      "href": "http://mytenant.region.domain/api/v1/web-integrations/id"
    }
  },
  "validOrigins": [
    "https://thirdPartyApp.com"
  ]
}