userattributeExecute (Command)
  • 17 Dec 2024
  • 2 Minutes à lire
  • Sombre
    Lumière
  • PDF

userattributeExecute (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 userattributeExecute command executes user–related administrative operations.

 
 Table:  userattributeExecute commands (SOAP administration)
CommandDescription

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 nameData typeDescription

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 nameData typeDescription
resultsUserAttributeResults

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 nameData typeDescription
UATTFLD_ATTR_GROUPString

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_TIMEDateTimeThe date and time the user attribute object was created in the database.
UATTFLD_DOMAINString

The domain the user record belongs to.

Up to 255 characters.

UATTFLD_LDAP_DNString 
UATTFLD_MODIFY_TIMEDateTimeThe date and time of the last user attribute object update.
UATTFLD_NAMEString

The name of the user attribute.

Up to 64 characters.

UATTFLD_OPTIONSString 
UATTFLD_SEQ_NOIntegerThe sequence number of the attribute. This is used to concatenate attributes into a string for Active Directory data store.
UATTFLD_USAGE_QUALIFIERString

The usage qualifier specifies the type of attribute in use.

Up to 64 characters.

UATTFLD_USERIDString

The user identifier as provided by the calling application (no specific format is required).

Up to 255 characters.

UATTFLD_VALUEString

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 valueResulting attribute type
0Unencrypted SOAP attribute
1Unencrypted RADIUS attribute
2Encrypted SOAP attribute
3Encrypted 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 nameOptionality
UATTFLD_ATTR_GROUP

Mandatory

UATTFLD_DOMAIN

Mandatory

UATTFLD_NAME

Mandatory

UATTFLD_OPTIONSOptional
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 nameReturned?
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 nameOptionality
UATTFLD_ATTR_GROUP

Mandatory

UATTFLD_DOMAIN

Mandatory

UATTFLD_NAMEOptional
UATTFLD_OPTIONSOptional
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 nameReturned?
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 nameOptionality
UATTFLD_ATTR_GROUP

Mandatory

UATTFLD_DOMAINuserSendNotificationEx

Mandatory

UATTFLD_NAME

Optional

UATTFLD_OPTIONSOptional
UATTFLD_SEQ_NOMandatory
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 nameReturned?
UATTFLD_ATTR_GROUP

Always

UATTFLD_CREATE_TIME

Always

UATTFLD_DOMAIN

Always

UATTFLD_MODIFY_TIME

Always

UATTFLD_NAME

Always

UATTFLD_OPTIONSOptional
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 nameOptionality
UATTFLD_ATTR_GROUPMandatory
UATTFLD_DOMAINMandatory
UATTFLD_NAMEOptional
UATTFLD_OPTIONSOptional
UATTFLD_SEQ_NOMandatory
UATTFLD_USAGE_QUALIFIEROptional
UATTFLD_USERIDMandatory
UATTFLD_VALUEOptional

This command returns no result attributes.


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