Skip to main content

Definitions

AgentCode

See explanation of agent codes .

Attributes

A dictionary object containing dictionaries for each attribute that is specified when creating or updating users. Each individual attribute dictionary will have 5 keys:

  • "NAME" - String value for the name of the attribute. Also stored as the key to the attribute dictionary

  • "ACTION" - String value for the action that should be performed for the attribute.During the create user operation the valid values are: "VALUE", "IGNORE", "COPY" or"REPLACE".During the update user operation the only valid values are: "VALUE" or "IGNORE".

  • "SEQUENCE" - Integer value for when the attribute should be set during the create user operation.The value "-1" is specified if it should be set when creating the object or the value "0" is specified if it should be set after creating the object.

  • "VALUE" - The value(s) that should be set.Either a single string value may be specified or a list of string values if the attribute can be multi-valued.

  • "GROUP" - Integer value for the attribute group.Default value is 0.

Remarks:

Depending on the value of the "ACTION" field different things should be done for the attribute being set.They are:

  • "VALUE" - The attribute should be set to the specified value.

  • "IGNORE" - No action should be taken on the attribute.

  • "COPY" - The value should be copied from the template account.

  • "REPLACE" - The value should be copied from the template account, replacing the template user's id with the account id of the user being created.

AttrsDict

A dictionary object containing attributes and their value(s).

For each entry in the dictionary the key is the attribute's name, while the value is either a singular string value or a list of string values if the attribute is multi-valued.

For example:

attrsDict = {'attr1': 'value1', 'attr2': ['value2-1','value2-2']}

Cinfo

A dictionary object containing the inputs for the operations. It's contents are:

  • acctid - [String] ID of the account that will be used to identify it in operations

  • address - [String] The address string for the target

  • adminid - [String] The administrator account for authenticating to the target

  • adminpw - [String] The password for the administrator account

  • agentinput - [Dictionary] Dictionary object of dictionary objects containing connection information

  • attributes - [Dictionary] Dictionary of dictionary objects containing attribute information. See the Attributes definition for details.

  • challenge - [String] The challenge code for performing challenge response

  • command - [String] The command to be run during the run command operation

  • commandFile - [String] The filename to store command output in during run command operation

  • customop - [String] The name of the custom operation which should be run during the custom operation

  • fullname - [String] The full name of the user

  • groupid - [String] The group ID to be operated on for group operations

  • groupname - [String] The description of the group

  • listattributes - [List] List of string values for attributes that should be listed

  • modeluid - [String] The template account that should be used for creating new users

  • modeluri - [String] The address for the template network resource

  • newpw - [String] The new password that should be set for password operations

  • objchildid - [String] The child object ID in managed object relation operations

  • objchildtype - [String] The child object type in managed object relation operations

  • objectid - [String] The object ID in managed object operations

  • objecttype - [String] The object type in managed object operations

  • objreltype - [String] The relationship type in managed object relation operations

  • oldpw - [String] The old password to be check in verify operations

  • operation - [String] The operation that is being run

  • opinput - [Dictionary] Dictionary object of dictionary objects containing operation information

  • owner - [String] The ID of the owner object

  • ownertype - [String] The type of the owner object

  • position - [String] Indicates when a subscriber should be restarted during subscriber update. Possible values are "pre" for before the update, or "post" if it should be done after.

  • resourceaddress - [String] Address for the network resource in network resource operations

  • resourcetype - [String] Type of the network resource in network resource operations

  • response - [String] The response code for performing challenge response

  • restart - [Boolean] Flag value indicating if a subscriber should be restarted during update resource update

  • settings - [Dictionary] Dictionary object containing the additional address attribute and their values that are defined in the address attributes operations

  • shortid - [String] The ID of the account that is human readable

  • sysid - [String] The target's system ID used for authentication

  • syspw - [String] The password for the system ID

  • userid - [String] The profile ID of the user

GroupsDict

A dictionary object containing the groups an account is a member of.

For each entry in the dictionary the key is the group's stable id, while the value is a dictionary object with 2 keys:

  • GAttrLongID - The long id of the group

  • GAttrSecurityDomain - The security domain of the group

An example is

groupsDict = {'stableid': {GAttrLongID: 'group1', GAttrSecurityDomain: 'domain1'}, 'stableid2': {GAttrLongID: 'group2'}}

OwnersDict

A dictionary object containing the owners of a group

For each entry in the dictionary the key is the owner's stable id, while the value is a dictionary object with 3 keys:

  • GAttrLongID - The long id of the owner

  • GAttrSecurityDomain - The security domain of the owner

  • KeyType - The type of the owner. Valid values are: 'account' or 'group'

An example is

ownersDict = {'user1': {GAttrLongID: 'user1', GAttrSecurityDomain: 'domain1', KeyType: 'account'}}

MembersDict

A dictionary object containing the members of a group

For each entry in the dictionary the key is the member's stable id, while the value is a dictionary object with 3 keys:

  • GAttrLongID - The long id of the member

  • GAttrSecurityDomain - The security domain of the member

  • KeyType - The type of the member. Valid values are: 'account' or 'group'

An example is:

membersDict = {'user1': {GAttrLongID: 'user1', GAttrSecurityDomain: 'domain1', KeyType: 'account'}}
In this section: