pem.addAccountMember
This method is supported by Operations starting from version 2.3
This method creates a Staff Member in Operations.
There are the following use cases:
- Operations stores Account's and Staff Member's properties in the system database, and Operations authenticates Staff Member by itself. In this case the
auth
,person
,address
,phone
,fax
, andemail
parameters are mandatory. Theexternal_identity
parameter should not be specified. - Account's and Staff Member's properties are stored in the External System, and External System is used for Staff Members authentication purposes. In this case the
external_identity
parameter is mandatory. Theauth
,person
,address
,phone
,fax
, andemail
parameters should not be specified.
The method has the following input parameters:
Name |
Type |
Short Description |
---|---|---|
|
int |
ID of Account. |
|
int |
ID of Subscription, which provides the Additional Staff Members Resource Type. This is an optional parameter. There are the following use cases:
Note: If an Account has no Staff Members yet, then the Staff Member creation will succeed in any case. Important: Starting from Operations 5.5 this parameter is ignored. |
|
int |
ID of Staff Member. This is an optional parameter. If parameter is not specified, Operations generates |
|
string |
Key of Staff Member in the External System, which is associated with Account (an external account is required). This parameter is optional. It is used if Account's and Staff Member's properties are stored in the External System, and External System is used for Staff Member authentication purposes. Important: Since Operations 2.9, this parameter is deprecated. The |
|
struct |
Identity of Staff Member in the External System. This is an optional parameter. It should be used if Staff Member belongs to the External System. |
|
string |
External System name. |
|
string |
External key that is passed to the External System for identification of the Staff Member. The external key is static unique key in the scope of specified External System. The format of the key depends on External System plug-in implementation and External System configuration. To obtain information about this parameter, refer to the plug-in documentation. |
|
struct |
It contains information, which is used for authenticating the Staff Member. This is an optional parameter. It should be used, if Staff Member belongs to Operations. |
|
string |
Login of Staff Member. |
|
string |
Password of Staff Member. |
|
boolean |
It defines whether to check the quality of the password, against the password quality level defined in Operations. |
|
struct |
It contains general information about the person represented by the Staff Member. This is an optional parameter. It should be used, if Staff Member belongs to Operations. |
|
string |
Title of the person represented by the Staff Member. For example: Mr. or Mrs., etc. |
|
string |
The first name of the person represented by the Staff Member. |
|
string |
The middle name of the person represented by the Staff Member. |
|
string |
The last name of the person represented by the Staff Member. |
|
string |
The name of the company represented by the Staff Member. |
|
struct |
It contains address information for the person represented by the Staff Member. This is an optional parameter. It should be used, if Staff Member belongs to Operations. |
|
string |
Name of the street. |
|
string |
The number of the house. |
|
string |
Second address. |
|
string |
Postal code. |
|
string |
Name of the city. |
|
string |
This is the code of the country represented by two lowercased letters, like the us, uk, etc. |
|
string |
Name of the state/province. |
|
struct |
It contains phone information for the person represented by the Staff Member. This is an optional parameter. It should be used, if Staff Member belongs to Operations. |
|
string |
Country code part of the phone number. |
|
string |
Area code part of the phone number. |
|
string |
The phone number itself. |
|
string |
Extension to the phone number, if present. |
|
struct |
It contains fax information for the person represented by the Staff Member. This is an optional parameter. It should be used, if Staff Member belongs to Operations. |
|
string |
Country code part of the fax number. |
|
string |
Area code part of the fax number. |
|
string |
The fax number itself. |
|
string |
Extension to the fax number, if present. |
|
string |
The e-mail address of the person represented by the Staff Member. This is an optional parameter. It should be used, if Staff Member belongs to Operations. |
|
array of string |
Names of Roles. If the parameter is specified, Operations grants the Roles to Staff Member. Note: The first Account's Staff Member automatically obtains the Account Administrator Role, the subsequent Account's Staff Members automatically obtain the Staff member defaults Role. |
The method has the following output parameters:
Name |
Type |
Short Description |
---|---|---|
|
int |
Staff Member ID |
For XML-RPC sample of using this method see pem.addAccountMember Sample section in XML-RPC Samples appendix.
See also:
pem.addAccount method.