- 18 Dec 2024
- 2 Minutes à lire
- SombreLumière
- PDF
orgunitExecute (Command)
- Mis à jour le 18 Dec 2024
- 2 Minutes à lire
- SombreLumière
- PDF
The orgunitExecute command supports organizational unit–related administrative operations.
Command | Description |
---|---|
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
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 | OrgunitCmdIDEnum | Required. The operation to be executed. See Table: orgunitExecute commands (SOAP administration). |
attributeSet | OrgunitAttributeSet | Required. A set containing zero or more attribute fields. |
The following field attributes are available for the operations of this command:
Attribute name | Data type | Description |
---|---|---|
ORGUNITFLD_CREATE_TIME | DateTime | The date and time the data record was created. |
ORGUNITFLD_DESCRIPTION | String | Organizational unit description. Up to 1024 characters. |
ORGUNITFLD_DOMAIN | String | The domain this organizational unit belongs to. Up to 255 characters. |
ORGUNITFLD_MODIFY_TIME | DateTime | The date and time the data record was last modified. |
ORGUNITFLD_ORGANIZATIONAL_UNIT | String | 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_UNIT | String | The parent unit this organizational unit belongs to. Up to 255 characters. |
ORGUNITFLD_SEARCH_DOWN_OU_PATH | Boolean | Determines 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:
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:
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:
Attribute name | Optionality |
---|---|
ORGUNITFLD_DOMAIN | Mandatory |
ORGUNITFLD_ORGANIZATIONAL_UNIT | Mandatory |
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:
Attribute name | Optionality |
---|---|
ORGUNITFLD_DESCRIPTION | Optional |
ORGUNITFLD_DOMAIN | Mandatory |
ORGUNITFLD_ORGANIZATIONAL_UNIT | Mandatory |
The following attributes will be specified in the results output parameter of this command:
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:
Attribute name | Optionality |
---|---|
ORGUNITFLD_DOMAIN | Mandatory |
ORGUNITFLD_ORGANIZATIONAL_UNIT | Mandatory |
The following attributes will be specified in the results output parameter of this command:
Requirements
Required administrative privileges:
- View Organizational Unit