The domainExecute command executes domain–related administrative operations.
Table: domainExecute commands (SOAP administration) | Command | Description |
|---|
| DOMAINCMD_CREATE | Creates a domain entry in the organizational structure (see DOMAINCMD_CREATE). Not supported when using Active Directory as data store. |
| DOMAINCMD_DELETE | Deletes the specified domain (see DOMAINCMD_DELETE). Not supported when using Active Directory as data store. |
| DOMAINCMD_UPDATE | Updates the specified domain (see DOMAINCMD_UPDATE). Not supported when using Active Directory as data store. |
| DOMAINCMD_VIEW | Returns the settings for the specified domain (see DOMAINCMD_VIEW). |
Parameters
Table: domainExecute input parameters | Parameter name | Data type | Description |
|---|
| sessionID | String | Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)). |
| cmd | DomainCmdIDEnum | Required. The operation to be executed. See Table: domainExecute commands (SOAP administration). |
| attributeSet | DomainAttributeSet | Required. A set containing zero or more attribute fields. |
Table: domainExecute output parameters | Parameter name | Data type | Description |
|---|
| results | DomainResults | Required. Result structure containing return and status codes and a list of zero or more result attribute fields. |
The following field attributes are available for the operations of this command:
Table: domainExecute field attributes | Attribute name | Data type | Description |
|---|
| DOMAINFLD_CREATE_TIME | DateTime | The date and time the data record was created. |
| DOMAINFLD_DESCRIPTION | String | Up to 1024 characters. |
| DOMAINFLD_DOMAIN | String | The domain name. Trailing and leading spaces are removed when a new domain is created. Up to 255 characters. |
| DOMAINFLD_DOMAIN_ALT_SUFFIX | String | An alternative UPN domain suffix. This allows users to authenticate with their User Principal Name (UPN), even if it contains an alternative domain suffix. Up to 255 characters. |
| DOMAINFLD_MASTERDOMAIN | Boolean | Determines whether the specified domain is the master domain. |
| DOMAINFLD_MODIFY_TIME | DateTime | The date and time the data record was last modified. |
| DOMAINFLD_PN_DP_GATEWAY_ID | String | The unique ID to identify the DIGIPASS Gateway infrastructure. If specified, it takes precedence over any value specified in the global configuration. Up to 10 characters. |
| DOMAINFLD_PN_MOBILE_APP_NAME | String | The name of the mobile application in push notification messages. If specified as command parameter, it takes precedence over any value specified in the domain-level settings or the effective policy. Up to 64 characters. |
| DOMAINFLD_PN_SERVICE_API_KEY | String | The API key used to send push notifications via OneSpan DIGIPASS Gateway (cloud). If specified, it takes precedence over any value specified in the global configuration. Up to 64 characters. |
DOMAINCMD_CREATE
DOMAINCMD_CREATE creates a domain entry in the organizational structure.
Parameters
The following attributes can be specified in the attributeSet input parameter of this command:
Table: DOMAINCMD_CREATE (Supported input attributes) | Attribute name | Optionality |
|---|
| DOMAINFLD_DESCRIPTION | Optional |
| DOMAINFLD_DOMAIN | Mandatory |
| DOMAINFLD_DOMAIN_ALT_SUFFIX | Optional |
| DOMAINFLD_PN_DP_GATEWAY_ID | Optional |
| DOMAINFLD_PN_MOBILE_APP_NAME | Optional |
| DOMAINFLD_PN_SERVICE_API_KEY | Optional |
Any trailing and leading spaces are removed from DOMAINFLD_DOMAIN.
The following attributes will be specified in the results output parameter of this command:
Table: DOMAINCMD_CREATE (Supported output attributes) | Attribute name | Returned |
|---|
| DOMAINFLD_CREATE_TIME | Always |
| DOMAINFLD_DESCRIPTION | If defined |
| DOMAINFLD_DOMAIN | Always |
| DOMAINFLD_DOMAIN_ALT_SUFFIX | If defined |
| DOMAINFLD_MASTERDOMAIN | Always |
| DOMAINFLD_MODIFY_TIME | Always |
| DOMAINFLD_PN_DP_GATEWAY_ID | If defined |
| DOMAINFLD_PN_MOBILE_APP_NAME | If defined |
| DOMAINFLD_PN_SERVICE_API_KEY | If defined |
Requirements
Required administrative privileges:
DOMAINCMD_VIEW
DOMAINCMD_VIEW returns the settings for the specified domain.
Parameters
Only the DOMAINFLD_DOMAIN attribute can be specified in the domain attribute set input parameter of this command. This attribute is mandatory.
The following attributes will be specified in the results output parameter of this command:
Table: DOMAINCMD_VIEW (Supported output attributes) | Attribute name | Returned |
|---|
| DOMAINFLD_CREATE_TIME | Always |
| DOMAINFLD_DESCRIPTION | If defined |
| DOMAINFLD_DOMAIN | Always |
| DOMAINFLD_DOMAIN_ALT_SUFFIX | If defined |
| DOMAINFLD_MASTERDOMAIN | Always |
| DOMAINFLD_MODIFY_TIME | Always |
| DOMAINFLD_PN_DP_GATEWAY_ID | If defined |
| DOMAINFLD_PN_MOBILE_APP_NAME | If defined |
| DOMAINFLD_PN_SERVICE_API_KEY | If defined |
Requirements
Required administrative privileges:
DOMAINCMD_UPDATE
DOMAINCMD_UPDATE updates the specified domain.
Parameters
The following attributes can be specified in the attributeSet input parameter of this command:
Table: DOMAINCMD_UPDATE (Supported input attributes) | Attribute name | Optionality |
|---|
| DOMAINFLD_DESCRIPTION | Optional |
| DOMAINFLD_DOMAIN | Mandatory |
| DOMAINFLD_DOMAIN_ALT_SUFFIX | Optional |
| DOMAINFLD_PN_DP_GATEWAY_ID | Optional |
| DOMAINFLD_PN_MOBILE_APP_NAME | Optional |
| DOMAINFLD_PN_SERVICE_API_KEY | Optional |
The following attributes will be specified in the results output parameter of this command:
Table: DOMAINCMD_UPDATE (Supported output attributes) | Attribute name | Returned |
|---|
| DOMAINFLD_CREATE_TIME | Always |
| DOMAINFLD_DESCRIPTION | If defined |
| DOMAINFLD_DOMAIN | Always |
| DOMAINFLD_DOMAIN_ALT_SUFFIX | If defined |
| DOMAINFLD_MASTERDOMAIN | Always |
| DOMAINFLD_MODIFY_TIME | Always |
| DOMAINFLD_PN_DP_GATEWAY_ID | If defined |
| DOMAINFLD_PN_MOBILE_APP_NAME | If defined |
| DOMAINFLD_PN_SERVICE_API_KEY | If defined |
Requirements
Required administrative privileges:
DOMAINCMD_DELETE
DOMAINCMD_DELETE deletes the specified domain.
Parameters
Only the DOMAINFLD_DOMAIN attribute can be specified in the domain attribute set input parameter of this command. This attribute is mandatory.
This command returns no result attributes.
Requirements
Required administrative privileges: