Listing the custom configurations of a domain¶

Note

The response is not paginated. It returns every entry of the requested scope.

Note

The result is limited to the entries that Myra has released for the customer. Entries kept internal are not part of the response.

Sends a GET request to the endpoint /domain/{domainId}/custom-configurations.

Description¶

The List-Custom-Configurations request allows the user to request the custom configurations that Myra has applied for a domain of the organisation.

A custom configuration documents a non-standard setting that Myra Security has applied on request. Entries exist on two levels: a domain-level entry describes the whole domain, a subdomain-level entry describes a single subdomain. Both levels are requested through this endpoint, the query parameter subDomainName selects which one.

Requirements¶

Values of the request: Domain-ID {domainId}

Objects: none

Request¶

To request the custom configurations of a domain, the Domain-ID {domainId} needs to be added to the path of the request.

The following optional query parameter is available:

Parameters	Description	Values
`subDomainName`	Returns the entries of this subdomain instead of the entries of the domain. Without it, the request returns the domain-level entries only.	`string`

As a result, the user gets one or more objects CustomConfigurationVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`type`	The kind of setting the entry describes. In the Myra App, the attribute has the Type label.	`feature` `header` `ssl_cipher`
`name`	The name of the setting. In the Myra App, the attribute has the Name label.	`string`
`value`	The value of the setting. Free text, the accepted content depends on the type. In the Myra App, the attribute has the Value label.	`string`
`description`	An explanation of why the setting was applied. In the Myra App, the attribute has the Description label.	`string`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "type": "string",
    "name": "string",
    "value": "string",
    "description": "string",
    "id": 0,
    "modified": "string",
    "created": "string"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.