domainExecute (Command)
  • 18 Dec 2024
  • 2 Minutes à lire
  • Sombre
    Lumière
  • PDF

domainExecute (Command)

  • Sombre
    Lumière
  • PDF

The content is currently unavailable in French. You are viewing the default English version.
Résumé de l’article

The domainExecute command executes domain–related administrative operations.

  Table:  domainExecute commands (SOAP administration)
CommandDescription
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_VIEWReturns the settings for the specified domain (see  DOMAINCMD_VIEW).

Parameters

  Table:  domainExecute input parameters
Parameter nameData typeDescription
sessionIDString

Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see  logon (Command)).

cmdDomainCmdIDEnumRequired. The operation to be executed. See Table: domainExecute commands (SOAP administration).
attributeSetDomainAttributeSetRequired. A set containing zero or more attribute fields.
  Table:  domainExecute output parameters
Parameter nameData typeDescription
resultsDomainResultsRequired. 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 nameData typeDescription
DOMAINFLD_CREATE_TIMEDateTime

The date and time the data record was created.

DOMAINFLD_DESCRIPTIONStringUp to 1024 characters.
DOMAINFLD_DOMAINString

The domain name. Trailing and leading spaces are removed when a new domain is created.

Up to 255 characters.

DOMAINFLD_DOMAIN_ALT_SUFFIXString

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_MASTERDOMAINBooleanDetermines whether the specified domain is the master domain.
DOMAINFLD_MODIFY_TIMEDateTime

The date and time the data record was last modified.

DOMAINFLD_PN_DP_GATEWAY_IDString

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_NAMEString

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_KEYString

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 nameOptionality
DOMAINFLD_DESCRIPTIONOptional
DOMAINFLD_DOMAINMandatory
DOMAINFLD_DOMAIN_ALT_SUFFIXOptional
DOMAINFLD_PN_DP_GATEWAY_IDOptional
DOMAINFLD_PN_MOBILE_APP_NAMEOptional
DOMAINFLD_PN_SERVICE_API_KEYOptional

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 nameReturned
DOMAINFLD_CREATE_TIMEAlways
DOMAINFLD_DESCRIPTIONIf defined
DOMAINFLD_DOMAINAlways
DOMAINFLD_DOMAIN_ALT_SUFFIXIf defined
DOMAINFLD_MASTERDOMAINAlways
DOMAINFLD_MODIFY_TIMEAlways
DOMAINFLD_PN_DP_GATEWAY_IDIf defined
DOMAINFLD_PN_MOBILE_APP_NAMEIf defined
DOMAINFLD_PN_SERVICE_API_KEYIf defined

Requirements

Required administrative privileges:

  • Create Domain

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 nameReturned
DOMAINFLD_CREATE_TIMEAlways
DOMAINFLD_DESCRIPTIONIf defined
DOMAINFLD_DOMAINAlways
DOMAINFLD_DOMAIN_ALT_SUFFIXIf defined
DOMAINFLD_MASTERDOMAINAlways
DOMAINFLD_MODIFY_TIMEAlways
DOMAINFLD_PN_DP_GATEWAY_IDIf defined
DOMAINFLD_PN_MOBILE_APP_NAMEIf defined
DOMAINFLD_PN_SERVICE_API_KEYIf defined

Requirements

Required administrative privileges:

  • View Domain

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 nameOptionality
DOMAINFLD_DESCRIPTIONOptional
DOMAINFLD_DOMAINMandatory
DOMAINFLD_DOMAIN_ALT_SUFFIXOptional
DOMAINFLD_PN_DP_GATEWAY_IDOptional
DOMAINFLD_PN_MOBILE_APP_NAMEOptional
DOMAINFLD_PN_SERVICE_API_KEYOptional

The following attributes will be specified in the results output parameter of this command:

  Table: DOMAINCMD_UPDATE (Supported output attributes)
Attribute nameReturned
DOMAINFLD_CREATE_TIMEAlways
DOMAINFLD_DESCRIPTIONIf defined
DOMAINFLD_DOMAINAlways
DOMAINFLD_DOMAIN_ALT_SUFFIXIf defined
DOMAINFLD_MASTERDOMAINAlways
DOMAINFLD_MODIFY_TIMEAlways
DOMAINFLD_PN_DP_GATEWAY_IDIf defined
DOMAINFLD_PN_MOBILE_APP_NAMEIf defined
DOMAINFLD_PN_SERVICE_API_KEYIf defined

Requirements

Required administrative privileges:

  • Update Domain

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:

  • Delete Domain

Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, facilitant la découverte de connaissances grâce à l’intelligence conversationnelle