Glance Portal API - Masking (0.1)

Download OpenAPI specification:Download

API endpoints for masking

Page Masking

APIs for accessing and modifying page masking information.

Create masked pages

Create masked pages with roles for the group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Request Body schema: application/json
required
Array
maskPage
string

The URL must be an absolute URL and must use a secure HTTPS connection

roles
Array of integers

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
[
  • 0
]

Returns masked pages

Get masked pages with roles for the group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update masked pages

Update masked pages with roles in a group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Request Body schema: application/json
required
Array
id
required
integer
maskPage
string

The URL must be an absolute URL and must use a secure HTTPS connection

roles
Array of integers

Responses

Request samples

Content type
application/json
[]

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete masked pages

Delete masked pages with roles in a group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Request Body schema: application/json
required
Array
integer

Array of Masked Page IDs

Responses

Request samples

Content type
application/json
[
  • 100,
  • 200,
  • 300
]

Response samples

Content type
application/json
{
  • "status": "ok"
}

Element Masking

APIs for accessing and modifying content masking information.

Returns masked elements

Get the masked elements with roles for the group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a masked element

Update a masked element for the group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Request Body schema: application/json
required
id
integer
mask
string
roles
Array of integers

Responses

Request samples

Content type
application/json
{
  • "id": 123,
  • "mask": "#example",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Create masked elements

Create masked elements with roles for the group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
string

The site is either in the 'staging' or 'production' environment

Request Body schema: application/json
required
mask
string
roles
Array of integers

Responses

Request samples

Content type
application/json
{
  • "mask": "#example",
  • "roles": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

Delete masked elements

Delete masked elements in a group

Authorizations:
BearerAuth
path Parameters
groupId
required
integer

The group ID (Must be a positive unsigned integer)

site
required
any

The site is either in the 'staging' or 'production' environment

Request Body schema: application/json
required
Array
integer

Array of Masked Element IDs

Responses

Request samples

Content type
application/json
[
  • 100,
  • 200,
  • 300
]

Response samples

Content type
application/json
{
  • "status": "ok"
}