PortalAssignedRoleResponse

object

An assigned role associates a service and an action to a team.

idstring(uuid)required

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestringrequired

Example:API Viewer

entity_idstring(uuid)required

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestringrequired

Example:Services

entity_regionstringrequired

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Example

ListDomains

object
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

EmailDeliveryUpdatePayload

object
* Additional properties are NOT allowed.
enabledboolean
from_emailstring(email)
reply_to_emailstring(email)
Example

EmailDelivery

object
* Additional properties are NOT allowed.
enabledbooleanrequired
from_emailstring(email)required
reply_to_emailstring(email)required
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

PatchPortalEmailConfig

object
* Additional properties are NOT allowed.
domain_namestring

The domain name to use for sending emails. Null means default.

from_namestring

The name to display in the ‘From’ field of emails.

from_emailstring(email)

The email address to use in the ‘From’ field.

reply_to_emailstring(email)

The email address to use in the ‘Reply-To’ field. If set to null, ‘Reply-To’ header is omitted.

Example