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

orgunitExecute (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 orgunitExecute command supports organizational unit–related administrative operations.

  Table:  orgunitExecute commands (SOAP administration)
CommandDescription
ORGUNITCMD_CREATE

Creates an organizational unit entry in the organizational structure (see  ORGUNITCMD_CREATE).

ORGUNITCMD_DELETE

Deletes the specified organizational unit (see  ORGUNITCMD_DELETE).

ORGUNITCMD_UPDATE

Updates the specified organizational unit (see  ORGUNITCMD_UPDATE).

ORGUNITCMD_VIEW

Displays the settings for the specified organizational unit (see  ORGUNITCMD_VIEW).

Parameters

  Table:  orgunitExecute 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)).

cmdOrgunitCmdIDEnumRequired. The operation to be executed. See Table: orgunitExecute commands (SOAP administration).
attributeSetOrgunitAttributeSetRequired. A set containing zero or more attribute fields.
  Table:  orgunitExecute output parameters
Parameter nameData typeDescription

results

OrgunitResults

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:  orgunitExecute field attributes
Attribute nameData typeDescription
ORGUNITFLD_CREATE_TIMEDateTime

The date and time the data record was created.

ORGUNITFLD_DESCRIPTION

String

Organizational unit description.

Up to 1024 characters.

ORGUNITFLD_DOMAINString

The domain this organizational unit belongs to.

Up to 255 characters.

ORGUNITFLD_MODIFY_TIMEDateTime

The date and time the data record was last modified.

ORGUNITFLD_ORGANIZATIONAL_UNITString

The name of the organizational unit. Trailing and leading spaces are removed when a new organizational unit is created.

Up to 255 characters.

ORGUNITFLD_PARENT_ORGANIZATIONAL_UNITString

The parent unit this organizational unit belongs to.

Up to 255 characters.

ORGUNITFLD_SEARCH_DOWN_OU_PATHBooleanDetermines whether to search within child organizational units when performing a query (see  orgunitQuery (Command)).

ORGUNITCMD_CREATE

ORGUNITCMD_CREATE creates an organizational unit entry in the organizational structure.

Parameters

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: ORGUNITCMD_CREATE (Supported input attributes)
Attribute nameOptionality
ORGUNITFLD_DESCRIPTIONOptional
ORGUNITFLD_DOMAINMandatory
ORGUNITFLD_ORGANIZATIONAL_UNITMandatory
ORGUNITFLD_PARENT_ORGANIZATIONAL_UNITOptional

Any trailing and leading spaces are removed from ORGUNITFLD_ORGANIZATIONAL_UNIT.

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

  Table: ORGUNITCMD_CREATE (Supported output attributes)
Attribute nameReturned
ORGUNITFLD_CREATE_TIMEAlways
ORGUNITFLD_DESCRIPTIONIf defined
ORGUNITFLD_DOMAINAlways
ORGUNITFLD_MODIFY_TIMEAlways
ORGUNITFLD_ORGANIZATIONAL_UNITAlways
ORGUNITFLD_PARENT_ORGANIZATIONAL_UNITIf defined

Requirements

Required administrative privileges:

  • Create Organizational Unit
  • View Organizational Unit

ORGUNITCMD_DELETE

ORGUNITCMD_DELETE deletes a specified organizational unit.

Parameters

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: ORGUNITCMD_DELETE (Supported input attributes)
Attribute nameOptionality
ORGUNITFLD_DOMAINMandatory
ORGUNITFLD_ORGANIZATIONAL_UNITMandatory

This command returns no result attributes.

Requirements

Required administrative privileges:

  • Delete Organizational Unit
  • View Organizational Unit

ORGUNITCMD_UPDATE

ORGUNITCMD_UPDATE updates a specified organizational unit.

Parameters

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: ORGUNITCMD_UPDATE (Supported input attributes)
Attribute nameOptionality
ORGUNITFLD_DESCRIPTIONOptional
ORGUNITFLD_DOMAINMandatory
ORGUNITFLD_ORGANIZATIONAL_UNITMandatory

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

  Table: ORGUNITCMD_UPDATE (Supported output attributes)
Attribute nameReturned
ORGUNITFLD_CREATE_TIMEAlways
ORGUNITFLD_DESCRIPTIONIf defined
ORGUNITFLD_DOMAINAlways
ORGUNITFLD_MODIFY_TIMEAlways
ORGUNITFLD_ORGANIZATIONAL_UNITAlways
ORGUNITFLD_PARENT_ORGANIZATIONAL_UNITIf defined

Requirements

Required administrative privileges:

  • Update Organizational Unit
  • View Organizational Unit

ORGUNITCMD_VIEW

ORGUNITCMD_VIEW displays the settings for a specified organizational unit.

Parameters

The following attributes can be specified in the attributeSet input parameter of this command:

  Table: ORGUNITCMD_VIEW (Supported input attributes)
Attribute nameOptionality
ORGUNITFLD_DOMAINMandatory
ORGUNITFLD_ORGANIZATIONAL_UNITMandatory

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

  Table: ORGUNITCMD_VIEW (Supported output attributes)
Attribute nameReturned
ORGUNITFLD_CREATE_TIMEAlways
ORGUNITFLD_DESCRIPTIONIf defined
ORGUNITFLD_DOMAINAlways
ORGUNITFLD_MODIFY_TIMEAlways
ORGUNITFLD_ORGANIZATIONAL_UNITAlways
ORGUNITFLD_PARENT_ORGANIZATIONAL_UNITIf defined

Requirements

Required administrative privileges:

  • View Organizational Unit

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