Scenario: Administration
Support: full-sdk
The userattributeExecute command executes user–related administrative operations.
Table: userattributeExecute commands (SOAP administration) | Command | Description |
|---|
USERATTRIBUTECMD_CREATE | Creates a new user attribute for a specified user (see USERATTRIBUTECMD_CREATE). |
USERATTRIBUTECMD_VIEW | Displays the values for a specified user attribute (see USERATTRIBUTECMD_VIEW). |
USERATTRIBUTECMD_UPDATE | Updates the specified user attribute (see USERATTRIBUTECMD_UPDATE). |
USERATTRIBUTECMD_DELETE | Deletes the specified user attribute (see USERATTRIBUTECMD_DELETE). |
Parameters
Table: userattributeExecute input parameters | Parameter name | Data type | Description |
|---|
sessionID | String | The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)). |
cmd | UserAttributeCmdIDEnum | The operation to be executed. See Table: userattributeExecute commands (SOAP administration). |
attributeSet | UserAttributeAttributeSet | A set containing zero or more attribute fields. |
Table: userattributeExecute output parameters | Parameter name | Data type | Description |
|---|
| results | UserAttributeResults | 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: userattributeExecute field attributes | Attribute name | Data type | Description |
|---|
| UATTFLD_ATTR_GROUP | String | The attribute group to which the attribute belongs. This is used to distinguish which attributes will be returned in specific circumstances. Up to 255 characters. |
| UATTFLD_CREATE_TIME | DateTime | The date and time the user attribute object was created in the database. |
| UATTFLD_DOMAIN | String | The domain the user record belongs to. Up to 255 characters. |
| UATTFLD_LDAP_DN | String | |
| UATTFLD_MODIFY_TIME | DateTime | The date and time of the last user attribute object update. |
| UATTFLD_NAME | String | The name of the user attribute. Up to 64 characters. |
| UATTFLD_OPTIONS | String | |
| UATTFLD_SEQ_NO | Integer | The sequence number of the attribute. This is used to concatenate attributes into a string for Active Directory data store. |
| UATTFLD_USAGE_QUALIFIER | String | The usage qualifier specifies the type of attribute in use. Up to 64 characters. |
| UATTFLD_USERID | String | The user identifier as provided by the calling application (no specific format is required). Up to 255 characters. |
| UATTFLD_VALUE | String | The value of the user attribute. Up to 255 characters. |
The UATTFLD_OPTIONS attribute specifies whether the attribute is of type SOAP or RADIUS, and whether the attribute value is encrypted or not. These two settings are expressed via the following values:
Table: UATTFLD_OPTIONS values and resulting attribute types | Attribute value | Resulting attribute type |
|---|
| 0 | Unencrypted SOAP attribute |
| 1 | Unencrypted RADIUS attribute |
| 2 | Encrypted SOAP attribute |
| 3 | Encrypted RADIUS attribute |
USERATTRIBUTECMD_CREATE
The following attributes can be specified in the attributeSet input parameter of this command:
Table: USERATTRIBUTECMD_CREATE (Supported input attributes) | Attribute name | Optionality |
|---|
| UATTFLD_ATTR_GROUP | Mandatory |
| UATTFLD_DOMAIN | Mandatory |
| UATTFLD_NAME | Mandatory |
| UATTFLD_OPTIONS | Optional |
| UATTFLD_USAGE_QUALIFIER | Mandatory |
| UATTFLD_USERID | Mandatory |
| UATTFLD_VALUE | Mandatory |
The following attributes will be specified in the results output parameter of this command:
Table: USERATTRIBUTECMD_CREATE (Supported output attributes) | Attribute name | Returned? |
|---|
| UATTFLD_ATTR_GROUP | Always |
| UATTFLD_CREATE_TIME | Always |
| UATTFLD_DOMAIN | Always |
UATTFLD_MODIFY_TIME | Always |
| UATTFLD_NAME | Always |
| UATTFLD_OPTIONS | Optional |
| UATTFLD_SEQ_NO | Always |
| UATTFLD_USAGE_QUALIFIER | Always |
| UATTFLD_USERID | Always |
| UATTFLD_VALUE | Always |
USERATTRIBUTECMD_VIEW
The following attributes can be specified in the attributeSet input parameter of this command:
Table: USERATTRIBUTECMD_VIEW (Supported input attributes) | Attribute name | Optionality |
|---|
| UATTFLD_ATTR_GROUP | Mandatory |
| UATTFLD_DOMAIN | Mandatory |
| UATTFLD_NAME | Optional |
| UATTFLD_OPTIONS | Optional |
| UATTFLD_SEQ_NO | Mandatory |
| UATTFLD_USERID | Mandatory |
The following attributes will be specified in the results output parameter of this command:
Table: USERATTRIBUTECMD_VIEW (Supported output attributes) | Attribute name | Returned? |
|---|
| UATTFLD_ATTR_GROUP | Always |
| UATTFLD_CREATE_TIME | Always |
| UATTFLD_DOMAIN | Always |
| UATTFLD_MODIFY_TIME | Always |
| UATTFLD_NAME | Always |
| UATTFLD_SEQ_NO | Always |
| UATTFLD_USAGE_QUALIFIER | Always |
| UATTFLD_USERID | Always |
| UATTFLD_VALUE | Always |
USERATTRIBUTECMD_UPDATE
The following attributes can be specified in the attributeSet input parameter of this command:
Table: USETATTRIBUTECMD_UPDATE (Supported input attributes) | Attribute name | Optionality |
|---|
| UATTFLD_ATTR_GROUP | Mandatory |
| UATTFLD_DOMAINuserSendNotificationEx | Mandatory |
| UATTFLD_NAME | Optional |
| UATTFLD_OPTIONS | Optional |
| UATTFLD_SEQ_NO | Mandatory |
| UATTFLD_USAGE_QUALIFIER | Optional |
| UATTFLD_USERID | Mandatory |
| UATTFLD_VALUE | Optional |
The following attributes will be specified in the results output parameter of this command:
Table: USERATTRIBUTECMD_UPDATE (Supported output attributes) | Attribute name | Returned? |
|---|
| UATTFLD_ATTR_GROUP | Always |
| UATTFLD_CREATE_TIME | Always |
| UATTFLD_DOMAIN | Always |
| UATTFLD_MODIFY_TIME | Always |
| UATTFLD_NAME | Always |
| UATTFLD_OPTIONS | Optional |
| UATTFLD_SEQ_NO | Always |
| UATTFLD_USAGE_QUALIFIER | Always |
| UATTFLD_USERID | Always |
| UATTFLD_VALUE | Always |
USERATTRIBUTECMD_DELETE
The following attributes can be specified in the attributeSet input parameter of this command:
Table: USERATTRIBUTECMD_DELETE (Supported input attributes) | Attribute name | Optionality |
|---|
| UATTFLD_ATTR_GROUP | Mandatory |
| UATTFLD_DOMAIN | Mandatory |
| UATTFLD_NAME | Optional |
| UATTFLD_OPTIONS | Optional |
| UATTFLD_SEQ_NO | Mandatory |
| UATTFLD_USAGE_QUALIFIER | Optional |
| UATTFLD_USERID | Mandatory |
| UATTFLD_VALUE | Optional |
This command returns no result attributes.