Name

Type

Short Description

account_id

int

ID of Account.

[subscription_id]

int

ID of Subscription, which provides the Additional Staff Members Resource Type. This is an optional parameter. There are the following use cases:

• The parameter is specified. In this case POA uses the Additional Staff Members Resource Type from the Subscription specified.
• The parameter is not specified. In this case POA looks at all Account's Subscriptions and searches the least loaded Additional Staff Members Resource.

Note: If an Account has no Staff Members yet, then the Staff Member creation will succeed in any case.

[user_id]

int

ID of Staff Member. This is an optional parameter. If parameter is not specified, POA generates user_id itself.

[login]

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 POA 2.9, this parameter is deprecated. The external_identity parameter should be used instead.

[external_identity]

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.

• system_name

string

External System name.

• identity_key

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.

[auth]

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 POA.

• login

string

Login of Staff Member.

• password

string

Password of Staff Member.

• [check_password]

boolean

It defines whether to check the quality of the password, against the password quality level defined in POA.

[person]

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 POA.

• [title]

string

Title of the person represented by the Staff Member. For example: Mr. or Mrs., etc.

• first_name

string

The first name of the person represented by the Staff Member.

• [middle_name]

string

The middle name of the person represented by the Staff Member.

• last_name

string

The last name of the person represented by the Staff Member.

• [company_name]

string

The name of the company represented by the Staff Member.

[address]

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 POA.

• street_name

string

Name of the street.

• [house_num]

string

The number of the house.

• [address2]

string

Second address.

• zipcode

string

Postal code.

• city

string

Name of the city.

• country

string

This is the code of the country represented by two lowercased letters, like the us, uk, etc.

• state

string

Name of the state/province.

[phone]

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 POA.

• country_code

string

Country code part of the phone number.

• area_code

string

Area code part of the phone number.

• phone_num

string

The phone number itself.

• ext_num

string

Extension to the phone number, if present.

[fax]

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 POA.

• country_code

string

Country code part of the fax number.

• area_code

string

Area code part of the fax number.

• phone_num

string

The fax number itself.

• ext_num

string

Extension to the fax number, if present.

[email]

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 POA.

[roles]

array of string

Names of Roles. If the parameter is specified, POA 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.

Name

Type

Short Description

user_id

int

Staff Member ID